@docusaurus/remark-plugin-npm2yarn 2.0.0-beta.fbdeefcac → 2.0.0-rc.1

package/README.md

@@ -62,4 +62,4 @@ 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. |
+| `sync` | `boolean` | `false` | Syncing tab choices (Yarn and npm). See https://docusaurus.io/docs/markdown-features/#syncing-tab-choices for details. |

package/lib/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+import type { Plugin } from 'unified';
+declare type PluginOptions = {
+    sync?: boolean;
+};
+declare const plugin: Plugin<[PluginOptions?]>;
+export = plugin;
+//# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAKH,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAC;AAGpC,aAAK,aAAa,GAAG;IACnB,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB,CAAC;AA8CF,QAAA,MAAM,MAAM,EAAE,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,CA4BpC,CAAC;AAIF,SAAS,MAAM,CAAC"}

package/lib/index.js

@@ -0,0 +1,80 @@
+"use strict";
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+const tslib_1 = require("tslib");
+const unist_util_visit_1 = tslib_1.__importDefault(require("unist-util-visit"));
+const npm_to_yarn_1 = tslib_1.__importDefault(require("npm-to-yarn"));
+// E.g. global install: 'npm i' -> 'yarn'
+const convertNpmToYarn = (npmCode) => (0, npm_to_yarn_1.default)(npmCode, 'yarn');
+const transformNode = (node, isSync) => {
+    const groupIdProp = isSync ? ' groupId="npm2yarn"' : '';
+    const npmCode = node.value;
+    const yarnCode = convertNpmToYarn(node.value);
+    return [
+        {
+            type: 'jsx',
+            value: `<Tabs${groupIdProp}>\n<TabItem value="npm">`,
+        },
+        {
+            type: node.type,
+            lang: node.lang,
+            value: npmCode,
+        },
+        {
+            type: 'jsx',
+            value: '</TabItem>\n<TabItem value="yarn" label="Yarn">',
+        },
+        {
+            type: node.type,
+            lang: node.lang,
+            value: yarnCode,
+        },
+        {
+            type: 'jsx',
+            value: '</TabItem>\n</Tabs>',
+        },
+    ];
+};
+const isImport = (node) => node.type === 'import';
+const isParent = (node) => Array.isArray(node.children);
+const matchNode = (node) => node.type === 'code' && node.meta === 'npm2yarn';
+const nodeForImport = {
+    type: 'import',
+    value: "import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';",
+};
+const plugin = (options = {}) => {
+    const { sync = false } = options;
+    return (root) => {
+        let transformed = false;
+        let alreadyImported = false;
+        (0, unist_util_visit_1.default)(root, (node) => {
+            if (isImport(node) && node.value.includes('@theme/Tabs')) {
+                alreadyImported = true;
+            }
+            if (isParent(node)) {
+                let index = 0;
+                while (index < node.children.length) {
+                    const child = node.children[index];
+                    if (matchNode(child)) {
+                        const result = transformNode(child, sync);
+                        node.children.splice(index, 1, ...result);
+                        index += result.length;
+                        transformed = true;
+                    }
+                    else {
+                        index += 1;
+                    }
+                }
+            }
+        });
+        if (transformed && !alreadyImported) {
+            root.children.unshift(nodeForImport);
+        }
+    };
+};
+module.exports = plugin;
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAEH,gFAAqC;AACrC,sEAAoC;AASpC,yCAAyC;AACzC,MAAM,gBAAgB,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,IAAA,qBAAS,EAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AAEzE,MAAM,aAAa,GAAG,CAAC,IAAU,EAAE,MAAe,EAAE,EAAE;IACpD,MAAM,WAAW,GAAG,MAAM,CAAC,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,CAAC;IACxD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC;IAC3B,MAAM,QAAQ,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC9C,OAAO;QACL;YACE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,QAAQ,WAAW,0BAA0B;SACrD;QACD;YACE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,OAAO;SACf;QACD;YACE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,iDAAiD;SACzD;QACD;YACE,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,KAAK,EAAE,QAAQ;SAChB;QACD;YACE,IAAI,EAAE,KAAK;YACX,KAAK,EAAE,qBAAqB;SAC7B;KACW,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAmB,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,QAAQ,CAAC;AACzE,MAAM,QAAQ,GAAG,CAAC,IAAU,EAAkB,EAAE,CAC9C,KAAK,CAAC,OAAO,CAAE,IAAe,CAAC,QAAQ,CAAC,CAAC;AAC3C,MAAM,SAAS,GAAG,CAAC,IAAU,EAAgB,EAAE,CAC7C,IAAI,CAAC,IAAI,KAAK,MAAM,IAAK,IAAa,CAAC,IAAI,KAAK,UAAU,CAAC;AAC7D,MAAM,aAAa,GAAY;IAC7B,IAAI,EAAE,QAAQ;IACd,KAAK,EACH,wEAAwE;CAC3E,CAAC;AAEF,MAAM,MAAM,GAA6B,CAAC,OAAO,GAAG,EAAE,EAAE,EAAE;IACxD,MAAM,EAAC,IAAI,GAAG,KAAK,EAAC,GAAG,OAAO,CAAC;IAC/B,OAAO,CAAC,IAAI,EAAE,EAAE;QACd,IAAI,WAAW,GAAG,KAAgB,CAAC;QACnC,IAAI,eAAe,GAAG,KAAgB,CAAC;QACvC,IAAA,0BAAK,EAAC,IAAI,EAAE,CAAC,IAAU,EAAE,EAAE;YACzB,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE;gBACxD,eAAe,GAAG,IAAI,CAAC;aACxB;YACD,IAAI,QAAQ,CAAC,IAAI,CAAC,EAAE;gBAClB,IAAI,KAAK,GAAG,CAAC,CAAC;gBACd,OAAO,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;oBACnC,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAE,CAAC;oBACpC,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE;wBACpB,MAAM,MAAM,GAAG,aAAa,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;wBAC1C,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,MAAM,CAAC,CAAC;wBAC1C,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC;wBACvB,WAAW,GAAG,IAAI,CAAC;qBACpB;yBAAM;wBACL,KAAK,IAAI,CAAC,CAAC;qBACZ;iBACF;aACF;QACH,CAAC,CAAC,CAAC;QACH,IAAI,WAAW,IAAI,CAAC,eAAe,EAAE;YAClC,IAAe,CAAC,QAAQ,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;SAClD;IACH,CAAC,CAAC;AACJ,CAAC,CAAC;AAIF,iBAAS,MAAM,CAAC"}

