feat: webpack factory (#130)

* fix codecov & update readme

* feat: add unittest & fix env factory bug

Author: njugray

.gitignore

@@ -20,3 +20,4 @@ packages/*/test/**/logs/
 packages/*/test/**/run/
 packages/*/yarn.lock
 package-lock.json
+.nyc_output/

.travis.yml

@@ -10,6 +10,7 @@ before_install:
   - rm -rf ./examples/
 install:
   - npm install
+  - npm install -g codecov
 script:
   # TODO: Use 'lerna run ci' instead
   - npm run ci

packages/beidou-webpack/README-ZH.md

@@ -136,8 +136,108 @@ module.exports = {
 
 ```
 
-#### FAQ:
-使用配置工厂自定义配置项,操作方式如下例
+### 常见配置问题
+
+#### 如何新增 rule ？
+
+```js
+module.exports = (app, defaultConfig, dev, target) => {
+  // 获取配置工厂
+  const factory = app.webpackFactory;
+
+  factory.addRule({
+    test: /.ts/,
+    exclude: /node_modules/,
+    use: 'ts-loader',
+  });
+
+  // 在上述变更后重新生产配置
+  return factory.getConfig();
+};
+```
+
+#### 如何在已有 rule 上修改？
+
+```js
+module.exports = (app, defaultConfig, dev, target) => {
+  // 获取配置工厂
+  const factory = app.webpackFactory;
+
+  const rule = factory.getRule(/.ts/);
+  // 或者
+  // const rule = factory.getRule('.ts');
+  // const rule = factory.getRule((r) => {
+  //   return r.test.test('.ts');
+  // });
+
+  rule.use = {
+    loader: 'ts-loader',
+    options: {
+      // some options
+    }
+  }
+
+  // 在上述变更后重新生产配置
+  return factory.getConfig();
+};
+```
+
+#### 如何新增 Plugin ？
+
+```js
+module.exports = (app, defaultConfig, dev, target) => {
+  // 获取配置工厂
+  const factory = app.webpackFactory;
+  const webpack = factory.webpack;
+  factory.addPlugin(webpack.DefinePlugin, {
+    __FOO__: 'bar',
+  });
+
+  // 在上述变更后重新生产配置
+  return factory.getConfig();
+};
+```
+
+#### 如何修改已有Plugin配置 ？
+
+```js
+module.exports = (app, defaultConfig, dev, target) => {
+  // 获取配置工厂
+  const factory = app.webpackFactory;
+  const plugin = factory.getPlugin('DefinePlugin');
+  plugin.options = {
+    __DEV__: false,
+  }
+
+  // 在上述变更后重新生产配置
+  return factory.getConfig();
+};
+```
+内置所有Plugin和获取方式：
+
+| Plugin | alias |
+|:--|:--|
+|DefinePlugin| 'DefinePlugin' |
+|UglifyJsPlugin| 'UglifyJsPlugin' |
+|NamedModulesPlugin| 'NamedModulesPlugin' |
+|HotModuleReplacementPlugin| 'HotModuleReplacementPlugin' |
+
+默认仅获取匹配的 **一项**，复杂场景需自行遍历查询
+
+`getPlugin` 返回 PluginConfig 对象:
+
+```
+{
+  class: DefinePlugin， // 构造函数
+  options: {} // 构造参数
+  instance: new DefinePlugin({}) // instance 优先，配置后 class 和 options自动失效
+}
+```
+
+#### 其他使用方式
+
+使用配置工厂自定义配置项: 
+
 ```js
 
 module.exports = (app, defaultConfig, dev, target) => {
@@ -195,15 +295,15 @@ module.exports = (app, defaultConfig, dev, target) => {
       exclude: /node_modules/,
       use: {
         loader: 
-        app.webpackFactory.useLoader('babel-loader')/** 如有已定义的loader，则使用自定义loader **/ || 'babel-loader', 
+        factory.useLoader('babel-loader')/** 如有已定义的loader，则使用自定义loader **/ || 'babel-loader', 
         options: {
           babelrc: false,
           presets: ['preset-typescript'],
         },
       },
   }
   // 定义loader的方式
