feat: load hexo plugin in the theme's package.json (#4771)

lib/hexo/index.js

@@ -268,16 +268,14 @@ class Hexo extends EventEmitter {
     return this.database.model(name, schema);
   }
 
-  resolvePlugin(name) {
-    const baseDir = this.base_dir;
-
+  resolvePlugin(name, basedir) {
     try {
       // Try to resolve the plugin with the resolve.sync.
-      return sync(name, { basedir: baseDir });
+      return sync(name, { basedir });
     } catch (err) {
       // There was an error (likely the plugin wasn't found), so return a possibly
       // non-existing path that a later part of the resolution process will check.
-      return join(baseDir, 'node_modules', name);
+      return join(basedir, 'node_modules', name);
     }
   }
 

lib/hexo/load_plugins.js

@@ -11,8 +11,8 @@ module.exports = ctx => {
   return loadModules(ctx).then(() => loadScripts(ctx));
 };
 
-function loadModuleList(ctx) {
-  const packagePath = join(ctx.base_dir, 'package.json');
+function loadModuleList(ctx, basedir) {
+  const packagePath = join(basedir, 'package.json');
 
   // Make sure package.json exists
   return exists(packagePath).then(exist => {
@@ -24,7 +24,7 @@ function loadModuleList(ctx) {
       const deps = Object.keys(json.dependencies || {});
       const devDeps = Object.keys(json.devDependencies || {});
 
-      return deps.concat(devDeps);
+      return basedir === ctx.base_dir ? deps.concat(devDeps) : deps;
     });
   }).filter(name => {
     // Ignore plugins whose name is not started with "hexo-"
@@ -37,22 +37,26 @@ function loadModuleList(ctx) {
     if (name.startsWith('@types/')) return false;
 
     // Make sure the plugin exists
-    const path = ctx.resolvePlugin(name);
+    const path = ctx.resolvePlugin(name, basedir);
     return exists(path);
+  }).then(modules => {
+    return Object.fromEntries(modules.map(name => [name, ctx.resolvePlugin(name, basedir)]));
   });
 }
 
 function loadModules(ctx) {
-  return loadModuleList(ctx).map(name => {
-    const path = ctx.resolvePlugin(name);
-
-    // Load plugins
-    return ctx.loadPlugin(path).then(() => {
-      ctx.log.debug('Plugin loaded: %s', magenta(name));
-    }).catch(err => {
-      ctx.log.error({err}, 'Plugin load failed: %s', magenta(name));
+  return Promise.map([ctx.base_dir, ctx.theme_dir], basedir => loadModuleList(ctx, basedir))
+    .then(([hexoModuleList, themeModuleList]) => {
+      return Object.entries(Object.assign(themeModuleList, hexoModuleList));
+    })
+    .map(([name, path]) => {
+      // Load plugins
+      return ctx.loadPlugin(path).then(() => {
+        ctx.log.debug('Plugin loaded: %s', magenta(name));
+      }).catch(err => {
+        ctx.log.error({err}, 'Plugin load failed: %s', magenta(name));
+      });
     });
-  });
 }
 
 function loadScripts(ctx) {

test/scripts/hexo/load_plugins.js

@@ -29,34 +29,31 @@ describe('Load plugins', () => {
     delete hexo._script_test;
   }
 
-  function createPackageFile(...args) {
+  function createPackageFile(name, path) {
     const pkg = {
       name: 'hexo-site',
       version: '0.0.0',
       private: true,
-      dependencies: {}
+      dependencies: {
+        [name]: '*'
+      }
     };
 
-    for (const arg of args) {
-      pkg.dependencies[arg] = '*';
-    }
-
-    return fs.writeFile(join(hexo.base_dir, 'package.json'), JSON.stringify(pkg, null, '  '));
+    path = path || join(hexo.base_dir, 'package.json');
+    return fs.writeFile(path, JSON.stringify(pkg, null, '  '));
   }
 
-  function createPackageFileWithDevDeps(...args) {
+  function createPackageFileWithDevDeps(name) {
     const pkg = {
       name: 'hexo-site',
       version: '0.0.0',
       private: true,
       dependencies: {},
-      devDependencies: {}
+      devDependencies: {
+        [name]: '*'
+      }
     };
 
-    for (let i = 0, len = args.length; i < len; i++) {
-      pkg.devDependencies[args[i]] = '*';
-    }
-
     return fs.writeFile(join(hexo.base_dir, 'package.json'), JSON.stringify(pkg, null, '  '));
   }
 
@@ -67,6 +64,10 @@ describe('Load plugins', () => {
 
   after(() => fs.rmdir(hexo.base_dir));
 
+  afterEach(async () => {
+    await createPackageFile('hexo-another-plugin');
+  });
+
   it('load plugins', () => {
     const name = 'hexo-plugin-test';
     const path = join(hexo.plugin_dir, name, 'index.js');
@@ -106,9 +107,19 @@ describe('Load plugins', () => {
     });
   });
 
-  it('ignore plugin whose name is "hexo-theme-[hexo.config.theme]"', async () => {
-    hexo.config.theme = 'test_theme';
+  it('load plugins in the theme\'s package.json', async () => {
+    const name = 'hexo-plugin-test';
+    const path = join(hexo.plugin_dir, name, 'index.js');
+    return Promise.all([
+      createPackageFile(name, join(hexo.theme_dir, 'package.json')),
+      fs.writeFile(path, script)
+    ]).then(() => loadPlugins(hexo)).then(() => {
+      validate(path);
+      return fs.unlink(path);
+    });
+  });
 
+  it('ignore plugin whose name is started with "hexo-theme-"', async () => {
     const script = 'hexo._script_test = true';
     const name = 'hexo-theme-test_theme';
     const path = join(hexo.plugin_dir, name, 'index.js');
@@ -124,9 +135,7 @@ describe('Load plugins', () => {
     return fs.unlink(path);
   });
 
-  it('ignore plugin whose name endswith "hexo-theme-[hexo.config.theme]"', async () => {
-    hexo.config.theme = 'test_theme';
-
+  it('ignore scoped plugin whose name is started with "hexo-theme-"', async () => {
     const script = 'hexo._script_test = true';
     const name = '@hexojs/hexo-theme-test_theme';
     const path = join(hexo.plugin_dir, name, 'index.js');