调整说明，并升级依赖

Author: PatternDirClean

PDWebpack/cofig/conf.js

@@ -1,4 +1,5 @@
 /** 框架配置
+ *
  * @version 0.0.1
  * @since PDWebpack 0.0.1
  */

PDWebpack/cofig/pathConf.js

@@ -1,3 +1,5 @@
+/* 路径常量 */
+
 /** 项目根目录
  * @author fybug
  * @since PDWebpack 0.0.1

PDWebpack/cofig/plugins/HtmlWebpackPlugin.js

@@ -1,7 +1,4 @@
 /** HtmlWebpackPlugin 基础基础
- *
- * 作为 HtmlWebpackPlugin 导入页面时使用的配置基础对象
- * 在后续处理中会基于该配置对象克隆并追加或修改配置项
  *
  * @author fybug
  * @version 0.0.1

PDWebpack/cofig/plugins/ScriptExtHtmlWebpackPlugin.js

@@ -1,4 +1,9 @@
-/** ScriptExtHtmlWebpackPlugin 基础配置对象 */
+/** ScriptExtHtmlWebpackPlugin 基础配置对象
+ *
+ * @author fybug
+ * @version 0.0.1
+ * @since PDWebpack 0.0.1
+ */
 WebPackPlugins.ScriptExtHtmlWebpackPlugin = () => {
     return {sync: [], defer: [], async: []}
 };

PDWebpack/cofig/plugins/pluginsload.js

@@ -1,4 +1,7 @@
 /** webpack 插件配置对象
+ *
+ * 作为对应 webpack 模块 的配置模版存储对象。配置模版也叫 基础配置<br/>
+ * 在使用的时候会 克隆 基础配置对象，并追加或修改配置项
  *
  * @author fybug
  * @version 0.0.1

PDWebpack/cofig/webpack/conf.js

@@ -1,6 +1,6 @@
-/** webpack 基础配置模版
+/** webpack 配置模版
  *
- * 该配置作为后续处理时的基础对象进行
+ * 该配置作为后续处理时的基础对象进行<br>
  * 后续处理时在此对象上追加或修改配置内容
  *
  * @author fybug

PDWebpack/lib/confToWebpack.js

@@ -1,6 +1,6 @@
 /** 框架配置转 webpack 配置工具
  *
- * 快捷读取 webpack 配置项对应的框架配置
+ * 读取对应的框架配置的配置项
  *
  * @author fybug
  * @version 0.0.1

PDWebpack/lib/confload/ConfigLoad.js

@@ -2,6 +2,7 @@
  *
  * 使用该模块可以快速加入需要的 webpack 配置
  *
+ * ```javascript 1.6
  * 示例
  * {
  *      // 传入基础 webpack 配置
@@ -22,6 +23,7 @@
  *      // 填充到 webpack 的配置中
  *      .__toConf();
  *  }
+ *  ```
  *
  * @author fybug
  * @version 0.0.1
@@ -79,7 +81,7 @@ global.ConfigLoad = class ConfigLoad {
     };
 
     /** 填充生成的配置到基础配置对象中
-     * @return 生成的配置对象
+     * @return 生成的 webpack 配置对象
      */
     __toConf() {
         this.configModeQuery.forEach((v) => {

PDWebpack/load/requireLib.js

@@ -1,7 +1,9 @@
+/* 导入外置依赖库 */
+
 global.merge = require('webpack-merge'); // 合并对象
 global.webpack = require('webpack'); // 核心
 global.CleanWebpackPlugin = require('clean-webpack-plugin'); // 清除缓存
 global.path = require('path'); // 路径库
 global.HtmlWebpackPlugin = require('html-webpack-plugin'); // Html 导入
 global.ScriptExtHtmlWebpackPlugin = require('script-ext-html-webpack-plugin'); // js 的加载方式
-global.MiniCssExtractPlugin = require('mini-css-extract-plugin'); // 单独提取 css
+global.MiniCssExtractPlugin = require('mini-css-extract-plugin'); // 单独提取 css

README.md

@@ -5,6 +5,8 @@
 
 基于 **webpack** 开发的框架，核心目的是为了增加 **webpack** 配置的可读性，方便后续的手脚架开发
 
+每一种类型的配置都会单独存放
+
 ## 目录结构：
 <pre>
 ┃
@@ -30,11 +32,13 @@
 ┗ webpack.prod.js     // webpack 生产配置
 </pre>
 
-> 框架使用方法请查看 wiki
+可通过 **WIKI** 学习原理和使用
+
+## 使用方法
+下载或 clone 本项目，直接解压作为项目文件夹然后按照下列提示即可
 
-# 使用
-直接解压作为项目文件夹然后按照下列提示即可
-> 配置完成后可以使用 package.json 中声明的 debug / bulic 命令运行 webpack
+**建议克隆 releases 分支，或者去发行版下载<br/>
+配置完成后可以使用 package.json 中声明的 debug / bulic 命令运行 webpack**
 
 需要先安装 **Node.js** ，自行百度
 
@@ -49,7 +53,9 @@ npm install webpack webpack-cli webpack-dev-server -g
 ```
 npm install --save-dev
 ```
-## 安装 **postcss**
+
+## 额外
+###安装 **postcss**
 ```
 npm install postcss-cli -g
 ```
@@ -62,11 +68,11 @@ postcss-nested
 ```
 > 不使用可以无视 
 
-# 参与
-一个人的力量是有限的，一个项目终究需要大家一起完善
-
-· fork 本仓库
+## 分支说明
+**dev-master**：当前的开发分支，不建议 clone 本分支
 
-· 新建 add_*** 分支 
+**releases**：当前发布分支，稳定版的源码
 
-· 提交等待合并
+## 提供bug反馈或建议
+- [码云Gitee](https://gitee.com/PatternDirClean/PDWebpack)
+- [Github](https://github.com/PatternDirClean/PDWebpack)