-  app.webpackFactory.defineLoader({
+  factory.defineLoader({
     'babel-loader',
     require.resolve('babel-loader')
   })
@@ -222,7 +322,6 @@ module.exports = (app, defaultConfig, dev, target) => {
 
 };
 
-
 ```
 
 #### 数据结构：

packages/beidou-webpack/lib/factory/plugin.js

@@ -5,21 +5,21 @@ const is = require('is');
 class Plugin {
   constructor(...args) {
     if (is.function(args[0])) {
-      this.class = args[0];
+      [this.class] = args;
       this.alias = args[0].name;
     } else if (is.object(args[0])) {
-      this.object = args[0];
+      [this.object] = args;
       this.alias = args[0].constructor.name;
     } else {
       throw new Error(
         'Class Plugin constructor error ! '
       );
     }
     if (args[1]) {
-      this.options = args[1];
+      [, this.options] = args;
     }
     if (args[2]) {
-      this.alias = args[2];
+      [, , this.alias] = args;
     }
   }
 

packages/beidou-webpack/lib/factory/webpack.js

@@ -28,15 +28,18 @@ class WebpackFactory extends Factory {
    */
   env(env) {
     if (!env) {
-      throw new Error(
-        'Env param is required!'
-      );
+      throw new Error('Env param is required!');
     }
     const factories = Object.getPrototypeOf(this).__envFactories;
     if (factories[env]) {
       return factories[env];
     } else {
-      const factory = new WebpackFactory(this.__webpackConfig, this.__plugins, this.__rules);
+      const factory = new WebpackFactory(
+        Object.assign({}, this.__webpackConfig),
+        Object.assign({}, this.__plugins),
+        [].concat(this.__rules)
+      );
+      factory.env = env;
       Object.getPrototypeOf(this).__envFactories[env] = factory;
       return factory;
     }
@@ -90,7 +93,6 @@ class WebpackFactory extends Factory {
     return Object.assign({}, this.__webpackConfig);
   }
 
-
   set(key, config) {
     this.__webpackConfig[key] = config;
     return this;
@@ -131,9 +133,7 @@ class WebpackFactory extends Factory {
         this.__plugins[plugin.alias] = plugin;
         return this;
       } else {
-        throw new Error(
-          `${args[0]} the plugin alias not exsit! `
-        );
+        throw new Error(`${args[0]} the plugin alias not exsit! `);
       }
     }
     if (args.length === 1 && args[0].constructor === Plugin) {
@@ -151,18 +151,21 @@ class WebpackFactory extends Factory {
     if (is.string(params)) {
       return this.__plugins[params];
     } else if (is.function(params)) {
-      return params(Object.values(this.__plugins));
+      for (const p of Object.values(this.__plugins)) {
+        if (params(p)) {
+          return p;
+        }
+      }
+      return null;
     } else {
-      throw new Error(
-        'get plugin param type exception!'
-      );
+      throw new Error('get plugin param type exception!');
     }
   }
 
   setPlugin(...args) {
     let pluginObj = {};
     if (args.length === 1 && args[0].constructor === Plugin) {
-      pluginObj = args[0];
+      [pluginObj] = args;
     } else {
       pluginObj = new Plugin(...args);
     }
@@ -183,9 +186,7 @@ class WebpackFactory extends Factory {
     } else if (is.function(filter)) {
       return filter(Object.values(definePlugins));
     } else {
-      throw new Error(
-        'use plugin param type exception!'
-      );
+      throw new Error('use plugin param type exception!');
     }
   }
 
@@ -197,17 +198,14 @@ class WebpackFactory extends Factory {
     this.__plugins = {};
   }
 
-
   addRule(...args) {
     if (args.length === 1 && !is.object(args[0])) {
       const alias = args[0];
       if (this.useRule(alias)) {
         this.__rules.push(this.useRule(alias));
         return this;
       } else {
-        throw new Error(
-          `${args[0]} the rule alias not exsit! `
-        );
+        throw new Error(`${args[0]} the rule alias not exsit! `);
       }
     }
 
@@ -223,28 +221,36 @@ class WebpackFactory extends Factory {
 
   getRule(params) {
     if (is.string(params)) {
-      return this.__rules.find(v => v.options.test.test(params) === true);
+      return this.__rules.find(
+        v => v.alias === params || v.options.test.test(params) === true
+      );
     } else if (is.function(params)) {
-      return params(this.__rules);
+      for (const rule of this.__rules) {
+        if (params(rule)) {
+          return rule;
+        }
+      }
+      return null;
     } else if (is.regexp(params)) {
-      return this.__rules.find(v => v.options.test.toString() === params.toString());
-    } else {
-      throw new Error(
-        'get rule param type exception!'
+      return this.__rules.find(
+        v => v.options.test.toString() === params.toString()
       );
+    } else {
+      throw new Error('get rule param type exception!');
     }
   }
 
-
   setRule(...args) {
     let ruleObj = {};
     if (args.length === 1 && args[0].constructor === Rule) {
-      ruleObj = args[0];
+      [ruleObj] = args;
     } else {
       ruleObj = new Rule(...args);
     }
 
-    let exsitRule = this.__rules.find(v => v.alias.toString() === ruleObj.alias.toString());
+    let exsitRule = this.__rules.find(
+      v => v.alias.toString() === ruleObj.alias.toString()
+    );
     if (exsitRule) {
       exsitRule = ruleObj;
     } else {
@@ -290,9 +296,9 @@ class WebpackFactory extends Factory {
     this.__rules = [];
   }
 
-
   defineLoader(name, resolve) {
-    Object.getPrototypeOf(this).__defineloaders[name] = resolve || require.resolve(name);
+    Object.getPrototypeOf(this).__defineloaders[name] =
+      resolve || require.resolve(name);
     return this;
   }
 

packages/beidou-webpack/test/lib/factory/plugin.test.js

@@ -0,0 +1,14 @@
+'use strict';
+
+const assert = require('assert');
+const Plugin = require('../../../lib/factory/plugin');
+describe('test/lib/factory/plugin.test.js', () => {
+  it('init plugin error', () => {
+    assert.throws(
+      function () {
+        new Plugin()
+      },
+      Error
+    );
+  })
+})

packages/beidou-webpack/test/lib/factory/rule.test.js

@@ -0,0 +1,22 @@
+'use strict';
+
+const assert = require('assert');
+const Rule = require('../../../lib/factory/rule');
+describe('test/lib/factory/rule.test.js', () => {
+  it('init rule error', () => {
+    assert.throws(
+      function () {
+        new Rule()
+      },
+      Error
+    );
+  })
+
+  it('init rule error', () => {
+    const ruleObj = new Rule({
+      test:'js'
+    })
+    assert(ruleObj,'init rule error');
+    assert(ruleObj.init().test === 'js','get rule options error')
+  })
+})