fix: 更新文档

justquanyin · justquanyin · commit e5354d6642ec · 2018-12-13T19:05:18.000+08:00
diff --git a/packages/beidou-webpack/README-ZH.md b/packages/beidou-webpack/README-ZH.md
@@ -189,6 +189,26 @@ module.exports = (app, defaultConfig, dev, target) => {
 };
 ```
 
+> Class Plugin Struct
+```
+class Plugin {
+  object ,      // instance object for webpack plugin
+  class,        // class for webpack plugin
+  opitons,      // initialize config
+  alias
+}
+
+```
+
+> Class Rule Struct
+```
+class Rule {
+  opitons,      // initialize config for rule
+  alias
+}
+
+```
+
 > app.webpackFactory 提供的函数如下:
 
 ### 重置配置项: reset(value)
@@ -213,106 +233,99 @@ module.exports = (app, defaultConfig, dev, target) => {
 #### return
 * {*}
 
-### 获取{param}配置实例:  env(param) 
+### 获取{key}配置实例:  env(key) 
 ####  Parameters
-* param {String} 配置实例标识
+* key {String} 配置实例标识
 
 #### return
 * {Object}
 
 ### 获取webpack配置: getConfig() 
 ####  Parameters
-* key {String}
 
 #### return
-* value {*}
+* {Object}
 
 
-### 增加插件配置: addPlugin(params1, params2,params3) 
+### 增加插件配置: addPlugin(args, options,alias) 
 #### Parameters
-* params1 {Object|Class|String} 插件实例|构造函数|已定义的插件名
-* [params1] {Object} 插件配置项
-* [params2] {String} 插件别名
+* args {Object|Class|String} 插件实例|构造函数|已定义的插件名
+* [options] {Object} 插件配置项
+* [alias] {String} 插件别名
 
 #### return
 * this
 
 
-### getPlugin(params1) 获取插件配置
+### getPlugin(filter) 获取插件配置
 #### Parameters
-* params1 {String|Function} 别名|自定义函数
+* filter {String|Function} 别名|自定义函数
 
 #### return
-* {Object}
+* {Plugin}
 
-### 设置插件配置: setPlugin(params1, params2,params3) 
+### 设置插件配置: setPlugin(args, options,alias) 
 
 #### Parameter
-* params1 {Object|Class}  插件实例|构造函数
-* [params1] {Object} 插件配置项
-* [params2] {String} 插件别名
+* args {Object|Class}  插件实例|构造函数
+* [options] {Object} 插件配置项
+* [alias] {String} 插件别名
 
 #### return 
 * this
 
-### 定义插件: definePlugin(params1, params2,params3)
+### 定义插件: definePlugin(args, options,alias)
 #### Parameters
-* params1 {Object|Class}  插件实例|构造函数
-* [params1] {Object} 插件配置项
-* [params2] {String} 插件别名
+* args {Object|Class}  插件实例|构造函数
+* [options] {Object} 插件配置项
+* [alias] {String} 插件别名
 #### return
 * this
 
-### 获取定义的插件: usePlugin(params1)
+### 获取定义的插件: usePlugin(alias)
 #### Parameters
-* params1 {String}  插件别名
+* alias {String}  插件别名
 #### return
-* {Object}
+* {Plugin}
 
-### 增加配置规则: addRule(params1,params2)
-#### Parameters
-* params1 {Object}  配置项
-* [params2] {String} 别名
-#### return
-* this
 
-### 设置配置规则: addRule(params1,params2)
+### 设置配置规则: addRule(options,alias)
 #### Parameters
-* params1 {Object}  配置项
-* [params2] {String} 别名
+* options {Object}  配置项
+* [alias] {String} 别名
 #### return
 * this
 
-### 获取配置规则: getRule(params1)
+### 获取配置规则: getRule(filter)
 #### Parameters
-* params1 {String|Function}  配置项|自定义函数
+* filter {String|Function}  配置项|自定义函数
 #### return
-* {Object}
+* {Rule}
 
-### 定义配置规则: defineRule(params1,params2)
+### 定义配置规则: defineRule(options,alias)
 #### Parameters
-* params1 {Object}  配置项
-* [params2] {String} 别名
+* options {Object}  配置项
+* [alias] {String} 别名
 #### return
 * this
 
-### 获取定义的配置规则: usePlugin(params1)
+### 获取定义的配置规则: useRule(alias)
 #### Parameters
-* params1 {String} 别名
+* alias {String} 别名
 
 #### return
-* {Object}
+* {Rule}
 
-### 定义Loader: defineLoader(params1,params2)
+### 定义Loader: defineLoader(alias,loader)
 #### Parameters
-* params1 {String}  别名
-* [params2] {String} 路径,默认值为 require.resolve(params1)
+* alias {String}  别名
+* [loader] {String} 路径,默认值为 require.resolve(params1)
 #### return
 * this
 
-### 获取定义Loader: useLoader(params1)
+### 获取定义Loader: useLoader(alias)
 #### Parameters
-* params1 {String}  别名
+* alias {String}  别名
 #### return
 * {path}
 
diff --git a/packages/beidou-webpack/README.md b/packages/beidou-webpack/README.md
@@ -190,8 +190,27 @@ module.exports = (app, defaultConfig, dev, target) => {
   return factory.getConfig(); // return the final config for webpack
 
 };
+
+```
+> Class Plugin Struct
 ```
+class Plugin {
+  object ,      // instance object for webpack plugin
+  class,        // class for webpack plugin
+  opitons,      // initialize config
+  alias
+}
 
+```
+
+> Class Rule Struct
+```
+class Rule {
+  opitons,      // initialize config for rule
+  alias
+}
+
+```
 > app.webpackFactory methods list:
 
 ### reset(value)
