diff --git a/packages/docusaurus-remark-plugin-npm2yarn/README.md b/packages/docusaurus-remark-plugin-npm2yarn/README.md index e0a08aa30f..eee65efa04 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/README.md +++ b/packages/docusaurus-remark-plugin-npm2yarn/README.md @@ -63,7 +63,7 @@ module.exports = { | Property | Type | Default | Description | | --- | --- | --- | --- | | `sync` | `boolean` | `false` | Syncing tab choices (Yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. | -| `converters` | `array` | `'yarn'`, `'pnpm'`, `'bun'` | The list of converters to use. The order of the converters is important, as the first converter will be used as the default choice. | +| `converters` | `array` | `['yarn', 'pnpm', 'bun']` | The list of converters to use. The order of the converters is important, as the first converter will be used as the default choice. | ## Custom converters diff --git a/packages/docusaurus-remark-plugin-npm2yarn/example.png b/packages/docusaurus-remark-plugin-npm2yarn/example.png index a007c1ddd7..9b1fcf38bb 100644 Binary files a/packages/docusaurus-remark-plugin-npm2yarn/example.png and b/packages/docusaurus-remark-plugin-npm2yarn/example.png differ diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap index 797b89fb97..8ddbe26ea0 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap +++ b/packages/docusaurus-remark-plugin-npm2yarn/src/__tests__/__snapshots__/index.test.ts.snap @@ -24,6 +24,12 @@ import TabItem from '@theme/TabItem' $ pnpm add --global docusaurus \`\`\` + + + \`\`\`bash + $ bun add --global docusaurus + \`\`\` +
@@ -45,6 +51,12 @@ import TabItem from '@theme/TabItem' pnpm install \`\`\` + + + \`\`\`bash + bun install + \`\`\` +
@@ -72,6 +84,12 @@ echo "no npm2yarn here" yarn add @docusaurus/core \`\`\` + + + \`\`\`bash + yarn add @docusaurus/core + \`\`\` + " `; @@ -99,6 +117,12 @@ import TabItem from '@theme/TabItem'; $ pnpm add --global docusaurus \`\`\` + + + \`\`\`bash + $ bun add --global docusaurus + \`\`\` + " `; @@ -122,6 +146,12 @@ exports[`npm2yarn plugin does not re-import tabs components when already importe $ pnpm add --global docusaurus \`\`\` + + + \`\`\`bash + $ bun add --global docusaurus + \`\`\` + import Tabs from '@theme/Tabs'; @@ -263,6 +293,12 @@ import TabItem from '@theme/TabItem' $ pnpm add --global docusaurus \`\`\` + + + \`\`\`bash + $ bun add --global docusaurus + \`\`\` + " `; @@ -293,6 +329,12 @@ A plugin is usually a npm package, so you install them like other npm packages u pnpm add docusaurus-plugin-name \`\`\` + + + \`\`\`bash + bun add docusaurus-plugin-name + \`\`\` + " `; @@ -319,6 +361,12 @@ import TabItem from '@theme/TabItem' pnpm run xxx --arg \`\`\` + + + \`\`\`bash + bun run xxx --arg + \`\`\` + @@ -339,6 +387,12 @@ import TabItem from '@theme/TabItem' pnpm add package \`\`\` + + + \`\`\`bash + bun add package + \`\`\` + @@ -359,6 +413,12 @@ import TabItem from '@theme/TabItem' pnpm remove package-name \`\`\` + + + \`\`\`bash + bun remove package-name + \`\`\` + @@ -382,6 +442,13 @@ import TabItem from '@theme/TabItem' pnpm create docusaurus@latest my-website classic \`\`\` + + + \`\`\`bash + bunx create-docusaurus + bunx create-docusaurus@latest my-website classic + \`\`\` + " `; @@ -412,6 +479,12 @@ Hey pnpm add test \`\`\` + + + \`\`\`bash + bun add test + \`\`\` + " `; @@ -442,6 +515,12 @@ A plugin is usually a npm package, so you install them like other npm packages u pnpm add docusaurus-plugin-name \`\`\` + + + \`\`\`bash + bun add docusaurus-plugin-name + \`\`\` + " `; diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts b/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts index cd1006dba4..c1c8863f8e 100644 --- a/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts +++ b/packages/docusaurus-remark-plugin-npm2yarn/src/index.ts @@ -172,7 +172,7 @@ function createImportNode() { } const plugin: Plugin<[PluginOptions?]> = (options = {}): Transformer => { - const {sync = false, converters = ['yarn', 'pnpm']} = options; + const {sync = false, converters = ['yarn', 'pnpm', 'bun']} = options; return async (root) => { const {visit} = await import('unist-util-visit');