feat(v2): add support for sync to npm2yarn tabs

facebook · Nov 6, 2020 · cbf2139 · cbf2139
1 parent 5aca1d7
commit cbf2139
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 8 deletions.
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/README.md b/packages/docusaurus-remark-plugin-npm2yarn/README.md
@@ -34,15 +34,15 @@ module.exports = {
       {
         docs: {
           // ...
-          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
+          remarkPlugins: [[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}]],
         },
         blog: {
           // ...
-          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
+          remarkPlugins: [[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}]],
         },
         pages: {
           // ...
-          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
+          remarkPlugins: [[require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}]],
         },
         // ...
       },
@@ -51,3 +51,9 @@ module.exports = {
   // ...
 };
 ```
+
+## Options
+
+| Property | Type      | Default | Description                                                                                                               |
+|----------|-----------|---------|---------------------------------------------------------------------------------------------------------------------------|
+| `sync`   | `boolean` | `false` | Syncing tab choices (yarn and npm). See https://v2.docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |
diff --git a/packages/docusaurus-remark-plugin-npm2yarn/src/index.js b/packages/docusaurus-remark-plugin-npm2yarn/src/index.js
@@ -10,14 +10,15 @@ const npmToYarn = require('npm-to-yarn');
 // E.g. global install: 'npm i' -> 'yarn'
 const convertNpmToYarn = (npmCode) => npmToYarn(npmCode, 'yarn');
 
-const transformNode = (node) => {
+const transformNode = (node, isSync) => {
+  const groupIdProp = isSync ? 'groupId="npm2yarn" ' : '';
   const npmCode = node.value;
   const yarnCode = convertNpmToYarn(node.value);
   return [
     {
       type: 'jsx',
       value:
-        `<Tabs defaultValue="npm" ` +
+        `<Tabs defaultValue="npm" ${groupIdProp}` +
         `values={[
     { label: 'npm', value: 'npm', },
     { label: 'Yarn', value: 'yarn', },
@@ -53,12 +54,13 @@ const nodeForImport = {
     "import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';",
 };
 
-module.exports = () => {
+module.exports = (options = {}) => {
+  const {sync = false} = options;
   let transformed = false;
   const transformer = (node) => {
     if (matchNode(node)) {
       transformed = true;
-      return transformNode(node);
+      return transformNode(node, sync);
     }
     if (Array.isArray(node.children)) {
       let index = 0;

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -194,7 +194,9 @@ module.exports = {
             'https://github.com/facebook/docusaurus/edit/master/website/',
           showLastUpdateAuthor: true,
           showLastUpdateTime: true,
-          remarkPlugins: [require('@docusaurus/remark-plugin-npm2yarn')],
+          remarkPlugins: [
+            [require('@docusaurus/remark-plugin-npm2yarn'), {sync: true}],
+          ],
           disableVersioning: isVersioningDisabled,
           lastVersion: 'current',
           onlyIncludeVersions: