akfun 1.5.13 → 1.5.15

package/README.md

@@ -1,13 +1,14 @@
 # AKFun 前端脚手架
 > AKFun 是一个基于 Webpack4.0 和 rollup 的前端多场景打包工具，支持多种技术栈：Vue技术栈、React技术栈、React&TS技术栈
-- 技术栈：node/webpack4.0/rollup/express/babel/eslint/stylelint
+- 核心理念：提供完整&全面的前端工程能力，并尽可能屏蔽掉前端工程相关配置，让开发者更专注业务研发工作。
+- 技术栈：node/webpack4.0/rollup/babel/eslint/stylelint
 
 ## 特性
 - ⚡️ 零配置，开箱即用
 - 👏 支持Vue和React项目的调试和构建
 - 📤 支持单页面和多页面
-- 💪 提供三种构建场景: 本地开发调试模式(包含热更新、接口代理等功能)、构建生产环境代码、library库的构建(支持umd和esm的打包能力)
-- ❤️ 开放配置能力: 可配置构建入口文件、是否开启ESLint代码规范检测、接口代理配置等
+- 💪 提供三种构建场景: 本地开发模式(包含热更新、接口代理等功能)、生产环境代码构建、library库构建(支持umd和esm的打包能力)
+- ❤️ 开放配置能力: 可配置构建入口文件、开启ESLint代码检测、接口代理等
 - 👍 支持 [Autoprefixer](https://github.com/postcss/autoprefixer#readme)、[Sass](https://sass-lang.com/)、[PostCSS](https://postcss.org/)、[ESLint](http://eslint.cn/)、[StyleLint](https://stylelint.io/)
 - ❤️ 支持项目系统参数自动批量替换 [params-replace-loader](https://www.npmjs.com/package/params-replace-loader)
 - 😀 提供完整的Vue和React项目模板
@@ -245,7 +246,31 @@ module.exports = {
 }
 ```
 
-7. 项目源码环境变量批量替换
+7. 打包忽略node_modules配置项: ignoreNodeModules（默认为false）
+> 打包过程中，忽略node_modules中的依赖文件，不注入到bundle中，减少最后生成代码体积
+```bash
+module.exports = {
+  ...
+  webpack: {
+    ignoreNodeModules: true,
+  }
+  ...
+}
+```
+
+8. 是否生成ts声明文件配置项: createDeclaration（默认为false）
+> 构建ts项目中，可以选择是否生成ts声明文件
+```bash
+module.exports = {
+  ...
+  webpack: {
+    createDeclaration: true,
+  }
+  ...
+}
+```
+
+9. 项目源码环境变量批量替换
 > [关于params-replace-loader的使用方法](https://www.npmjs.com/package/params-replace-loader)
 ```bash
 module.exports = {
@@ -264,7 +289,7 @@ module.exports = {
 }
 ```
 
-7. 接口代理配置：目前只有dev本地开发调试模式下会启动
+10. 接口代理配置：目前只有dev本地开发调试模式下会启动
 > [关于proxyTable的配置方法](https://www.webpackjs.com/configuration/dev-server/#devserver-proxy)
 ```bash
 module.exports = {
@@ -277,7 +302,7 @@ module.exports = {
 }
 ```
 
-8、用于开启本地调试模式的相关配置信息
+11. 用于开启本地调试模式的相关配置信息
 ```bash
 module.exports = {
   ...
@@ -301,7 +326,7 @@ module.exports = {
 }
 ```
 
-9、用于构建生产环境代码的相关配置信息
+12. 用于构建生产环境代码的相关配置信息
 ```bash
 module.exports = {
   ...
@@ -319,7 +344,7 @@ module.exports = {
 }
 ```
 
-10、用于构建第三方功能包的配置（以umd格式输出）
+13. 用于构建第三方功能包的配置（以umd格式输出）
 ```bash
 module.exports = {
   ...
@@ -338,7 +363,7 @@ module.exports = {
 }
 ```
 
-11、用于构建esm格式的第三方功能包配置
+14. 用于构建esm格式的第三方功能包配置
 ```bash
 module.exports = {
   ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akfun",
-  "version": "1.5.13",
+  "version": "1.5.15",
   "description": "前端脚手架：支持Vue技术栈和react技术栈",
   "keywords": [
     "前端工程",
@@ -10,7 +10,7 @@
     "vue项目脚手架",
     "lib库构建工具"
   ],
-  "author": "ldan@wibetter",
+  "author": "wibetter",
   "license": "MIT",
   "bin": {
     "akfun": "./bin/akfun.js"
@@ -152,7 +152,8 @@
     "webpack-dev-middleware": "^3.7.2",
     "webpack-hot-middleware": "^2.25.0",
     "webpack-merge": "^4.2.2",
-    "yargs": "^12.0.2"
+    "yargs": "^12.0.2",
+    "webpack-node-externals": "^3.0.0"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",

package/src/config/index.js

@@ -7,7 +7,7 @@ const getConfigObj = require('../utils/getConfigObj');
 /** akfun脚手架赋予当前项目的默认配置
  * 备注：项目根目录的akfun.config.js的配置内容优先级高于defultAKFunConfig
  */
-const defultAKFunConfig = {
+const defaultAKFunConfig = {
   settings: {
     enableESLint: false, // 是否开启ESLint，默认开启ESLint检测代码格式
     enableESLintFix: false, // 是否ESLint自动修正代码格式
@@ -26,6 +26,8 @@ const defultAKFunConfig = {
         $utils: resolve('src/utils')
       }
     },
+    createDeclaration: false, // 打包时是否创建ts声明文件
+    ignoreNodeModules: false, // 打包时是否忽略 node_modules
     externals: [], // 从输出的 bundle 中排除依赖
     sassResources: []
   },
@@ -99,10 +101,10 @@ const defultAKFunConfig = {
 };
 
 // 从项目根目录获取当前项目的配置文件
-const curProjectConfg = getConfigObj(resolve('akfun.config.js'));
+const curProjectConfig = getConfigObj(resolve('akfun.config.js'));
 
-// module.exports = Object.assign(defultAKFunConfig, curProjectConfg);
+// module.exports = Object.assign(defaultAKFunConfig, curProjectConfig);
 
 const overwriteMerge = (destinationArray, sourceArray, options) => sourceArray;
 // 备注：数组类型则直接覆盖
-module.exports = deepMerge(defultAKFunConfig, curProjectConfg, { arrayMerge: overwriteMerge });
+module.exports = deepMerge(defaultAKFunConfig, curProjectConfig, { arrayMerge: overwriteMerge });

package/src/utils/getConfigObj.js

@@ -2,7 +2,7 @@ const glob = require('glob');
 
 const fileExists = function (fileDir) {
   let exists = false;
-  const files = glob.sync(fileDir);
+  const files = glob.sync(fileDir); // 同步读取本地文件
   if (files.length > 0) {
     exists = true;
   }

package/src/webpack/webpack.base.conf.js

@@ -28,7 +28,12 @@ const BannerPack = new webpack.BannerPlugin({
   entryOnly: true // 只在入口 chunks 文件中添加
 });
 
-module.exports = () => {
+/**
+ * webpack.base.conf.js
+ * 主要用于设置 rules 和 通用插件
+ */
+module.exports = (option) => {
+  const curEnvConfig = option || {}; // 用于接收当前运行环境配置变量
   const webpackConfig = {
     entry: config.webpack.entry,
     /*
@@ -66,8 +71,14 @@ module.exports = () => {
               options: babelConfig
             },
             {
-              loader: 'ts-loader'
-              // options: { configFile: path.resolve(__dirname, '../config/tsconfig.json') }
+              loader: 'ts-loader',
+              options: {
+                // configFile: path.resolve(__dirname, '../config/tsconfig.json')
+                compilerOptions: {
+                  declaration: config.webpack.createDeclaration || false,
+                  outDir: curEnvConfig.assetsRoot || './dist'
+                }
+              }
             }
           ],
           include: [resolve('src')],
@@ -135,7 +146,6 @@ module.exports = () => {
       new VueLoaderPlugin()
     ]
   };
-
   // 是否开启ESLint
   if (config.settings.enableESLint) {
     // ts类型

package/src/webpack/webpack.dev.conf.js

@@ -13,8 +13,9 @@ const entrys2htmlWebpackPlugin = require('../utils/entrys2htmlWebpackPlugin');
 const { isArray } = require('../utils/typeof');
 
 module.exports = () => {
+  const curEnvConfig = config.dev || {}; // 当前执行环境配置
   // 获取webpack基本配置
-  const baseWebpackConfig = getBaseWebpackConfig();
+  const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);
 
   // 获取页面模板地址
   let curHtmlTemplate = path.resolve(__dirname, '../initData/template/index.html');
@@ -23,21 +24,21 @@ module.exports = () => {
   }
 
   const webpackDevConfig = merge(baseWebpackConfig, {
-    mode: config.dev.NODE_ENV, // development模式，会启动NamedChunksPlugin、NamedModulesPlugin服务
+    mode: curEnvConfig.NODE_ENV, // development模式，会启动NamedChunksPlugin、NamedModulesPlugin服务
     output: {
-      publicPath: config.dev.assetsPublicPath // 引用地址：配置发布到线上资源的URL前缀
+      publicPath: curEnvConfig.assetsPublicPath // 引用地址：配置发布到线上资源的URL前缀
     },
     module: {
       rules: utils.styleLoaders({
-        sourceMap: config.dev.cssSourceMap,
+        sourceMap: curEnvConfig.cssSourceMap,
         environment: 'dev'
       })
     },
     // cheap-module-eval-source-map is faster for development
-    devtool: '#cheap-module-eval-source-map',
+    devtool: '#source-map', // '#cheap-module-eval-source-map',
     plugins: [
       new webpack.DefinePlugin({
-        'process.env.NODE_ENV': JSON.stringify(config.dev.NODE_ENV) // vue-router中根据此变量判断执行环境
+        'process.env.NODE_ENV': JSON.stringify(curEnvConfig.NODE_ENV) // vue-router中根据此变量判断执行环境
       }),
       // https://github.com/glenjamin/webpack-hot-middleware#installation--usage
       new webpack.HotModuleReplacementPlugin(),
@@ -48,8 +49,8 @@ module.exports = () => {
   });
 
   // 集成dev配置中的构建入口（优先级高于config.webpack.entry）
-  if (config.dev.entry) {
-    webpackDevConfig.entry = config.dev.entry; // 备注：会覆盖config.webpack.entry的配置
+  if (curEnvConfig.entry) {
+    webpackDevConfig.entry = curEnvConfig.entry; // 备注：会覆盖config.webpack.entry的配置
   }
 
   // 多页面多模板支持能力

package/src/webpack/webpack.library.conf.js

@@ -6,6 +6,7 @@ const CompressionWebpackPlugin = require('compression-webpack-plugin');
 const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPlugin;
 const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin');
 const ProgressBarPlugin = require('progress-bar-webpack-plugin');
+const nodeExternals = require('webpack-node-externals');
 
 const utils = require('./loaderUtils');
 // 引入当前项目配置文件
@@ -13,30 +14,33 @@ const config = require('../config/index');
 const getBaseWebpackConfig = require('./webpack.base.conf');
 
 module.exports = () => {
+  const curEnvConfig = config.build2lib || {}; // 当前执行环境配置
   // 获取webpack基本配置
-  const baseWebpackConfig = getBaseWebpackConfig();
+  const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);
 
   const webpackLibConfig = merge(baseWebpackConfig, {
-    mode: config.build2lib.NODE_ENV, // production 模式，会启动UglifyJsPlugin服务
+    mode: curEnvConfig.NODE_ENV, // production 模式，会启动UglifyJsPlugin服务
     output: {
-      path: config.build2lib.assetsRoot, // 输出文件的存放在本地的目录
+      path: curEnvConfig.assetsRoot, // 输出文件的存放在本地的目录
       filename: '[name].umd.js',
       publicPath: '',
-      library: config.build2lib.libraryName, // 指定类库名,主要用于直接引用的方式(比如使用script 标签)
+      library: curEnvConfig.libraryName, // 指定类库名,主要用于直接引用的方式(比如使用script 标签)
       globalObject: 'this', // 定义全局变量,兼容node和浏览器运行，避免出现"window is not defined"的情况
       libraryTarget: 'umd' // 定义打包方式Universal Module Definition,同时支持在CommonJS、AMD和全局变量使用
     },
     module: {
       rules: utils.styleLoaders({
-        sourceMap: config.build2lib.productionSourceMap,
+        sourceMap: curEnvConfig.productionSourceMap,
         environment: 'prod'
       })
     },
-    devtool: config.build2lib.productionSourceMap ? '#source-map' : false, // '#source-map': 源码，false：压缩代码
-    externals: config.webpack.externals,
+    devtool: curEnvConfig.productionSourceMap ? '#source-map' : false, // '#source-map': 源码，false：压缩代码
+    externals: config.webpack.ignoreNodeModules
+      ? [nodeExternals()].concat(config.webpack.externals)
+      : config.webpack.externals,
     plugins: [
       new webpack.DefinePlugin({
-        'process.env.NODE_ENV': JSON.stringify(config.build2lib.NODE_ENV)
+        'process.env.NODE_ENV': JSON.stringify(curEnvConfig.NODE_ENV)
       }),
       new MiniCssExtractPlugin({
         filename: utils.assetsPath('index.css'),
@@ -53,10 +57,10 @@ module.exports = () => {
   });
 
   // 是否开启Gzip
-  if (config.build2lib.productionGzip) {
+  if (curEnvConfig.productionGzip) {
     webpackLibConfig.plugins.push(
       new CompressionWebpackPlugin({
-        test: new RegExp(`\\.(${config.build2lib.productionGzipExtensions.join('|')})$`),
+        test: new RegExp(`\\.(${curEnvConfig.productionGzipExtensions.join('|')})$`),
         filename: '[path].gz[query]',
         algorithm: 'gzip',
         threshold: 240,
@@ -65,13 +69,13 @@ module.exports = () => {
     );
   }
 
-  if (config.build2lib.bundleAnalyzerReport) {
+  if (curEnvConfig.bundleAnalyzerReport) {
     webpackLibConfig.plugins.push(new BundleAnalyzerPlugin());
   }
 
   // 集成构建入口相关的配置
-  if (config.build2lib.entry) {
-    webpackLibConfig.entry = config.build2lib.entry; // 会覆盖config.webpack.entry的配置
+  if (curEnvConfig.entry) {
+    webpackLibConfig.entry = curEnvConfig.entry; // 会覆盖config.webpack.entry的配置
   }
 
   return webpackLibConfig;

package/src/webpack/webpack.prod.conf.js

@@ -10,6 +10,7 @@ const BundleAnalyzerPlugin = require('webpack-bundle-analyzer').BundleAnalyzerPl
 const CompressionWebpackPlugin = require('compression-webpack-plugin');
 const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin');
 const ProgressBarPlugin = require('progress-bar-webpack-plugin');
+const nodeExternals = require('webpack-node-externals');
 
 const utils = require('./loaderUtils');
 const { resolve } = require('../utils/pathUtils'); // 统一路径解析
@@ -21,8 +22,9 @@ const config = require('../config/index');
 const getBaseWebpackConfig = require('./webpack.base.conf');
 
 module.exports = () => {
+  const curEnvConfig = config.build || {}; // 当前执行环境配置
   // 获取webpack基本配置
-  const baseWebpackConfig = getBaseWebpackConfig();
+  const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);
   // 获取页面模板地址
   let curHtmlTemplate = path.resolve(__dirname, '../initData/template/index.html');
   if (config.webpack.template) {
@@ -30,21 +32,32 @@ module.exports = () => {
   }
 
   const webpackProdConfig = merge(baseWebpackConfig, {
-    mode: config.build2lib.NODE_ENV, // production 模式，会启动UglifyJsPlugin服务
+    mode: curEnvConfig.NODE_ENV, // production 模式，会启动UglifyJsPlugin服务
+    /*
+     内置变量列表：
+     id: chunk的唯一标识，从0开始；
+     name: chunk的名称；
+     hash: chunk的唯一标识的Hash值；
+     chunkhash: chunk内容的Hash值；
+     其中hash和chunkhash的长度是可以指定的，[hash:8]代表取8位的Hash值，默认是20位。
+     */
     output: {
-      path: config.build.assetsRoot, // 输出文件的存放在本地的目录
-      publicPath: config.build.assetsPublicPath, // 引用地址：配置发布到线上资源的URL前缀
+      path: curEnvConfig.assetsRoot, // 输出文件的存放在本地的目录
+      publicPath: curEnvConfig.assetsPublicPath, // 引用地址：配置发布到线上资源的URL前缀
       filename: utils.assetsPath('scripts/chunk/[name].[contenthash:8].js'),
       chunkFilename: utils.assetsPath('scripts/chunk/[name].[contenthash:8].js')
     },
     module: {
       rules: utils.styleLoaders({
-        sourceMap: config.build.productionSourceMap,
+        sourceMap: curEnvConfig.productionSourceMap,
         environment: 'prod'
       })
     },
+    externals: config.webpack.ignoreNodeModules
+      ? [nodeExternals()].concat(config.webpack.externals)
+      : config.webpack.externals,
     // devtool: '#cheap-module-eval-source-map', // 本地开发环境中的取值
-    devtool: config.build.productionSourceMap ? '#source-map' : false, // 线上开发环境中的取值
+    devtool: curEnvConfig.productionSourceMap ? '#source-map' : false, // 线上开发环境中的取值
     optimization: {
       splitChunks: {
         cacheGroups: {
@@ -67,7 +80,7 @@ module.exports = () => {
     plugins: [
       // http://vuejs.github.io/vue-loader/en/workflow/production.html
       new webpack.DefinePlugin({
-        'process.env.NODE_ENV': JSON.stringify(config.build.NODE_ENV) // vue-router中根据此变量判断执行环境
+        'process.env.NODE_ENV': JSON.stringify(curEnvConfig.NODE_ENV) // vue-router中根据此变量判断执行环境
       }),
       new MiniCssExtractPlugin({
         filename: utils.assetsPath('css/[name].[contenthash:8].css'),
@@ -94,9 +107,9 @@ module.exports = () => {
   });
 
   // 集成build配置中的构建入口
-  if (config.build.entry) {
+  if (curEnvConfig.entry) {
     // 会覆盖config.webpack.entry的配置
-    webpackProdConfig.entry = config.build.entry;
+    webpackProdConfig.entry = curEnvConfig.entry;
   }
 
   // 多页面支持能力
@@ -143,7 +156,7 @@ module.exports = () => {
         patterns: [
           {
             from: resolve('public'), // 从这里拷贝
-            to: config.build.assetsSubDirectory // 将根目录下的public内的资源复制到指定文件夹
+            to: curEnvConfig.assetsSubDirectory // 将根目录下的public内的资源复制到指定文件夹
           }
         ]
       })
@@ -151,10 +164,10 @@ module.exports = () => {
   }
 
   // 是否要进行压缩工作
-  if (config.build.productionGzip) {
+  if (curEnvConfig.productionGzip) {
     webpackProdConfig.plugins.push(
       new CompressionWebpackPlugin({
-        test: new RegExp(`\\.(${config.build.productionGzipExtensions.join('|')})$`),
+        test: new RegExp(`\\.(${curEnvConfig.productionGzipExtensions.join('|')})$`),
         filename: '[path].gz[query]',
         algorithm: 'gzip',
         threshold: 240,
@@ -163,7 +176,7 @@ module.exports = () => {
     );
   }
 
-  if (config.build.bundleAnalyzerReport) {
+  if (curEnvConfig.bundleAnalyzerReport) {
     webpackProdConfig.plugins.push(new BundleAnalyzerPlugin());
   }