Skip to content

Install npm2yarn package#2129

Merged
bgravenorst merged 5 commits intomainfrom
install-npm2yarn
Jun 30, 2025
Merged

Install npm2yarn package#2129
bgravenorst merged 5 commits intomainfrom
install-npm2yarn

Conversation

@bgravenorst
Copy link
Contributor

Description

Adds the npm2yarn plugin.

Preview

Checklist

Complete this checklist before merging your PR:

  • If this PR contains a major change to the documentation content, I have added an entry to the top of the "What's new?" page.
  • The proposed changes have been reviewed and approved by a member of the documentation team.

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Copilot AI review requested due to automatic review settings June 30, 2025 00:16
@bgravenorst bgravenorst requested review from a team as code owners June 30, 2025 00:16
@vercel
Copy link

vercel bot commented Jun 30, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
metamask-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 30, 2025 8:20pm

@socket-security
Copy link

socket-security bot commented Jun 30, 2025

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Added@​docusaurus/​remark-plugin-npm2yarn@​3.8.1981009899100

View full report

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Adds the npm2yarn remark plugin to automatically generate Yarn equivalents of npm commands across the docs.

  • Adds @docusaurus/remark-plugin-npm2yarn to dependencies.
  • Enables the plugin in each docs instance in docusaurus.config.js.
  • Simplifies the Delegation Toolkit install guide by replacing manual Tabs UI with a single code fence annotated for npm2yarn.

Reviewed Changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
package.json Add @docusaurus/remark-plugin-npm2yarn dependency
docusaurus.config.js Import and configure remark-plugin-npm2yarn in docs
delegation-toolkit/get-started/install.md Replace Tabs-based install instructions with fenced block
Comments suppressed due to low confidence (2)

delegation-toolkit/get-started/install.md:7

  • Remove the now-unused imports Tabs and TabItem since the tabbed UI was removed, and delete or separate import statements according to project style.
import Tabs from "@theme/Tabs"; import TabItem from "@theme/TabItem";

docusaurus.config.js:76

  • The remarkPlugins setting for npm2yarn is duplicated across multiple docs instances; consider extracting it into a shared default or applying it globally to reduce repetition.
          remarkPlugins: [npm2yarnPlugin],

Signed-off-by: bgravenorst <byron.gravenorst@consensys.net>
Copy link
Member

@AyushBherwani1998 AyushBherwani1998 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

There are other instances where we manually manage. Maybe another PR to clean up is fine. https://docs.metamask.io/sdk/connect/javascript/#1-install-the-sdk

@bgravenorst bgravenorst merged commit 0780c5c into main Jun 30, 2025
15 checks passed
@bgravenorst bgravenorst deleted the install-npm2yarn branch June 30, 2025 20:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants