@autobest-ui/scripts 1.5.8-alpha.0 → 1.5.9-alpha.0

package/README.md

@@ -51,49 +51,33 @@ module.exports = function(
 #### app.config.js 介绍
 
 ##### start 配置参数说明(作用于`react-spa start` 或者 `react-ssr start`)
-|  参数名   | 说明  |
-|  ----  | ----  |
-| startEntry  | start入口文件 |
-| startDefaultPort  | start默认端口号， 可自定义，下面介绍 |
-| startOpenPath  | start 打开浏览器的路径 |
-| startOutput.publicPath  | start加载资源的路径 |
-| startOutput.path  | start 资源根路径 |
-| getStartEnvConfig  | start 自定义环境变量的方法，会追加到process.env中 |
+|  参数名   | 默认值  | 说明  |
+|  ----  |------| ----  |
+| startDefaultPort | 3030 | start默认端口号， 可自定义，下面介绍                 |
+| startOpenPath  | '/'  |  start 打开浏览器的路径                   |
+| getStartEnvConfig  | {}   | start 自定义环境变量的方法，会追加到process.env中 |
 
 ##### hot ssr 配置参数说明(作用于`react-ssr ssr`)
-|  参数名   | 说明  |
-|  ----  | ----  |
-| hotSsrClientEntry  | hot ssr 客户端入口文件 |
-| hotSsrServerEntry  | hot ssr 服务端入口文件 |
-| hotSsrDefaultPort  | hot ssr默认端口号， 可自定义，下面介绍 |
-| hotSsrOpenPath  | hot ssr 打开浏览器的路径 |
-| hotSsrRunPath  | hot ssr 执行nodejs 入口文件路径 |
-| hotSsrWatch  | hot ssr 需要watch的文件夹，类型： Array |
-| hotSsrClientOutput.publicPath  | hot ssr客户端加载资源的路径 |
-| hotSsrClientOutput.path  | hot ssr 客户端资源根路径 |
-| hotSsrServerOutput.publicPath  | hot ssr 服务端加载资源的路径 |
-| hotSsrServerOutput.path  | hot ssr 服务端资源根路径 |
-| getHotSsrEnvConfig  | hot ssr 自定义环境变量的方法，会追加到process.env中 |
-
-##### hot ssr 配置参数说明(作用于`react-ssr build`)
-|  参数名   | 说明  |
-|  ----  | ----  |
-| buildClientEntry  | build ssr 客户端入口文件 |
-| buildServerEntry  | build ssr 客户端入口文件 |
-| buildClientOutput.publicPath  | build ssr客户端加载资源的路径 |
-| buildClientOutput.path  | build ssr 客户端资源根路径 |
-| buildServerOutput.publicPath  | build ssr 服务端加载资源的路径 |
-| buildServerOutput.path  | build ssr 服务端资源根路径 |
-| getBuildEnvConfig  | build ssr 自定义环境变量的方法，会追加到process.env中 |
-| buildClientLoadableConfig.filename  | build ssr 自定义按需加载路径存储库文件名 |
-| buildClientLoadableConfig.writeToDiskFilename  | build ssr 自定义按需加载路径存储库文件存放位置 |
+|  参数名  | 默认值                            | 说明  |
+|  ---- |--------------------------------| ----  |
+| hotSsrDefaultPort  | 9090                           | hot ssr默认端口号， 可自定义，下面介绍       |
+| hotSsrOpenPath  | '/'                            | hot ssr 打开浏览器的路径              |
+| hotSsrRunPath  | 'server/app.ts'                | hot ssr 执行nodejs 入口文件路径       |
+| hotSsrWatch  |['devPublic', 'devBuild', 'server']|  hot ssr 需要watch的文件夹，类型： Array |
+| getHotSsrEnvConfig | {}                             | hot ssr 自定义环境变量的方法，会追加到process.env中 |
+
+##### build ssr 配置参数说明(作用于`react-ssr build`)
+|  参数名  | 默认值                   | 说明  |
+|  ----  |-----------------------| ----  |
+| getBuildEnvConfig  | {}                    | build ssr 自定义环境变量的方法，会追加到process.env中 |
+| buildClientLoadableConfig.filename | 'loadable-stats.json' | build ssr 自定义按需加载路径存储库文件名             |
+| buildClientLoadableConfig.writeToDiskFilename  | '/build'              | build ssr 自定义按需加载路径存储库文件存放位置 |
 
 ##### 公共配置
-| 参数名                | 说明   |
-|--------------------|------|
-| htmlPluginTemplate | client端，模板html路径 |
-| htmlPluginFavicon  | client端，favicon.ico路径，也可以通过nginx配置 |
-| alias              | debug, build 下文件别名，同webpack.resolve.alias一样 |
+| 参数名     | 默认值           | 说明   |
+|----------|---------------|------|
+| htmlPluginTemplate | '/index.html' | client端，模板html路径                   |
+| htmlPluginFavicon  | undefined      |  client端，favicon.ico路径，也可以通过nginx配置 |
 
 ## 自定义
 

package/common/appConfig.js

@@ -18,10 +18,34 @@ const configPath = getProjectPath('/config/app.config.js');
 
 const config = require(configPath);
 
-module.exports = {
+// 默认配置信息
+const defaultConfig = {
   projectName: pkgInfo.name,
   projectVersion: pkgInfo.version,
+  // start默认配置
   startDefaultPort: 3030,
-  startEntry: '/src/index.tsx',
+  startOpenPath: '/',
+  getStartEnvConfig: () => ({}),
+
+  // hot ssr默认配置
+  hotSsrDefaultPort: 9090,
+  hotSsrOpenPath: '/',
+  hotSsrRunPath: 'server/app.ts',
+  hotSsrWatch: ['devPublic', 'devBuild', 'server'],
+  getHotSsrEnvConfig: () => ({}),
+
+  // build默认配置
+  getBuildEnvConfig: () => ({}),
+  // build ssr默认配置
+  buildClientLoadableConfig: {
+    filename: 'loadable-stats.json',
+    writeToDiskFilename: '/build'
+  },
+  // html模板
+  htmlPluginTemplate: '/index.html'
+};
+
+module.exports = {
+  ...defaultConfig,
   ...config
 };

package/common/webpack.common.js

@@ -212,8 +212,6 @@ module.exports = (appConfig, extendEnv, { isProd, isServer, isHotServer }) => {
       ]
     },
     resolve: {
-      // 设置路径别名
-      alias: appConfig.alias,
       // 文件后缀自动补全
       extensions: ['.tsx', '.ts', '.js', 'scss', 'css']
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@autobest-ui/scripts",
-  "version": "1.5.8-alpha.0",
+  "version": "1.5.9-alpha.0",
   "private": false,
   "description": "utils for project tools",
   "bin": {
@@ -92,5 +92,5 @@
     "webpack-merge": "5.8.0",
     "webpack-node-externals": "3.0.0"
   },
-  "gitHead": "1b1ba4a8f8af498939924fd6b6d09f84e41cbaf6"
+  "gitHead": "07a247ee99eeaa695b13bddf4051f7a433975115"
 }

package/spaConfig/webpack.dev.js

@@ -8,10 +8,10 @@ const HOST = process.env.HOST || ip.address() || 'localhost';
 
 module.exports = function (appConfig, extendEnv) {
   return merge(baseConfig(false, appConfig, extendEnv), {
-    entry: getProjectPath(appConfig.startEntry),
+    entry: getProjectPath('/src/index.tsx'),
     output: {
-      publicPath: appConfig.startOutput.publicPath || '/',
-      path: appConfig.startOutput.path,
+      publicPath: '/',
+      path: '/dist',
       pathinfo: true,
       filename: '[name].js',
       chunkFilename: '[name].chunk.js'

package/spaConfig/webpack.prod.js

@@ -5,16 +5,13 @@ const { getProjectPath, deleteFolders } = require('../common/utils');
 const baseConfig = require('./webpack.base');
 
 module.exports = function (appConfig, extendEnv) {
-  const outputPath = getProjectPath(appConfig.buildOutput.path);
-  deleteFolders(outputPath);
-
-  return merge(baseConfig(true, appConfig, extendEnv), {
+  const result = merge(baseConfig(true, appConfig, extendEnv), {
     // 打包的入口文件
-    entry: getProjectPath(appConfig.buildEntry),
+    entry: getProjectPath('/src/index.tsx'),
     // 打包的出口
     output: {
-      publicPath: appConfig.buildOutput.publicPath || '/',
-      path: outputPath,
+      publicPath: '/',
+      path: '/build',
       // 入口文件生产的js
       filename: `js/[name].chunk.js?v=${extendEnv.version}`,
       // 非入口文件生产的js
@@ -80,4 +77,9 @@ module.exports = function (appConfig, extendEnv) {
       }
     }
   });
+
+  const outputPath = getProjectPath(result.output.path);
+  deleteFolders(outputPath);
+
+  return result;
 };

package/ssrConfig/build.js

@@ -2,7 +2,6 @@ const webpack = require('webpack');
 const chalk = require('chalk');
 const appConfig = require('../common/appConfig');
 const { runCallback } = require('../common/build');
-const { getProjectPath, deleteFolders } = require('../common/utils');
 const getEnvironmentInfo = require('../common/extendEnv');
 const clientConfigFactory = require('./webpack.prod.client');
 const serverConfigFactory = require('./webpack.prod.server');
@@ -18,12 +17,6 @@ process.on('unhandledRejection', err => {
 const extendEnv = getEnvironmentInfo();
 
 function build() {
-  const buildClientOutput = getProjectPath(appConfig.buildClientOutput.path);
-  deleteFolders(buildClientOutput);
-
-  const buildServerOutput = getProjectPath(appConfig.buildServerOutput.path);
-  deleteFolders(buildServerOutput);
-
   const clientConfig = clientConfigFactory(appConfig, extendEnv);
   const serverConfig = serverConfigFactory(appConfig, extendEnv);
   // eslint-disable-next-line no-console

package/ssrConfig/webpack.base.js

@@ -13,7 +13,7 @@ module.exports = (appConfig, extendEnv, { isServer, isHotServer, isProd }) => {
     result.plugins.push(
       new MiniCssExtractPlugin({
         // filename: isHotServer ? 'css/[name].css' : `css/[name].css?v=${env.version}`,
-        // 采用AMP 直接 把css 填充到html
+        // 采用AMP直接把css填充到html
         filename: isHotServer ? 'css/[name].css' : 'css/[name][contenthash:8].css'
       })
     );

package/ssrConfig/webpack.dev.client.js

@@ -12,7 +12,7 @@ module.exports = function (appConfig, extendEnv) {
     }),
     {
       // 入口文件
-      entry: getProjectPath(appConfig.hotSsrClientEntry),
+      entry: getProjectPath('/src/client-entry.tsx'),
       resolve: {
         fallback: {
           fs: false
@@ -21,8 +21,8 @@ module.exports = function (appConfig, extendEnv) {
       // 输出信息
       output: {
         // 输出文件路径
-        path: getProjectPath(appConfig.hotSsrClientOutput.path),
-        publicPath: appConfig.hotSsrClientOutput.publicPath || '/',
+        path: getProjectPath('/devPublic'),
+        publicPath: '/',
         filename: 'js/[name].js',
         chunkFilename: 'js/[name].js'
       },

package/ssrConfig/webpack.dev.js

@@ -15,10 +15,10 @@ module.exports = function (appConfig, extendEnv) {
       isProd: false
     }),
     {
-      entry: getProjectPath(appConfig.startEntry),
+      entry: getProjectPath('/src/index.tsx'),
       output: {
-        publicPath: appConfig.startOutput.publicPath || '/',
-        path: appConfig.startOutput.path,
+        publicPath: '/',
+        path: '/dist',
         pathinfo: true,
         filename: '[name].js',
         chunkFilename: '[name].chunk.js'

package/ssrConfig/webpack.dev.server.js

@@ -20,11 +20,11 @@ module.exports = function (appConfig, extendEnv) {
         allowlist: /\.(js|css|less|scss|png|jpg|jpeg)$/
       }),
       // 入口文件
-      entry: getProjectPath(appConfig.hotSsrServerEntry),
+      entry: getProjectPath('/src/serverEntry/index.tsx'),
       // 输出信息
       output: {
-        path: getProjectPath(appConfig.hotSsrServerOutput.path),
-        publicPath: appConfig.hotSsrServerOutput.publicPath || '/',
+        path: getProjectPath('/devBuild'),
+        publicPath: '/',
         // 输出文件名
         filename: 'bundle.js',
         libraryTarget: 'commonjs2'

package/ssrConfig/webpack.prod.client.js

@@ -2,22 +2,22 @@ const { merge } = require('webpack-merge');
 const LoadablePlugin = require('@loadable/webpack-plugin');
 const TerserPlugin = require('terser-webpack-plugin');
 const CssMinimizerPlugin = require('css-minimizer-webpack-plugin');
-const { getProjectPath } = require('../common/utils');
+const { getProjectPath, deleteFolders } = require('../common/utils');
 const baseConfig = require('./webpack.base');
 
 module.exports = function (appConfig, extendEnv) {
-  return merge(
+  const result = merge(
     baseConfig(appConfig, extendEnv, {
       isServer: false,
       isHotServer: false,
       isProd: true
     }),
     {
-      entry: getProjectPath(appConfig.buildClientEntry),
+      entry: getProjectPath('/src/client-entry.tsx'),
       // 打包的出口
       output: {
-        path: getProjectPath(appConfig.buildClientOutput.path),
-        publicPath: appConfig.buildClientOutput.publicPath || '/',
+        path: getProjectPath('/build'),
+        publicPath: '/',
         // 入口文件生产的js
         filename: `js/[name].js?v=${extendEnv.version}`,
         // 非入口文件生产的js
@@ -91,4 +91,8 @@ module.exports = function (appConfig, extendEnv) {
       }
     }
   );
+
+  const buildClientOutput = getProjectPath(result.output.path);
+  deleteFolders(buildClientOutput);
+  return result;
 };

package/ssrConfig/webpack.prod.server.js

@@ -1,10 +1,10 @@
 const nodeExternals = require('webpack-node-externals');
 const { merge } = require('webpack-merge');
-const { getProjectPath } = require('../common/utils');
+const { getProjectPath, deleteFolders } = require('../common/utils');
 const baseConfig = require('./webpack.base');
 
 module.exports = function (appConfig, extendEnv) {
-  return merge(
+  const result = merge(
     baseConfig(appConfig, extendEnv, {
       isServer: true,
       isHotServer: false,
@@ -12,10 +12,10 @@ module.exports = function (appConfig, extendEnv) {
     }),
     {
       target: 'node',
-      entry: getProjectPath(appConfig.buildServerEntry),
+      entry: getProjectPath('/src/serverEntry/index.tsx'),
       output: {
-        path: getProjectPath(appConfig.buildServerOutput.path),
-        publicPath: appConfig.buildServerOutput.publicPath || '/',
+        path: getProjectPath('/build'),
+        publicPath: '/',
         filename: 'server-bundle.js',
         libraryTarget: 'commonjs2',
         chunkFilename: 'js/[name].[chunkhash].js'
@@ -43,4 +43,9 @@ module.exports = function (appConfig, extendEnv) {
       })
     }
   );
+
+  const buildServerOutput = getProjectPath(result.output.path);
+  deleteFolders(buildServerOutput);
+
+  return result;
 };