package/package.json

@@ -1,11 +1,15 @@
 {
   "name": "@docusaurus/remark-plugin-npm2yarn",
-  "version": "2.0.0-beta.fbdeefcac",
+  "version": "2.0.0-rc.1",
   "description": "Remark plugin for converting npm commands to Yarn commands as tabs.",
-  "main": "src/index.js",
+  "main": "lib/index.js",
   "publishConfig": {
     "access": "public"
   },
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/facebook/docusaurus.git",
@@ -13,19 +17,18 @@
   },
   "license": "MIT",
   "dependencies": {
-    "npm-to-yarn": "^1.0.1"
+    "npm-to-yarn": "^1.0.1",
+    "tslib": "^2.4.0",
+    "unist-util-visit": "^2.0.3"
   },
   "devDependencies": {
-    "remark": "^12.0.0",
+    "@types/mdast": "^3.0.10",
+    "remark": "^12.0.1",
     "remark-mdx": "^1.6.21",
-    "to-vfile": "^6.0.0"
-  },
-  "peerDependencies": {
-    "react": "^16.8.4 || ^17.0.0",
-    "react-dom": "^16.8.4 || ^17.0.0"
+    "to-vfile": "^6.1.0"
   },
   "engines": {
-    "node": ">=12.13.0"
+    "node": ">=16.14"
   },
