@qse/edu-scripts 1.12.0

package/src/config/webpackConfig.js

@@ -0,0 +1,410 @@
+const fs = require('fs')
+const webpack = require('webpack')
+const HtmlWebpackPlugin = require('html-webpack-plugin')
+const { BundleAnalyzerPlugin } = require('webpack-bundle-analyzer')
+const ReactRefreshPlugin = require('@pmmmwh/react-refresh-webpack-plugin')
+const paths = require('./paths')
+const TerserPlugin = require('terser-webpack-plugin')
+const CaseSensitivePathsPlugin = require('case-sensitive-paths-webpack-plugin')
+const appPkg = require(paths.package)
+const appConfig = require('../utils/appConfig')
+const { ESBuildMinifyPlugin } = require('esbuild-loader')
+
+const jsMainPath = appConfig.grayscale
+  ? `${appPkg.name}/beta/${appPkg.name}`
+  : `${appPkg.name}/${appPkg.name}`
+const assetPath = appConfig.grayscale
+  ? `${appPkg.name}/beta/${appPkg.version}`
+  : `${appPkg.name}/${appPkg.version}`
+
+const cssRegex = /\.css$/
+const cssModuleRegex = /\.module\.css$/
+const lessRegex = /\.less$/
+const lessModuleRegex = /\.module\.less$/
+
+const imageInlineSizeLimit = 10 * 1024
+
+const qsbCDN = (() => {
+  const contents = paths.indexHTML.map((url) => fs.readFileSync(url, 'utf-8'))
+  const isUseCommon = contents.some((content) => /react16.14.*_common31?.js/.test(content))
+  const isUseAxios = contents.some((content) => /react16.14.*_axios0.21.1/.test(content))
+  const isUseMoment = contents.some((content) => content.includes('moment2.29.1.js'))
+  const isUseAntd = contents.some((content) => content.includes('antd3.26.20.js'))
+
+  const isUse = isUseAntd || isUseCommon || isUseMoment || isUseAxios
+  return { isUse, isUseAntd, isUseCommon, isUseMoment, isUseAxios }
+})()
+
+/**
+ * @param {*} args
+ * @param {import('../utils/defineConfig').Config} override
+ */
+module.exports = function getWebpackConfig(args, override) {
+  const isDev = process.env.NODE_ENV === 'development'
+  const isProd = process.env.NODE_ENV === 'production'
+
+  // common function to get style loaders
+  const getStyleLoaders = (cssOptions, preProcessor) => {
+    const loaders = [
+      {
+        loader: 'style-loader',
+        options: { attributes: { 'data-module': appPkg.name, 'data-version': appPkg.version } },
+      },
+      {
+        loader: 'css-loader',
+        options: cssOptions,
+      },
+      {
+        // Options for PostCSS as we reference these options twice
+        // Adds vendor prefixing based on your specified browser support in
+        // package.json
+        loader: 'postcss-loader',
+        options: {
+          postcssOptions: {
+            // Necessary for external CSS imports to work
+            // https://github.com/facebook/create-react-app/issues/2677
+            ident: 'postcss',
+            config: false,
+            plugins: [
+              isProd && require('cssnano')({ preset: 'default' }),
+              fs.existsSync(paths.tailwind) && 'tailwindcss',
+              'postcss-flexbugs-fixes',
+              [
+                'postcss-preset-env',
+                {
+                  autoprefixer: {
+                    flexbox: 'no-2009',
+                  },
+                  // https://preset-env.cssdb.org/features/#stage-2
+                },
+              ],
+              isProd && require('./plugins/postcss-safe-area')(),
+              isProd && ['postcss-momentum-scrolling', ['scroll', 'auto']],
+              'postcss-normalize',
+              ...override.extraPostCSSPlugins,
+            ].filter(Boolean),
+          },
+          sourceMap: isDev,
+        },
+      },
+    ]
+    if (preProcessor === 'less-loader') {
+      loaders.push({
+        loader: 'less-loader',
+        options: {
+          lessOptions: {
+            javascriptEnabled: true,
+            modifyVars: fs.existsSync(paths.theme) ? require(paths.theme) : undefined,
+          },
+          sourceMap: true,
+        },
+      })
+    }
+    return loaders
+  }
+
+  /** @type {webpack.Configuration} */
+  const config = {
+    context: process.cwd(),
+    mode: process.env.NODE_ENV,
+    entry: './src/index',
+    target: 'browserslist',
+    output: {
+      filename: appConfig.single
+        ? `js/${jsMainPath}_${appPkg.version}.[contenthash:6].js`
+        : `js/${jsMainPath}_${appPkg.version}.js`,
+      chunkFilename: `js/${assetPath}/[name].[chunkhash:8].js`,
+      assetModuleFilename: `images/${assetPath}/[name].[hash:6][ext]`,
+      uniqueName: appPkg.name,
+      publicPath: '',
+    },
+    externals: Object.assign(
+      {},
+      qsbCDN.isUseCommon && {
+        react: 'React',
+        'react-dom': 'ReactDOM',
+        'natty-fetch': 'nattyFetch',
+        'natty-storage': 'nattyStorage',
+        'common-utils': 'CommonUtils',
+      },
+      qsbCDN.isUseAxios && { axios: 'axios' },
+      qsbCDN.isUseMoment && { moment: 'moment' },
+      qsbCDN.isUseAntd && {
+        react: 'React',
+        'react-dom': 'ReactDOM',
+        moment: 'moment',
+        antd: 'antd',
+        ...(isProd && !appConfig.single
+          ? {
+              '@qse/antd': 'qsbAntd',
+              '@qse/scheme-render': 'qsbSchemeRender',
+              '@qsb/antd': 'qsbAntd',
+              '@qsb/scheme-render': 'qsbSchemeRender',
+            }
+          : {}),
+      },
+      override.externals
+    ),
+    resolve: {
+      alias: {
+        '@': paths.src,
+        ...override.alias,
+      },
+      extensions: ['.web.js', '.web.mjs', '.js', '.mjs', '.jsx', '.ts', '.tsx', '.json', '.wasm'],
+    },
+    stats: isDev ? { preset: 'errors-warnings', timings: true } : undefined,
+    devtool: isDev ? 'cheap-module-source-map' : false,
+    cache: {
+      type: 'filesystem',
+      version: require('../../package.json').version,
+      buildDependencies: {
+        config: [__filename],
+        override: [paths.override].filter((f) => fs.existsSync(f)),
+        tsconfig: [paths.tsconfig, paths.jsconfig].filter((f) => fs.existsSync(f)),
+      },
+    },
+    module: {
+      parser: { javascript: { exportsPresence: 'error' } },
+      rules: [
+        {
+          oneOf: [
+            // 两个 babel-loader 是为了处理 pdfjs-dist 与 ofd.js
+            {
+              test: /\.(j|t)sx?$/,
+              loader: 'babel-loader',
+              include: paths.src,
+              options: require('./babel')(),
+            },
+            (override.transformNodeModules || isProd) && {
+              test: /\.m?js$/,
+              loader: 'babel-loader',
+              exclude: /@babel(?:\/|\\{1,2})runtime/,
+              options: require('./babel.dependencies')(),
+            },
+            {
+              test: cssRegex,
+              exclude: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isDev,
+                modules: {
+                  mode: 'global',
+                  localIdentName: '[local]--[hash:base64:6]',
+                },
+              }),
+              sideEffects: true,
+            },
+            {
+              test: cssModuleRegex,
+              use: getStyleLoaders({
+                importLoaders: 1,
+                sourceMap: isDev,
+                modules: {
+                  mode: 'local',
+                  localIdentName: '[local]--[hash:base64:6]',
+                },
+              }),
+            },
+            {
+              test: lessRegex,
+              exclude: lessModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 2,
+                  sourceMap: isDev,
+                  modules: {
+                    mode: 'global',
+                    localIdentName: '[local]--[hash:base64:6]',
+                  },
+                },
+                'less-loader'
+              ),
+              sideEffects: true,
+            },
+            {
+              test: lessModuleRegex,
+              use: getStyleLoaders(
+                {
+                  importLoaders: 2,
+                  sourceMap: isDev,
+                  modules: {
+                    mode: 'local',
+                    localIdentName: '[local]--[hash:base64:6]',
+                  },
+                },
+                'less-loader'
+              ),
+            },
+            {
+              test: /\.(bmp|png|jpe?g|gif|webp)$/,
+              type: 'asset',
+              parser: {
+                dataUrlCondition: {
+                  maxSize: imageInlineSizeLimit, // 10kb
+                },
+              },
+            },
+            {
+              test: /\.svg$/,
+              type: 'asset',
+              parser: {
+                dataUrlCondition: {
+                  maxSize: imageInlineSizeLimit, // 10kb
+                },
+              },
+              issuer: {
+                and: [/\.(css|less)$/],
+              },
+            },
+            {
+              test: /\.svg$/,
+              use: [
+                {
+                  loader: '@svgr/webpack',
+                  options: {
+                    prettier: false,
+                    svgo: false,
+                    svgoConfig: {
+                      plugins: [{ removeViewBox: false }],
+                    },
+                    titleProp: true,
+                    ref: false,
+                  },
+                },
+                {
+                  loader: 'url-loader',
+                  options: {
+                    name: `images/${assetPath}/[name].[hash:6].[ext]`,
+                    limit: imageInlineSizeLimit,
+                  },
+                },
+              ],
+              issuer: {
+                and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
+              },
+            },
+            {
+              // Exclude `js` files to keep "css" loader working as it injects
+              // its runtime that would otherwise be processed through "file" loader.
+              // Also exclude `html` and `json` extensions so they get processed
+              // by webpacks internal loaders.
+              exclude: [/^$/, /\.(js|mjs|jsx|ts|tsx)$/, /\.html$/, /\.json$/],
+              type: 'asset/resource',
+            },
+          ].filter(Boolean),
+        },
+      ],
+    },
+    plugins: [
+      qsbCDN.isUseCommon &&
+        new webpack.DllReferencePlugin({
+          manifest: require('../asset/dll/libcommon3-manifest.json'),
+        }),
+      new webpack.IgnorePlugin({
+        resourceRegExp: /^\.\/locale$/,
+        contextRegExp: /moment$/,
+      }),
+      new webpack.DefinePlugin({
+        'process.env.APP_NAME': JSON.stringify(appPkg.name),
+        'process.env.APP_VERSION': JSON.stringify(appPkg.version),
+        'process.env.BABEL_ENV': JSON.stringify(process.env.BABEL_ENV),
+        'process.env.BROWSERSLIST': JSON.stringify(process.env.BROWSERSLIST),
+        'process.env.WDS_SOCKET_HOST': JSON.stringify(process.env.WDS_SOCKET_HOST),
+        'process.env.WDS_SOCKET_PORT': JSON.stringify(process.env.WDS_SOCKET_PORT),
+        ...override.define,
+      }),
+      new webpack.ProgressPlugin(),
+      isDev && new CaseSensitivePathsPlugin(),
+      isDev && new ReactRefreshPlugin({ overlay: false }),
+      ...(isDev || process.env.OUTPUT_HTML || appConfig.single || appConfig.mainProject
+        ? paths.indexHTML.map(
+            (template) =>
+              new HtmlWebpackPlugin({
+                template: template,
+                filename: template.split('/').pop(),
+                inject: false,
+                minify: {
+                  removeComments: true,
+                  collapseWhitespace: true,
+                  removeRedundantAttributes: true,
+                  useShortDoctype: true,
+                  removeEmptyAttributes: true,
+                  removeStyleLinkTypeAttributes: true,
+                  keepClosingSlash: true,
+                  minifyJS: true,
+                  minifyCSS: true,
+                  minifyURLs: true,
+                },
+              })
+          )
+        : []),
+      process.env.ANALYZE && isProd && new BundleAnalyzerPlugin(),
+    ].filter(Boolean),
+    optimization: {
+      minimize: isProd && override.minify !== false,
+      minimizer: [
+        override.minify === 'esbuild' &&
+          new ESBuildMinifyPlugin({
+            pure: override.pure_funcs ?? ['console.log'],
+            drop: ['debugger'],
+            keepNames: false,
+            legalComments: 'none',
+            target: 'es5',
+          }),
+        // This is only used in production mode
+        override.minify === 'terser' &&
+          new TerserPlugin({
+            extractComments: false,
+            terserOptions: {
+              parse: {
+                // We want terser to parse ecma 8 code. However, we don't want it
+                // to apply any minification steps that turns valid ecma 5 code
+                // into invalid ecma 5 code. This is why the 'compress' and 'output'
+                // sections only apply transformations that are ecma 5 safe
+                // https://github.com/facebook/create-react-app/pull/4234
+                ecma: 8,
+              },
+              compress: {
+                pure_funcs: override.pure_funcs ?? ['console.log'],
+                drop_debugger: true,
+                ecma: 5,
+                warnings: false,
+                // Disabled because of an issue with Uglify breaking seemingly valid code:
+                // https://github.com/facebook/create-react-app/issues/2376
+                // Pending further investigation:
+                // https://github.com/mishoo/UglifyJS2/issues/2011
+                comparisons: false,
+                // Disabled because of an issue with Terser breaking valid code:
+                // https://github.com/facebook/create-react-app/issues/5250
+                // Pending further investigation:
+                // https://github.com/terser-js/terser/issues/120
+                inline: 2,
+              },
+              mangle: {
+                safari10: true,
+              },
+              // Added for profiling in devtools
+              keep_classnames: false,
+              keep_fnames: false,
+              output: {
+                ecma: 5,
+                comments: false,
+                // Turned on because emoji and regex is not minified properly using default
+                // https://github.com/facebook/create-react-app/issues/2488
+                ascii_only: true,
+              },
+            },
+          }),
+      ].filter(Boolean),
+      splitChunks: {
+        minChunks: 2,
+      },
+    },
+    performance: {
+      maxEntrypointSize: appConfig.single ? 1024 * 1024 : 30 * 1024,
+      maxAssetSize: 1024 * 1024,
+    },
+  }
+
+  return config
+}

package/src/config/webpackDevServerConfig.js

@@ -0,0 +1,44 @@
+const WebpackDevServer = require('webpack-dev-server')
+
+/**
+ * @param {*} args
+ * @param {import('../utils/defineConfig').Config} override
+ */
+module.exports = function getWebpackDevServerConfig(args, override) {
+  const host = process.env.HOST || '0.0.0.0'
+  const sockHost = process.env.WDS_SOCKET_HOST
+  const sockPort = process.env.WDS_SOCKET_PORT
+
+  /** @type {WebpackDevServer.Configuration} */
+  const devServer = {
+    hot: true,
+    allowedHosts: 'all',
+    historyApiFallback: true,
+    port: args.port,
+    open: args.open,
+    host,
+    client: {
+      webSocketURL: { protocol: 'auto:', hostname: sockHost, port: sockPort },
+    },
+    headers: {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': '*',
+      'Access-Control-Allow-Headers': '*',
+    },
+    proxy: [
+      ...override.proxy,
+      {
+        context: ['/api'],
+        target: 'http://192.168.10.19:3339/qsxxwapdev',
+        changeOrigin: true,
+        headers: {
+          host: 'www.zhidianbao.cn',
+          origin: 'http://www.zhidianbao.cn',
+        },
+      },
+    ],
+    compress: true,
+  }
+
+  return devServer
+}

package/src/deploy.js

@@ -0,0 +1,158 @@
+const { sshSftp } = require('@qse/ssh-sftp')
+const path = require('path')
+const paths = require('./config/paths')
+const pkg = require(paths.package)
+const chalk = require('chalk')
+const fs = require('fs-extra')
+const changeDeployVersion = require('./utils/changeDeployVersion')
+const ora = require('ora')
+const appConfig = require('./utils/appConfig')
+
+const baseConfig = {
+  localPath: 'dist',
+  ignore: [],
+  cleanRemoteFiles: false,
+  securityLock: false,
+  keepAlive: true,
+  noWarn: true,
+}
+
+async function normalDeploy(args) {
+  const presetConfig = {
+    s: {
+      context: 'eduwebngv1',
+      folder: 'userportal',
+    },
+    b: {
+      context: 'eduwebngv1',
+      folder: 'bureaupc',
+    },
+    d: {
+      context: 'eduwebngv1',
+      folder: 'documentshelves',
+    },
+  }
+
+  const resolve = (...pathSegments) => path.resolve(process.cwd(), ...pathSegments)
+
+  /**
+   * 生成路径
+   * @name remoteFile 远程文件
+   * @name tmpFile 本地文件
+   * @name tmpDir 本地临时文件夹 `tmpFile`存在的文件夹
+   * @name tmpBase 本地临时文件夹 到`__tmp__`层
+   * @param {string} remoteFilePath 远程文件相对`opts.remotePath`地址
+   */
+  function getLocalAndRemoteFilePath(remoteFilePath, opts) {
+    const splited = remoteFilePath.split('/')
+    const fileName = splited[splited.length - 1]
+    const tmpBase = resolve(opts.localPath, '__tmp__')
+    const tmpDir = resolve(opts.localPath, '__tmp__', ...splited.slice(0, -1))
+    const tmpFile = resolve(tmpDir, fileName)
+
+    const remoteFile = [opts.remotePath, remoteFilePath].join('/')
+
+    return { tmpDir, tmpFile, remoteFile, tmpBase }
+  }
+
+  async function upload(opts) {
+    // 上传dist文件
+    const { sftp, opts: fullOpts } = await sshSftp(opts)
+
+    const spinner = ora('自动更新 ver.js 版本配置').start()
+    // 指定远程需要修改的文件
+    const fileName = 'js/ver.js'
+    // 生成各种路径
+    const { remoteFile, tmpDir, tmpFile, tmpBase } = getLocalAndRemoteFilePath(fileName, fullOpts)
+
+    try {
+      // 创建本地临时文件夹，位置在 `opts.localPath` 下的 `__tmp__` 文件夹
+      fs.mkdirSync(tmpDir, { recursive: true })
+
+      // 拉取远程文件到本地
+      await sftp.fastGet(remoteFile, tmpFile)
+
+      // 读取本地文件内容
+      let code = await fs.readFile(tmpFile, { encoding: 'utf-8' })
+      code = changeDeployVersion(code, {
+        name: pkg.name,
+        version: pkg.version,
+        grayscale: appConfig.grayscale,
+      })
+
+      await sftp.fastPut(tmpFile, remoteFile + '.bak')
+      await fs.writeFile(tmpFile, code)
+      // 将修改完的内容传回服务器
+      await sftp.fastPut(tmpFile, remoteFile)
+
+      spinner.succeed('已更新 ver.js 版本配置')
+    } catch (e) {
+      spinner.fail(`自动修改 ver.js 失败，请手动修改`)
+      console.log(chalk.bgRed(e.message))
+    } finally {
+      await sftp.end()
+      // 清除临时文件夹
+      fs.removeSync(tmpBase)
+    }
+  }
+
+  const presets = []
+  if (args.b) {
+    presets.push(presetConfig.b)
+  }
+  if (args.s) {
+    presets.push(presetConfig.s)
+  }
+  if (args.d) {
+    presets.push(presetConfig.d)
+  }
+  if (presets.length === 0) {
+    console.log(
+      `
+    ${chalk.red('指定 deploy 部署范围')}
+
+    # 部署代码 校端
+    ${chalk.green('edu-scripts deploy -s')}
+    # 部署代码 局端
+    ${chalk.green('edu-scripts deploy -b')}
+    # 部署代码 公文
+    ${chalk.green('edu-scripts deploy -d')}
+    # 部署代码 校端 + 局端
+    ${chalk.green('edu-scripts deploy -s -b')}
+    `
+    )
+    process.exit()
+  }
+
+  const uploadConfig = { ...baseConfig, ignore: [...baseConfig.ignore, 'js/ver.js'] }
+  if (!appConfig.mainProject) {
+    uploadConfig.ignore = [...uploadConfig.ignore, '!(js|images)']
+  }
+
+  for (const preset of presets) {
+    await upload({ ...uploadConfig, preset })
+  }
+}
+
+async function singleDeploy() {
+  const config = fs.existsSync(paths.sshSftp)
+    ? fs.readJsonSync(paths.sshSftp)
+    : {
+        ...baseConfig,
+        preset: { context: 'qsxxwapdev' },
+        cleanRemoteFiles: true,
+        securityLock: true,
+        keepAlive: false,
+        noWarn: false,
+      }
+
+  sshSftp(config)
+}
+
+module.exports = function deploy(args) {
+  if (appConfig.single) {
+    singleDeploy()
+  } else {
+    normalDeploy(args)
+  }
+}