fix(box): ignore correct .git and node modules in the theme folder (

#4306)

* improve ignoreCfg

* fix test case

* fix this.ignore property

* format code

* fix test case

lib/box/index.js

@@ -8,7 +8,6 @@ const { createReadStream, readdir, stat, watch } = require('hexo-fs');
 const { magenta } = require('chalk');
 const { EventEmitter } = require('events');
 const { isMatch, makeRe } = require('micromatch');
-const ignore = ['**/themes/*/node_modules/**', '**/themes/*/.git/**'];
 
 const defaultPattern = new Pattern(() => ({}));
 
@@ -31,14 +30,12 @@ class Box extends EventEmitter {
     this.watcher = null;
     this.Cache = ctx.model('Cache');
     this.File = this._createFileClass();
-
-    let ignoreCfg = ignore;
-    if (ctx.config.ignore) {
-      if (ctx.config.ignore.length) ignoreCfg = ignoreCfg.concat(ctx.config.ignore);
+    let targets = this.options.ignored || [];
+    if (ctx.config.ignore && ctx.config.ignore.length) {
+      targets = targets.concat(ctx.config.ignore);
     }
-    this.ignore = ignoreCfg;
-    const targets = ignoreCfg;
-    this.options.ignored = (this.options.ignored || []).concat(targets.map(s => toRegExp(ctx, s)).filter(x => x));
+    this.ignore = targets;
+    this.options.ignored = targets.map(s => toRegExp(ctx, s)).filter(x => x);
   }
   _createFileClass() {
     const ctx = this.context;

lib/hexo/load_config.js

@@ -44,13 +44,16 @@ module.exports = async ctx => {
   const themeDirFromNodeModules = join(ctx.plugin_dir, 'hexo-theme-' + theme) + sep; // base_dir/node_modules/hexo-theme-[config.theme]/
 
   // themeDirFromThemes has higher priority than themeDirFromNodeModules
+  let ignored = [];
   if (await exists(themeDirFromThemes)) {
     ctx.theme_dir = themeDirFromThemes;
+    ignored = ['**/themes/*/node_modules/**', '**/themes/*/.git/**'];
   } else if (await exists(themeDirFromNodeModules)) {
     ctx.theme_dir = themeDirFromNodeModules;
+    ignored = ['**/node_modules/hexo-theme-*/node_modules/**', '**/node_modules/hexo-theme-*/.git/**'];
   }
   ctx.theme_script_dir = join(ctx.theme_dir, 'scripts') + sep;
-  ctx.theme = new Theme(ctx);
+  ctx.theme = new Theme(ctx, { ignored });
 
 };
 

lib/theme/index.js

@@ -6,8 +6,8 @@ const View = require('./view');
 const I18n = require('hexo-i18n');
 
 class Theme extends Box {
-  constructor(ctx) {
-    super(ctx, ctx.theme_dir);
+  constructor(ctx, options) {
+    super(ctx, ctx.theme_dir, options);
 
     this.config = {};
 

test/scripts/box/box.js

@@ -301,45 +301,6 @@ describe('Box', () => {
     await rmdir(box.base);
   });
 
-  it('process() - skip node_modules of theme by default', async () => {
-    const box = newBox('test', { ignore: null });
-    const data = {};
-
-    box.addProcessor(file => {
-      data[file.path] = file;
-    });
-
-    await Promise.all([
-      writeFile(join(box.base, 'foo.txt'), 'foo'),
-      writeFile(join(box.base, 'themes', 'bar', 'node_modules', 'bar_library', 'bar.js'), 'themes')
-    ]);
-    await box.process();
-
-    data.should.have.all.keys(['foo.txt']);
-
-    await rmdir(box.base);
-  });
-
-  it('process() - always skip node_modules of theme', async () => {
-    const box = newBox('test', { ignore: '**/ignore_me' });
-    const data = {};
-
-    box.addProcessor(file => {
-      data[file.path] = file;
-    });
-
-    await Promise.all([
-      writeFile(join(box.base, 'foo.txt'), 'foo'),
-      writeFile(join(box.base, 'ignore_me', 'bar.txt'), 'ignore_me'),
-      writeFile(join(box.base, 'themes', 'bar', 'node_modules', 'bar_library', 'bar.js'), 'themes')
-    ]);
-    await box.process();
-
-    data.should.have.all.keys(['foo.txt']);
-
-    await rmdir(box.base);
-  });
-
   it('watch() - create', async () => {
     const box = newBox('test');
     const path = 'a.txt';

test/scripts/hexo/load_config.js

@@ -2,6 +2,7 @@
 
 const pathFn = require('path');
 const fs = require('hexo-fs');
+const { makeRe } = require('micromatch');
 
 describe('Load config', () => {
   const Hexo = require('../../../lib/hexo');
@@ -108,6 +109,9 @@ describe('Load config', () => {
       hexo.theme_dir.should.eql(pathFn.join(hexo.base_dir, 'themes', 'test') + pathFn.sep);
       hexo.theme_script_dir.should.eql(pathFn.join(hexo.theme_dir, 'scripts') + pathFn.sep);
       hexo.theme.base.should.eql(hexo.theme_dir);
+      const ignore = ['**/themes/*/node_modules/**', '**/themes/*/.git/**'];
+      hexo.theme.ignore.should.eql(ignore);
+      hexo.theme.options.ignored.should.eql(ignore.map(item => makeRe(item)));
     }).finally(() => {
       fs.rmdir(pathFn.join(hexo.base_dir, 'themes', 'test'));
       fs.unlink(hexo.config_path);
@@ -121,6 +125,9 @@ describe('Load config', () => {
       hexo.theme_dir.should.eql(pathFn.join(hexo.plugin_dir, 'hexo-theme-test') + pathFn.sep);
       hexo.theme_script_dir.should.eql(pathFn.join(hexo.theme_dir, 'scripts') + pathFn.sep);
       hexo.theme.base.should.eql(hexo.theme_dir);
+      const ignore = ['**/node_modules/hexo-theme-*/node_modules/**', '**/node_modules/hexo-theme-*/.git/**'];
+      hexo.theme.ignore.should.eql(ignore);
+      hexo.theme.options.ignored.should.eql(ignore.map(item => makeRe(item)));
     }).finally(() => {
       fs.rmdir(pathFn.join(hexo.plugin_dir, 'hexo-theme-test'));
       fs.unlink(hexo.config_path);