-  "gitHead": "636c490f68d16a7452499ab722deb5ed51ef49fc"
+  "gitHead": "c8ddd02a8e68dfaf515c20465a049a83153bd205"
 }

package/src/index.ts

@@ -0,0 +1,94 @@
+/**
+ * Copyright (c) Facebook, Inc. and its affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+import visit from 'unist-util-visit';
+import npmToYarn from 'npm-to-yarn';
+import type {Code, Content, Literal} from 'mdast';
+import type {Plugin} from 'unified';
+import type {Node, Parent} from 'unist';
+
+type PluginOptions = {
+  sync?: boolean;
+};
+
+// E.g. global install: 'npm i' -> 'yarn'
+const convertNpmToYarn = (npmCode: string) => npmToYarn(npmCode, 'yarn');
+
+const transformNode = (node: Code, isSync: boolean) => {
+  const groupIdProp = isSync ? ' groupId="npm2yarn"' : '';
+  const npmCode = node.value;
+  const yarnCode = convertNpmToYarn(node.value);
+  return [
+    {
+      type: 'jsx',
+      value: `<Tabs${groupIdProp}>\n<TabItem value="npm">`,
+    },
+    {
+      type: node.type,
+      lang: node.lang,
+      value: npmCode,
+    },
+    {
+      type: 'jsx',
+      value: '</TabItem>\n<TabItem value="yarn" label="Yarn">',
+    },
+    {
+      type: node.type,
+      lang: node.lang,
+      value: yarnCode,
+    },
+    {
+      type: 'jsx',
+      value: '</TabItem>\n</Tabs>',
+    },
+  ] as Content[];
+};
+
+const isImport = (node: Node): node is Literal => node.type === 'import';
+const isParent = (node: Node): node is Parent =>
+  Array.isArray((node as Parent).children);
+const matchNode = (node: Node): node is Code =>
+  node.type === 'code' && (node as Code).meta === 'npm2yarn';
+const nodeForImport: Literal = {
+  type: 'import',
+  value:
+    "import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';",
+};
+
+const plugin: Plugin<[PluginOptions?]> = (options = {}) => {
+  const {sync = false} = options;
+  return (root) => {
+    let transformed = false as boolean;
+    let alreadyImported = false as boolean;
+    visit(root, (node: Node) => {
+      if (isImport(node) && node.value.includes('@theme/Tabs')) {
+        alreadyImported = true;
+      }
+      if (isParent(node)) {
+        let index = 0;
+        while (index < node.children.length) {
+          const child = node.children[index]!;
+          if (matchNode(child)) {
+            const result = transformNode(child, sync);
+            node.children.splice(index, 1, ...result);
+            index += result.length;
+            transformed = true;
+          } else {
+            index += 1;
+          }
+        }
+      }
+    });
+    if (transformed && !alreadyImported) {
+      (root as Parent).children.unshift(nodeForImport);
+    }
+  };
+};
+
+// To continue supporting `require('npm2yarn')` without the `.default` ㄟ(▔,▔)ㄏ
+// TODO change to export default after migrating to ESM
+export = plugin;

package/src/__tests__/__snapshots__/index.test.js.snap

@@ -1,130 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`npm2yarn plugin test: already imported tabs components above are not re-imported 1`] = `
-"import Tabs from '@theme/Tabs';
-
-import TabItem from '@theme/TabItem';
-
-<Tabs defaultValue=\\"npm\\" values={[
-    { label: 'npm', value: 'npm', },
-    { label: 'Yarn', value: 'yarn', },
-  ]}
->
-<TabItem value=\\"npm\\">
-
-\`\`\`bash
-  $ npm install --global docusaurus
-\`\`\`
-
-</TabItem>
-<TabItem value=\\"yarn\\">
-
-\`\`\`bash
-  $ yarn add --global docusaurus
-\`\`\`
-
-</TabItem>
-</Tabs>
-"
-`;
-
-exports[`npm2yarn plugin test: already imported tabs components below are not re-imported 1`] = `
-"<Tabs defaultValue=\\"npm\\" values={[
-    { label: 'npm', value: 'npm', },
-    { label: 'Yarn', value: 'yarn', },
-  ]}
->
-<TabItem value=\\"npm\\">
-
-\`\`\`bash
-  $ npm install --global docusaurus
-\`\`\`
-
-</TabItem>
-<TabItem value=\\"yarn\\">
-
-\`\`\`bash
-  $ yarn add --global docusaurus
-\`\`\`
-
-</TabItem>
-</Tabs>
-
-import Tabs from '@theme/Tabs';
-
-import TabItem from '@theme/TabItem';
-"
-`;
-
-exports[`npm2yarn plugin test: installation file 1`] = `
-"import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-<Tabs defaultValue=\\"npm\\" values={[
-    { label: 'npm', value: 'npm', },
-    { label: 'Yarn', value: 'yarn', },
-  ]}
->
-<TabItem value=\\"npm\\">
-
-\`\`\`bash
-  $ npm install --global docusaurus
-\`\`\`
-
-</TabItem>
-<TabItem value=\\"yarn\\">
-
-\`\`\`bash
-  $ yarn add --global docusaurus
-\`\`\`
-
-</TabItem>
-</Tabs>
-"
-`;
-
-exports[`npm2yarn plugin test: language was not setted 1`] = `
-"\`\`\`npm2yarn
-npm install --save docusaurus-plugin-name
-\`\`\`
-
-\`\`\`bash
-npm install --save docusaurus-plugin-name
-\`\`\`
-
-\`\`\`shell
-npm install --save docusaurus-plugin-name
-\`\`\`
-"
-`;
-
-exports[`npm2yarn plugin test: plugin file 1`] = `
-"import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-## Installing a plugin
-
-A plugin is usually a npm package, so you install them like other npm packages using npm.
-
-<Tabs defaultValue=\\"npm\\" values={[
-    { label: 'npm', value: 'npm', },
-    { label: 'Yarn', value: 'yarn', },
-  ]}
->
-<TabItem value=\\"npm\\">
-
-\`\`\`bash
-npm install --save docusaurus-plugin-name
-\`\`\`
-
-</TabItem>
-<TabItem value=\\"yarn\\">
-
-\`\`\`bash
-yarn add docusaurus-plugin-name
-\`\`\`
-
-</TabItem>
-</Tabs>
-"
-`;

package/src/__tests__/fixtures/import-tabs-above.md

@@ -1,7 +0,0 @@
-import Tabs from '@theme/Tabs';
-
-import TabItem from '@theme/TabItem';
-
-```bash npm2yarn
-  $ npm install --global docusaurus
-```

package/src/__tests__/fixtures/import-tabs-below.md

@@ -1,7 +0,0 @@
-```bash npm2yarn
-  $ npm install --global docusaurus
-```
-
-import Tabs from '@theme/Tabs';
-
-import TabItem from '@theme/TabItem';

package/src/__tests__/fixtures/installation.md

@@ -1,3 +0,0 @@
-```bash npm2yarn
-  $ npm install --global docusaurus
-```

package/src/__tests__/fixtures/plugin.md

@@ -1,7 +0,0 @@
-## Installing a plugin
-
-A plugin is usually a npm package, so you install them like other npm packages using npm.
-
-```bash npm2yarn
-npm install --save docusaurus-plugin-name
-```

package/src/__tests__/fixtures/syntax-not-properly-set.md

@@ -1,11 +0,0 @@
-```npm2yarn
-npm install --save docusaurus-plugin-name
-```
-
-```bash
-npm install --save docusaurus-plugin-name
-```
-
-```shell
-npm install --save docusaurus-plugin-name
-```

package/src/__tests__/index.test.js

@@ -1,69 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/* eslint-disable no-param-reassign */
-
-import remark from 'remark';
-import npm2yarn from '../index';
-import vfile from 'to-vfile';
-import {join, relative} from 'path';
-import mdx from 'remark-mdx';
-
-const staticDir = `./${relative(process.cwd(), join(__dirname, 'fixtures'))}`;
-
-const processFixture = async (name, options) => {
-  const path = join(__dirname, 'fixtures', `${name}.md`);
-  const file = await vfile.read(path);
-  const result = await remark()
-    .use(mdx)
-    .use(npm2yarn, {...options, filePath: path})
-    .process(file);
-
-  return result.toString();
-};
-
-describe('npm2yarn plugin', () => {
-  test('test: installation file', async () => {
-    const result = await processFixture('installation', {
-      staticDir,
-    });
-
-    expect(result).toMatchSnapshot();
-  });
-
-  test('test: plugin file', async () => {
-    const result = await processFixture('plugin', {
-      staticDir,
-    });
-
-    expect(result).toMatchSnapshot();
-  });
-
-  test('test: language was not setted', async () => {
-    const result = await processFixture('syntax-not-properly-set', {
-      staticDir,
-    });
-
-    expect(result).toMatchSnapshot();
-  });
-
-  test('test: already imported tabs components above are not re-imported', async () => {
-    const result = await processFixture('import-tabs-above', {
-      staticDir,
-    });
-
-    expect(result).toMatchSnapshot();
-  });
-
-  test('test: already imported tabs components below are not re-imported', async () => {
-    const result = await processFixture('import-tabs-below', {
-      staticDir,
-    });
-
-    expect(result).toMatchSnapshot();
-  });
-});

