akfun 1.5.15 → 1.5.19

package/README.md

@@ -270,7 +270,19 @@ module.exports = {
 }
 ```
 
-9. 项目源码环境变量批量替换
+9. 配置项目源码目录（工程有效目录范围）: projectDir
+> 构建项目中，设置生效的目录（可同时设置多个目录），用于提高前端工程执行效率。可以不配置，默认为['./src']
+```bash
+module.exports = {
+  ...
+  webpack: {
+    projectDir: ['./src'],
+  }
+  ...
+}
+```
+
+10. 项目源码环境变量批量替换
 > [关于params-replace-loader的使用方法](https://www.npmjs.com/package/params-replace-loader)
 ```bash
 module.exports = {
@@ -289,7 +301,7 @@ module.exports = {
 }
 ```
 
-10. 接口代理配置：目前只有dev本地开发调试模式下会启动
+11. 接口代理配置：目前只有dev本地开发调试模式下会启动
 > [关于proxyTable的配置方法](https://www.webpackjs.com/configuration/dev-server/#devserver-proxy)
 ```bash
 module.exports = {
@@ -302,7 +314,7 @@ module.exports = {
 }
 ```
 
-11. 用于开启本地调试模式的相关配置信息
+12. 用于开启本地调试模式的相关配置信息
 ```bash
 module.exports = {
   ...
@@ -326,7 +338,7 @@ module.exports = {
 }
 ```
 
-12. 用于构建生产环境代码的相关配置信息
+13. 用于构建生产环境代码的相关配置信息
 ```bash
 module.exports = {
   ...
@@ -344,7 +356,7 @@ module.exports = {
 }
 ```
 
-13. 用于构建第三方功能包的配置（以umd格式输出）
+14. 用于构建第三方功能包的配置（以umd格式输出）
 ```bash
 module.exports = {
   ...
@@ -363,7 +375,7 @@ module.exports = {
 }
 ```
 
-14. 用于构建esm格式的第三方功能包配置
+15. 用于构建esm格式的第三方功能包配置
 ```bash
 module.exports = {
   ...

package/module/index.js

@@ -137,7 +137,7 @@ let argv = yargs
         .alias('h', 'help');
     },
     (argv) => {
-      mainAction.build();
+      mainAction.build('prod');
     },
   )
   .command(

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "akfun",
-  "version": "1.5.15",
+  "version": "1.5.19",
   "description": "前端脚手架：支持Vue技术栈和react技术栈",
   "keywords": [
     "前端工程",
@@ -73,7 +73,6 @@
     "@rollup/plugin-node-resolve": "^9.0.0",
     "@typescript-eslint/eslint-plugin": "^3.9.0",
     "@typescript-eslint/parser": "^3.9.0",
-    "eslint-config-prettier": "^7.2.0",
     "@vue/compiler-sfc": "^3.0.0-rc.10",
     "@vue/eslint-config-typescript": "^5.0.2",
     "autoprefixer": "^9.8.0",
@@ -92,6 +91,7 @@
     "es6-promise-polyfill": "^1.2.0",
     "eslint": "^7.2.0",
     "eslint-config-airbnb-base": "^14.1.0",
+    "eslint-config-prettier": "^7.2.0",
     "eslint-friendly-formatter": "^4.0.1",
     "eslint-import-resolver-webpack": "^0.12.1",
     "eslint-loader": "^4.0.2",
@@ -112,6 +112,7 @@
     "http-proxy-middleware": "^1.0.4",
     "inquirer": "^7.3.3",
     "mini-css-extract-plugin": "^0.9.0",
+    "monaco-editor-webpack-plugin": "6.0.0",
     "node-sass": "^4.14.1",
     "opn": "^6.0.0",
     "optimize-css-assets-webpack-plugin": "^5.0.3",
@@ -152,8 +153,8 @@
     "webpack-dev-middleware": "^3.7.2",
     "webpack-hot-middleware": "^2.25.0",
     "webpack-merge": "^4.2.2",
-    "yargs": "^12.0.2",
-    "webpack-node-externals": "^3.0.0"
+    "webpack-node-externals": "^3.0.0",
+    "yargs": "^12.0.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",

package/src/build.js

@@ -4,10 +4,15 @@ const path = require('path');
 const chalk = require('chalk');
 const webpack = require('webpack');
 const checkVersion = require('./check-versions');
-const config = require('./config/index'); // 引入当前项目配置文件
+const projectConfig = require('./config/index'); // 引入当前项目配置文件
+const deepMergeConfig = require('./utils/deepMergeConfig');
 
 // 构建脚本：一般用于构建生产环境的代码
-module.exports = function (BuildType) {
+module.exports = function (BuildType, akfunConfig) {
+  let config = projectConfig; // 默认使用执行命令目录下的配置数据
+  if (akfunConfig) {
+    config = deepMergeConfig(defaultConfig, akfunConfig);
+  }
   // 检查当前npm版本号是否匹配
   checkVersion();
   const spinner = ora('[akfun]开启AKFun构建能力...').start();
@@ -16,10 +21,10 @@ module.exports = function (BuildType) {
   // 根据BuildType判断是否引用专用于第三方功能包的webpack配置
   if (BuildType && BuildType === 'lib') {
     spinner.start('[akfun]开始构建第三方功能包...');
-    webpackConfig = require('./webpack/webpack.library.conf')();
+    webpackConfig = require('./webpack/webpack.library.conf')(config);
   } else {
     spinner.start('[akfun]开始构建生产环境的代码...');
-    webpackConfig = require('./webpack/webpack.prod.conf')();
+    webpackConfig = require('./webpack/webpack.prod.conf')(config);
   }
 
   /**

package/src/config/default.config.js

@@ -0,0 +1,102 @@
+'use strict';
+// 统一路径解析：
+const { resolve } = require('../utils/pathUtils');
+
+/**
+ * akfun脚手架赋予当前项目的默认配置
+ */
+const defaultAKFunConfig = {
+  settings: {
+    enableESLint: false, // 是否开启ESLint，默认开启ESLint检测代码格式
+    enableESLintFix: false, // 是否ESLint自动修正代码格式
+    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
+    enableStyleLintFix: false // 是否需要StyleLint自动修正代码格式
+  },
+  webpack: {
+    resolve: {
+      // webpack的resolve配置
+      extensions: ['.js', '.jsx', '.ts', '.tsx', '.vue', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
+      alias: {
+        '@': resolve('src'),
+        $components: resolve('src/components'),
+        $pages: resolve('src/pages'),
+        $plugins: resolve('src/plugins'),
+        $utils: resolve('src/utils')
+      }
+    },
+    createDeclaration: false, // 打包时是否创建ts声明文件
+    ignoreNodeModules: false, // 打包时是否忽略 node_modules
+    externals: [], // 从输出的 bundle 中排除依赖
+    sassResources: []
+  },
+  envParams: {
+    // 项目系统环境变量
+    common: {
+      // 通用参数
+      '#version#': '20200810.1'
+    },
+    local: {
+      // 本地开发环境
+      '#dataApiBase#': 'http://localhost:1024', // 数据接口根地址
+      '#assetsPublicPath#': 'http://localhost:1024', // 静态资源根地址
+      '#routeBasePath#': '/' // 路由根地址
+    },
+    online: {
+      // 线上正式环境配置参数
+      '#dataApiBase#': '/', // 数据接口根地址 "//xxx.cn/"格式
+      '#assetsPublicPath#': '', // 静态资源根地址 "//xxx.cn/_spa/projectName"格式
+      '#routeBasePath#': '/' // 路由根地址 "/_spa/projectName/"格式
+    }
+  },
+  dev: {
+    // 用于开启本地调试模式的相关配置信息
+    NODE_ENV: 'development',
+    port: 80,
+    autoOpenBrowser: true,
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {},
+    /** CSS Sourcemaps off by default because relative paths are "buggy"
+     * with this option, according to the CSS-Loader README
+     * (https://github.com/webpack/css-loader#sourcemaps)
+     * In our experience, they generally work as expected,
+     * just be aware of this issue when enabling this option.
+     */
+    cssSourceMap: false
+  },
+  build: {
+    // 用于构建生产环境代码的相关配置信息
+    NODE_ENV: 'production', // production 模式，会启动UglifyJsPlugin服务
+    assetsRoot: resolve('dist'), // 编译完成的文件存放路径
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '', // 资源引用二级路径
+    productionSourceMap: false,
+    // Gzip off by default as many popular public hosts such as
+    // Surge or Netlify already gzip all public assets for you.
+    // Before setting to `true`, make sure to:
+    // npm install --save-dev compression-webpack-plugin
+    productionGzip: false,
+    productionGzipExtensions: ['js', 'css', 'json'],
+    // Run the build command with an extra argument to
+    // View the bundle analyzer report after build finishes:
+    // `npm run build --report`
+    // Set to `true` or `false` to always turn it on or off
+    bundleAnalyzerReport: false
+  },
+  build2lib: {
+    // 用于构建第三方功能包的配置文件
+    NODE_ENV: 'production',
+    libraryName: '', // 构建第三方功能包时最后导出的引用变量名
+    assetsRoot: resolve('dist'), // 编译完成的文件存放路径
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '', // 资源引用二级路径
+    productionSourceMap: false,
+    productionGzip: false,
+    productionGzipExtensions: ['js', 'css', 'json'],
+    bundleAnalyzerReport: false
+  }
+};
+
+// 备注：数组类型则直接覆盖
+module.exports = defaultAKFunConfig;

package/src/config/index.js

@@ -1,110 +1,15 @@
-'use strict';
-const deepMerge = require('deepmerge');
 // 统一路径解析：
 const { resolve } = require('../utils/pathUtils');
+const defaultAKFunConfig = require('./default.config');
 const getConfigObj = require('../utils/getConfigObj');
+const deepMergeConfig = require('../utils/deepMergeConfig');
 
 /** akfun脚手架赋予当前项目的默认配置
  * 备注：项目根目录的akfun.config.js的配置内容优先级高于defultAKFunConfig
  */
-const defaultAKFunConfig = {
-  settings: {
-    enableESLint: false, // 是否开启ESLint，默认开启ESLint检测代码格式
-    enableESLintFix: false, // 是否ESLint自动修正代码格式
-    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
-    enableStyleLintFix: false // 是否需要StyleLint自动修正代码格式
-  },
-  webpack: {
-    resolve: {
-      // webpack的resolve配置
-      extensions: ['.js', '.jsx', '.ts', '.tsx', '.vue', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
-      alias: {
-        '@': resolve('src'),
-        $components: resolve('src/components'),
-        $pages: resolve('src/pages'),
-        $plugins: resolve('src/plugins'),
-        $utils: resolve('src/utils')
-      }
-    },
-    createDeclaration: false, // 打包时是否创建ts声明文件
-    ignoreNodeModules: false, // 打包时是否忽略 node_modules
-    externals: [], // 从输出的 bundle 中排除依赖
-    sassResources: []
-  },
-  envParams: {
-    // 项目系统环境变量
-    common: {
-      // 通用参数
-      '#version#': '20200810.1'
-    },
-    local: {
-      // 本地开发环境
-      '#dataApiBase#': 'http://localhost:1024', // 数据接口根地址
-      '#assetsPublicPath#': 'http://localhost:1024', // 静态资源根地址
-      '#routeBasePath#': '/' // 路由根地址
-    },
-    online: {
-      // 线上正式环境配置参数
-      '#dataApiBase#': '/', // 数据接口根地址 "//xxx.cn/"格式
-      '#assetsPublicPath#': '', // 静态资源根地址 "//xxx.cn/_spa/projectName"格式
-      '#routeBasePath#': '/' // 路由根地址 "/_spa/projectName/"格式
-    }
-  },
-  dev: {
-    // 用于开启本地调试模式的相关配置信息
-    NODE_ENV: 'development',
-    port: 80,
-    autoOpenBrowser: true,
-    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
-    assetsSubDirectory: '',
-    hostname: 'localhost',
-    proxyTable: {},
-    /** CSS Sourcemaps off by default because relative paths are "buggy"
-     * with this option, according to the CSS-Loader README
-     * (https://github.com/webpack/css-loader#sourcemaps)
-     * In our experience, they generally work as expected,
-     * just be aware of this issue when enabling this option.
-     */
-    cssSourceMap: false
-  },
-  build: {
-    // 用于构建生产环境代码的相关配置信息
-    NODE_ENV: 'production', // production 模式，会启动UglifyJsPlugin服务
-    assetsRoot: resolve('dist'), // 编译完成的文件存放路径
-    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
-    assetsSubDirectory: '', // 资源引用二级路径
-    productionSourceMap: false,
-    // Gzip off by default as many popular public hosts such as
-    // Surge or Netlify already gzip all public assets for you.
-    // Before setting to `true`, make sure to:
-    // npm install --save-dev compression-webpack-plugin
-    productionGzip: false,
-    productionGzipExtensions: ['js', 'css', 'json'],
-    // Run the build command with an extra argument to
-    // View the bundle analyzer report after build finishes:
-    // `npm run build --report`
-    // Set to `true` or `false` to always turn it on or off
-    bundleAnalyzerReport: false
-  },
-  build2lib: {
-    // 用于构建第三方功能包的配置文件
-    NODE_ENV: 'production',
-    libraryName: '', // 构建第三方功能包时最后导出的引用变量名
-    assetsRoot: resolve('dist'), // 编译完成的文件存放路径
-    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
-    assetsSubDirectory: '', // 资源引用二级路径
-    productionSourceMap: false,
-    productionGzip: false,
-    productionGzipExtensions: ['js', 'css', 'json'],
-    bundleAnalyzerReport: false
-  }
-};
 
 // 从项目根目录获取当前项目的配置文件
 const curProjectConfig = getConfigObj(resolve('akfun.config.js'));
 
-// module.exports = Object.assign(defaultAKFunConfig, curProjectConfig);
-
-const overwriteMerge = (destinationArray, sourceArray, options) => sourceArray;
 // 备注：数组类型则直接覆盖
-module.exports = deepMerge(defaultAKFunConfig, curProjectConfig, { arrayMerge: overwriteMerge });
+module.exports = deepMergeConfig(defaultAKFunConfig, curProjectConfig);

package/src/dev-server.js

@@ -7,11 +7,17 @@ const checkVersion = require('./check-versions');
 const { createProxyMiddleware } = require('http-proxy-middleware');
 const { resolve } = require('./utils/pathUtils');
 // 引入当前项目配置文件
-const config = require('./config/index');
+const projectConfig = require('./config/index');
+const defaultConfig = require('./config/default.config');
 const getDevWebpackConfig = require('./webpack/webpack.dev.conf');
+const deepMergeConfig = require('./utils/deepMergeConfig');
 
 // 构建脚本：一般用于构建开发环境的代码（包含热更新、接口代理等功能）
-module.exports = function () {
+module.exports = function (akfunConfig) {
+  let config = projectConfig; // 默认使用执行命令目录下的配置数据
+  if (akfunConfig) {
+    config = deepMergeConfig(defaultConfig, akfunConfig);
+  }
   // 检查当前npm版本号是否匹配
   checkVersion();
   const spinner = ora('[akfun]开启调试模式...').start();
@@ -35,7 +41,7 @@ module.exports = function () {
   // 使用 express 启动一个服务
   const app = express();
   // 获取开发环境的webpack基本配置
-  const webpackConfig = getDevWebpackConfig();
+  const webpackConfig = getDevWebpackConfig(config);
   const compiler = webpack(webpackConfig); // 启动 webpack 进行编译
 
   // 启动 webpack-dev-middleware，将编译后的文件暂存到内存中

package/src/utils/deepMergeConfig.js

@@ -0,0 +1,9 @@
+const deepMerge = require('deepmerge');
+
+const deepMergeConfig = function (defaultConfig, curConfig) {
+  const overwriteMerge = (destinationArray, sourceArray, options) => sourceArray;
+  
+  return deepMerge(defaultConfig, curConfig, { arrayMerge: overwriteMerge });
+};
+
+module.exports = deepMergeConfig;

package/src/utils/getProjectDir.js

@@ -0,0 +1,16 @@
+const { resolveToCurrentRoot } = require('./pathUtils');
+const { isArray, isString } = require('../utils/typeof');
+
+module.exports = (_projectDir) => {
+  const curProjectDir = [];
+  if (!_projectDir) {
+    curProjectDir.push(resolveToCurrentRoot('./src'));
+  } else if (isArray(_projectDir)) {
+    _projectDir.forEach((dir) => {
+      curProjectDir.push(resolveToCurrentRoot(dir));
+    });
+  } else if (isString(_projectDir)) {
+    curProjectDir.push(resolveToCurrentRoot(_projectDir));
+  }
+  return curProjectDir;
+};

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

@@ -7,6 +7,7 @@ const utils = require('./loaderUtils');
 const vueLoaderConfig = require('./vue-loader.conf');
 const { resolve, resolveToCurrentRoot, catchCurPackageJson } = require('../utils/pathUtils');
 const getConfigObj = require('../utils/getConfigObj');
+const getProjectDir = require('../utils/getProjectDir');
 const catchVuePages = require('../utils/catchVuePages'); // 用于获取当前项目中的vue单文件
 // 引入当前项目配置文件
 const config = require('../config/index');
@@ -34,6 +35,8 @@ const BannerPack = new webpack.BannerPlugin({
  */
 module.exports = (option) => {
   const curEnvConfig = option || {}; // 用于接收当前运行环境配置变量
+  // 获取当前项目目录
+  const curProjectDir = getProjectDir(config.webpack.projectDir);
   const webpackConfig = {
     entry: config.webpack.entry,
     /*
@@ -81,7 +84,7 @@ module.exports = (option) => {
               }
             }
           ],
-          include: [resolve('src')],
+          include: curProjectDir, // [resolve('src')],
           exclude: /node_modules/
         },
         {
@@ -92,7 +95,7 @@ module.exports = (option) => {
               options: babelConfig
             }
           ],
-          include: [resolve('src')],
+          include: curProjectDir, // [resolve('src')],
           exclude: /node_modules/
         },
         {
@@ -134,7 +137,7 @@ module.exports = (option) => {
         {
           test: /\.(js|ts|tsx|jsx|vue|css|html)$/,
           loader: 'params-replace-loader',
-          include: [resolve('src')],
+          include: curProjectDir, // [resolve('src')],
           exclude: [/node_modules/, resolve('src/mock/data')], // 排除不需要进行校验的文件夹
           options: config.envParams
         }
@@ -153,7 +156,7 @@ module.exports = (option) => {
       test: /\.tsx?$/,
       loader: 'eslint-loader',
       enforce: 'pre',
-      include: [resolve('src')],
+      include: curProjectDir, // [resolve('src')],
       exclude: /node_modules/,
       options: {
         cache: true,
@@ -167,7 +170,7 @@ module.exports = (option) => {
       test: /\.jsx?$/,
       loader: 'eslint-loader',
       enforce: 'pre',
-      include: [resolve('src')],
+      include: curProjectDir, // [resolve('src')],
       exclude: /node_modules/,
       options: {
         cache: true, // the cache is written to the ./node_modules/.cache/eslint-loader director
@@ -181,7 +184,7 @@ module.exports = (option) => {
       test: /\.vue$/,
       loader: 'eslint-loader',
       enforce: 'pre',
-      include: [resolve('src')],
+      include: curProjectDir, // [resolve('src')],
       exclude: /node_modules/,
       options: {
         cache: true,

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

@@ -6,13 +6,14 @@ const FriendlyErrorsPlugin = require('friendly-errors-webpack-plugin');
 const ProgressBarPlugin = require('progress-bar-webpack-plugin');
 const utils = require('./loaderUtils');
 // 引入当前项目配置文件
-const config = require('../config/index');
+const projectConfig = require('../config/index');
 const getBaseWebpackConfig = require('./webpack.base.conf');
 const getJsEntries = require('../utils/jsEntries');
 const entrys2htmlWebpackPlugin = require('../utils/entrys2htmlWebpackPlugin');
 const { isArray } = require('../utils/typeof');
 
-module.exports = () => {
+module.exports = (akfunConfig) => {
+  let config = akfunConfig || projectConfig; // 默认使用执行命令目录下的配置数据
   const curEnvConfig = config.dev || {}; // 当前执行环境配置
   // 获取webpack基本配置
   const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);

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

@@ -10,10 +10,11 @@ const nodeExternals = require('webpack-node-externals');
 
 const utils = require('./loaderUtils');
 // 引入当前项目配置文件
-const config = require('../config/index');
+const projectConfig = require('../config/index');
 const getBaseWebpackConfig = require('./webpack.base.conf');
 
-module.exports = () => {
+module.exports = (akfunConfig) => {
+  let config = akfunConfig || projectConfig; // 默认使用执行命令目录下的配置数据
   const curEnvConfig = config.build2lib || {}; // 当前执行环境配置
   // 获取webpack基本配置
   const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);
@@ -43,7 +44,9 @@ module.exports = () => {
         'process.env.NODE_ENV': JSON.stringify(curEnvConfig.NODE_ENV)
       }),
       new MiniCssExtractPlugin({
-        filename: utils.assetsPath('index.css'),
+        // filename: utils.assetsPath('index.css'),
+        filename: "[name].css",
+        chunkFilename: "[id].css",
         ignoreOrder: false
       }),
       new OptimizeCSSPlugin({

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

@@ -11,6 +11,7 @@ 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 MonacoWebpackPlugin = require('monaco-editor-webpack-plugin');
 
 const utils = require('./loaderUtils');
 const { resolve } = require('../utils/pathUtils'); // 统一路径解析
@@ -18,10 +19,11 @@ const getJsEntries = require('../utils/jsEntries');
 const entrys2htmlWebpackPlugin = require('../utils/entrys2htmlWebpackPlugin');
 const { isArray } = require('../utils/typeof');
 // 引入当前项目配置文件
-const config = require('../config/index');
+const projectConfig = require('../config/index');
 const getBaseWebpackConfig = require('./webpack.base.conf');
 
-module.exports = () => {
+module.exports = (akfunConfig) => {
+  let config = akfunConfig || projectConfig; // 默认使用执行命令目录下的配置数据
   const curEnvConfig = config.build || {}; // 当前执行环境配置
   // 获取webpack基本配置
   const baseWebpackConfig = getBaseWebpackConfig(curEnvConfig);
@@ -175,6 +177,11 @@ module.exports = () => {
       })
     );
   }
+  
+  // 是否开启
+  if (curEnvConfig.openMonacoWebpackPlugin) {
+    webpackProdConfig.plugins.push(new MonacoWebpackPlugin());
+  }
 
   if (curEnvConfig.bundleAnalyzerReport) {
     webpackProdConfig.plugins.push(new BundleAnalyzerPlugin());