refactor(v2): plugin, utils as separate package (#1298)

* refactor(v2): plugin, utils as separate package

* rename docusaurus-plugin to @docusaurus/plugin

* update snapshot

packages/docusaurus-plugin-content-blog/index.js

@@ -8,8 +8,7 @@
 const globby = require('globby');
 const path = require('path');
 const fs = require('fs-extra');
-// TODO: Do not make it relative because plugins can be from node_modules.
-const {parse, idx, normalizeUrl} = require('../../lib/load/utils');
+const {parse, idx, normalizeUrl} = require('@docusaurus/utils');
 
 function fileToUrl(fileName) {
   return fileName

packages/docusaurus-plugin-content-blog/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@docusaurus/plugin-content-blog",
+  "version": "1.0.0",
+  "description": "Blog content plugin for Docusaurus",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/utils": "^1.0.0",
+    "fs-extra": "^7.0.1",
+    "globby": "^9.1.0"
+  }
+}

packages/docusaurus-plugin-content-pages/__tests__/index.test.js

@@ -7,7 +7,7 @@
 
 import path from 'path';
 
-import loadSetup from '../../../test/loadSetup';
+import loadSetup from '../../docusaurus/test/loadSetup';
 import DocusaurusPluginContentPages from '../index';
 
 describe('docusaurus-plugin-content-pages', () => {

packages/docusaurus-plugin-content-pages/index.js

@@ -9,7 +9,7 @@ const globby = require('globby');
 const path = require('path');
 
 // TODO: Do not make it relative because plugins can be from node_modules.
-const {encodePath, fileToPath, idx} = require('../../lib/load/utils');
+const {encodePath, fileToPath, idx} = require('@docusaurus/utils');
 
 const DEFAULT_OPTIONS = {
   metadataKey: 'pagesMetadata',

packages/docusaurus-plugin-content-pages/package.json

@@ -0,0 +1,11 @@
+{
+  "name": "@docusaurus/plugin-content-pages",
+  "version": "1.0.0",
+  "description": "Pages content plugin for Docusaurus",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "@docusaurus/utils": "^1.0.0",
+    "globby": "^9.1.0"
+  }
+}

packages/docusaurus-utils/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@docusaurus/utils",
+  "version": "1.0.0",
+  "description": "A set of utility functions for Docusaurus packages",
+  "main": "index.js",
+  "license": "MIT",
+  "dependencies": {
+    "escape-string-regexp": "^1.0.5",
+    "front-matter": "^2.3.0",
+    "fs-extra": "^7.0.0"
+  }
+}

packages/docusaurus-utils/test/index.test.js

@@ -12,7 +12,7 @@ import {
   idx,
   getSubFolder,
   normalizeUrl,
-} from '@lib/load/utils';
+} from '../index';
 
 describe('load utils', () => {
   test('fileToComponentName', () => {

packages/docusaurus/lib/load/docs/index.js

@@ -7,10 +7,10 @@
 
 const path = require('path');
 const globby = require('globby');
+const {getSubFolder, idx} = require('@docusaurus/utils');
 const createOrder = require('./order');
 const loadSidebars = require('./sidebars');
 const processMetadata = require('./metadata');
-const {getSubFolder, idx} = require('../utils');
 
 async function loadDocs({siteDir, docsDir, env, siteConfig}) {
   // @tested - load all sidebars including versioned sidebars

packages/docusaurus/lib/load/docs/metadata.js

@@ -7,7 +7,7 @@
 
 const fs = require('fs-extra');
 const path = require('path');
-const {getSubFolder, idx, parse, normalizeUrl} = require('../utils');
+const {getSubFolder, idx, parse, normalizeUrl} = require('@docusaurus/utils');
 
 function getLanguage(filepath, refDir, env) {
   const translationEnabled = idx(env, ['translation', 'enabled']);

packages/docusaurus/lib/load/docs/sidebars.js

@@ -7,7 +7,7 @@
 
 const fs = require('fs-extra');
 const path = require('path');
-const {idx} = require('../utils');
+const {idx} = require('@docusaurus/utils');
 
 /**
  * Check that item contains only allowed keys

packages/docusaurus/lib/load/env.js

@@ -7,7 +7,7 @@
 
 const fs = require('fs-extra');
 const path = require('path');
-const {idx} = require('./utils');
+const {idx} = require('@docusaurus/utils');
 const loadConfig = require('./config');
 
 module.exports = function loadEnv({siteDir, siteConfig}) {

packages/docusaurus/lib/load/index.js

@@ -8,11 +8,11 @@
 const ejs = require('ejs');
 const fs = require('fs-extra');
 const path = require('path');
+const {generate} = require('@docusaurus/utils');
 const loadConfig = require('./config');
 const loadDocs = require('./docs');
 const loadEnv = require('./env');
 const loadTheme = require('./theme');
-const {generate} = require('./utils');
 const loadRoutes = require('./routes');
 const constants = require('../constants');
 
@@ -75,26 +75,23 @@ module.exports = async function load(siteDir) {
   const context = {env, siteDir, siteConfig};
 
   // Initialize plugins.
-  const pluginDir = path.resolve(__dirname, '../../plugins');
-  const plugins = pluginConfigs.map(
-    ({name, path: pluginPath = path.join(pluginDir, name), options}) => {
-      let Plugin;
-      // If it exist in provided path or official plugin directory
-      if (pluginPath && fs.existsSync(pluginPath)) {
+  const plugins = pluginConfigs.map(({name, path: pluginPath, options}) => {
+    let Plugin;
+    // If path itself is provided
+    if (pluginPath && fs.existsSync(pluginPath)) {
+      // eslint-disable-next-line
+      Plugin = require(pluginPath);
+    } else {
+      // Resolve using node_modules as well.
+      try {
         // eslint-disable-next-line
-        Plugin = require(pluginPath);
-      } else {
-        // Resolve using node_modules as well.
-        try {
-          // eslint-disable-next-line
-          Plugin = require(name);
-        } catch (e) {
-          throw new Error(`'${name}' plugin cannot be found.`);
-        }
+        Plugin = require(name);
+      } catch (e) {
+        throw new Error(`'${name}' plugin cannot be found.`);
       }
-      return new Plugin(options, context);
-    },
-  );
+    }
+    return new Plugin(options, context);
+  });
 
   // Plugin lifecycle - loadContents().
   // Currently plugins run lifecycle in parallel and are not order-dependent. We could change

packages/docusaurus/lib/load/routes.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-const {normalizeUrl} = require('./utils');
+const {normalizeUrl} = require('@docusaurus/utils');
 
 async function loadRoutes({
   siteConfig = {},

packages/docusaurus/package.json

@@ -31,6 +31,7 @@
     "@babel/polyfill": "^7.0.0",
     "@babel/preset-env": "^7.0.0",
     "@babel/preset-react": "^7.0.0",
+    "@docusaurus/utils": "^1.0.0",
     "@mapbox/rehype-prism": "^0.3.1",
     "@mdx-js/loader": "^0.20.1",
     "@mdx-js/mdx": "^0.20.1",
@@ -46,7 +47,6 @@
     "css-loader": "^1.0.0",
     "docsearch.js": "^2.5.2",
     "ejs": "^2.6.1",
-    "escape-string-regexp": "^1.0.5",
     "front-matter": "^2.3.0",
     "fs-extra": "^7.0.0",
     "globby": "^8.0.1",

packages/docusaurus/test/__fixtures__/custom-site/docusaurus.config.js

@@ -20,7 +20,7 @@ module.exports = {
   favicon: 'img/docusaurus.ico',
   plugins: [
     {
-      name: 'docusaurus-plugin-content-pages',
+      name: '@docusaurus/plugin-content-pages',
     },
   ],
 };

packages/docusaurus/test/__fixtures__/simple-site/docusaurus.config.js

@@ -20,7 +20,7 @@ module.exports = {
   favicon: 'img/docusaurus.ico',
   plugins: [
     {
-      name: 'docusaurus-plugin-content-pages',
+      name: '@docusaurus/plugin-content-pages',
     },
   ],
 };

packages/docusaurus/test/__fixtures__/translated-site/docusaurus.config.js

@@ -21,7 +21,7 @@ module.exports = {
   favicon: 'img/docusaurus.ico',
   plugins: [
     {
-      name: 'docusaurus-plugin-content-pages',
+      name: '@docusaurus/plugin-content-pages',
     },
   ],
 };

packages/docusaurus/test/__fixtures__/transversioned-site/docusaurus.config.js

@@ -21,7 +21,7 @@ module.exports = {
   favicon: 'img/docusaurus.ico',
   plugins: [
     {
-      name: 'docusaurus-plugin-content-pages',
+      name: '@docusaurus/plugin-content-pages',
     },
   ],
 };

packages/docusaurus/test/__fixtures__/versioned-site/docusaurus.config.js

@@ -20,7 +20,7 @@ module.exports = {
   favicon: 'img/docusaurus.ico',
   plugins: [
     {
-      name: 'docusaurus-plugin-content-pages',
+      name: '@docusaurus/plugin-content-pages',
     },
   ],
 };

packages/docusaurus/test/load/config.test.js

@@ -36,7 +36,7 @@ Object {
   "organizationName": "endiliey",
   "plugins": Array [
     Object {
-      "name": "docusaurus-plugin-content-pages",
+      "name": "@docusaurus/plugin-content-pages",
     },
   ],
   "projectName": "hello",