@@ -216,108 +235,100 @@ module.exports = (app, defaultConfig, dev, target) => {
 #### return
 * {*}
 
-### generate {param} factory for webpack:  env(param) 
+### generate {key} factory for webpack:  env(key) 
 ####  Parameters
-* param {String} factory flag
+* key {String} factory flag
 
 #### return
 * {Object}
 
 ### Get the final config for webpack : getConfig() 
 ####  Parameters
-* key {String}
-
 #### return
-* value {*}
+*  {Object}
 
 
-### addPlugin(params1, params2,params3) 
+### addPlugin(args, options,alias) 
 #### Parameters
-* params1 {Object|Class|String} 插件实例|构造函数|已定义的插件名
-* [params1] {Object} 插件配置项
-* [params2] {String} 插件别名
+* args {Object|Class|String} 
+* [options] {Object} 
+* [alias] {String} 
 
 #### return
 * this
 
 
-### getPlugin(params1)
+### getPlugin(filter) 
 #### Parameters
-* params1 {String|Function} 
+* filter {String|Function}
 
 #### return
-* {Object}
+* {Plugin}
 
-### 设置插件配置: setPlugin(params1, params2,params3) 
+### setPlugin(args, options,alias) 
 
 #### Parameter
-* params1 {Object|Class} 
-* [params1] {Object}
-* [params2] {String}
+* args {Object|Class}  
+* [options] {Object}
+* [alias] {String} 
 
 #### return 
 * this
 
-###  definePlugin(params1, params2,params3)
+###  definePlugin(args, options,alias)
 #### Parameters
-* params1 {Object|Class} 
-* [params1] {Object} 
-* [params2] {String} 
+* args {Object|Class}  
+* [options] {Object} 
+* [alias] {String} 
 #### return
 * this
 
-###  usePlugin(params1)
+###  usePlugin(alias)
 #### Parameters
-* params1 {String}  
+* alias {String}
 #### return
-* {Object}
+* {Plugin}
 
-###  addRule(params1,params2)
-#### Parameters
-* params1 {Object}  
-* [params2] {String} 
-#### return
-* this
 
-###  addRule(params1,params2)
+###  addRule(options,alias)
 #### Parameters
-* params1 {Object}  
-* [params2] {String}
+* options {Object} 
+* [alias] {String} 
 #### return
 * this
 
-###  getRule(params1)
+###  getRule(filter)
 #### Parameters
-* params1 {String|Function}  
+* filter {String|Function}  
 #### return
-* {Object}
+* {Rule}
 
-###  defineRule(params1,params2)
+### defineRule(options,alias)
 #### Parameters
-* params1 {Object}
-* [params2] {String}
+* options {Object}
+* [alias] {String}
 #### return
 * this
 
-###  usePlugin(params1)
+###  useRule(alias)
 #### Parameters
-* params1 {String} 
+* alias {String} 
 
 #### return
-* {Object}
+* {Rule}
 
-###  defineLoader(params1,params2)
+###  defineLoader(alias,loader)
 #### Parameters
-* params1 {String} 
-* [params2] {String} 
+* alias {String} 
+* [loader] {String} 
 #### return
 * this
 
-###  useLoader(params1)
+###  useLoader(alias)
 #### Parameters
-* params1 {String}  
+* alias {String}  
 #### return
-* {path}
+* {String}
 
 
 
diff --git a/packages/beidou-webpack/lib/factory/webpack.js b/packages/beidou-webpack/lib/factory/webpack.js