package/src/index.js

@@ -1,87 +0,0 @@
-/**
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-const npmToYarn = require('npm-to-yarn');
-
-// E.g. global install: 'npm i' -> 'yarn'
-const convertNpmToYarn = (npmCode) => npmToYarn(npmCode, 'yarn');
-
-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" ${groupIdProp}` +
-        `values={[
-    { label: 'npm', value: 'npm', },
-    { label: 'Yarn', value: 'yarn', },
-  ]}
->
-<TabItem value="npm">`,
-    },
-    {
-      type: node.type,
-      lang: node.lang,
-      value: npmCode,
-    },
-    {
-      type: 'jsx',
-      value: '</TabItem>\n<TabItem value="yarn">',
-    },
-    {
-      type: node.type,
-      lang: node.lang,
-      value: yarnCode,
-    },
-    {
-      type: 'jsx',
-      value: '</TabItem>\n</Tabs>',
-    },
-  ];
-};
-
-const matchNode = (node) => node.type === 'code' && node.meta === 'npm2yarn';
-const nodeForImport = {
-  type: 'import',
-  value:
-    "import Tabs from '@theme/Tabs';\nimport TabItem from '@theme/TabItem';",
-};
-
-module.exports = (options = {}) => {
-  const {sync = false} = options;
-  let transformed = false;
-  let alreadyImported = false;
-  const transformer = (node) => {
-    if (node.type === 'import' && node.value.includes('@theme/Tabs')) {
-      alreadyImported = true;
-    }
-    if (matchNode(node)) {
-      transformed = true;
-      return transformNode(node, sync);
-    }
-    if (Array.isArray(node.children)) {
-      let index = 0;
-      while (index < node.children.length) {
-        const result = transformer(node.children[index]);
-        if (result) {
-          node.children.splice(index, 1, ...result);
-          index += result.length;
-        } else {
-          index += 1;
-        }
-      }
-    }
-    if (node.type === 'root' && transformed && !alreadyImported) {
-      node.children.unshift(nodeForImport);
-    }
-    return null;
-  };
-  return transformer;
-};