@qse/edu-scripts 0.0.0-beta.0

package/src/config/webpackConfig.js

@@ -0,0 +1,444 @@
+import fs from 'fs-extra'
+import { rspack } from '@rspack/core'
+import HtmlWebpackPlugin from 'html-webpack-plugin'
+import { BundleAnalyzerPlugin } from 'webpack-bundle-analyzer'
+import ReactRefreshPlugin from '@rspack/plugin-react-refresh'
+import paths from './paths.js'
+import appConfig from '../utils/appConfig.js'
+import { once } from 'lodash-es'
+import { createRequire } from 'node:module'
+
+const require = createRequire(import.meta.url)
+const appPkg = fs.readJsonSync(paths.package)
+
+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 qseCDN = (() => {
+  const contents = paths.indexHTML.map((url) => fs.readFileSync(url, 'utf-8'))
+
+  function include(pattern) {
+    const regexp = new RegExp(pattern)
+    return contents.some((content) => regexp.test(content))
+  }
+
+  return {
+    isUseCommon: include(/react16.14.*_common31?.js|react-dev-preset.js/),
+    isUseAxios: include(/react16.14.*_axios0.21.1|react-dev-preset.js/),
+    isUseMoment: include('moment2.29.1.js'),
+    isUseAntd: include('antd3.26.20.js'),
+    isUseQsbAntd: include('qsb-antd.min.js'),
+    isUseQsbSchemeRender: include('qsb-scheme-render.min.js'),
+  }
+})()
+
+/**
+ * @param {*} args
+ * @param {import('../utils/defineConfig').Config} override
+ */
+export default 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: require.resolve('style-loader'),
+        options: { attributes: { 'data-module': appPkg.name, 'data-version': appPkg.version } },
+      },
+      {
+        loader: require.resolve('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: require.resolve('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) && require.resolve('tailwindcss'),
+              require.resolve('postcss-flexbugs-fixes'),
+              [
+                require.resolve('postcss-preset-env'),
+                {
+                  autoprefixer: {
+                    flexbox: 'no-2009',
+                  },
+                  // https://preset-env.cssdb.org/features/#stage-2
+                },
+              ],
+              isProd && require('./plugins/postcss-safe-area').default(),
+              isProd && [require.resolve('postcss-momentum-scrolling'), ['scroll', 'auto']],
+              require.resolve('postcss-normalize'),
+              ...override.extraPostCSSPlugins,
+            ].filter(Boolean),
+          },
+          sourceMap: isDev,
+        },
+      },
+    ]
+    if (preProcessor === 'less-loader') {
+      loaders.push({
+        loader: require.resolve('less-loader'),
+        options: {
+          lessOptions: {
+            javascriptEnabled: true,
+            modifyVars: fs.existsSync(paths.theme) ? require(paths.theme) : undefined,
+          },
+          sourceMap: true,
+        },
+      })
+    }
+    return loaders
+  }
+
+  /** @type {import('@rspack/core').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(
+      {},
+      qseCDN.isUseCommon && {
+        react: 'React',
+        'react-dom': 'ReactDOM',
+        'natty-fetch': 'nattyFetch',
+        'natty-storage': 'nattyStorage',
+        'common-utils': 'CommonUtils',
+        '@qse/common-utils': 'CommonUtils',
+      },
+      qseCDN.isUseAxios && { axios: 'axios' },
+      qseCDN.isUseMoment && { moment: 'moment' },
+      qseCDN.isUseAntd &&
+        Object.assign(
+          {
+            react: 'React',
+            'react-dom': 'ReactDOM',
+            moment: 'moment',
+            antd: 'antd',
+          },
+          qseCDN.isUseQsbAntd && {
+            '@qse/antd': 'qsbAntd',
+            '@qsb/antd': 'qsbAntd',
+          },
+          qseCDN.isUseQsbSchemeRender && {
+            '@qse/scheme-render': 'qsbSchemeRender',
+            '@qsb/scheme-render': 'qsbSchemeRender',
+          }
+        ),
+
+      // 教育工程这些一定都需要 external
+      !appConfig.single &&
+        Object.assign(
+          {
+            react: 'React',
+            'react-dom': 'ReactDOM',
+            'natty-fetch': 'nattyFetch',
+            'natty-storage': 'nattyStorage',
+            'common-utils': 'CommonUtils',
+            '@qse/common-utils': 'CommonUtils',
+            moment: 'moment',
+            antd: 'antd',
+          },
+          isProd && {
+            '@qse/antd': 'qsbAntd',
+            '@qsb/antd': 'qsbAntd',
+            '@qse/scheme-render': 'qsbSchemeRender',
+            '@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,
+    module: {
+      rules: [
+        {
+          oneOf: [
+            {
+              resourceQuery: /raw/,
+              type: 'asset/source',
+            },
+            {
+              test: /\.[jt]sx?$/,
+              use: [
+                {
+                  loader: 'builtin:swc-loader',
+                  options: {
+                    rspackExperiments: {
+                      import: [
+                        {
+                          libraryName: 'lodash',
+                          libraryDirectory: '',
+                          camel2DashComponentName: false,
+                        },
+                        ...override.import,
+                      ],
+                    },
+                    jsc: {
+                      parser: {
+                        syntax: 'typescript',
+                        tsx: true,
+                        decorators: override.decorators,
+                      },
+                      // externalHelpers: true,
+                      transform: {
+                        react: {
+                          runtime: 'automatic',
+                          development: isDev,
+                          refresh: isDev,
+                        },
+                      },
+                    },
+                  },
+                },
+              ],
+            },
+            {
+              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: require.resolve('@svgr/webpack'),
+                  options: {
+                    prettier: false,
+                    svgo: false,
+                    svgoConfig: {
+                      plugins: [{ removeViewBox: false }],
+                    },
+                    titleProp: true,
+                    ref: false,
+                  },
+                },
+                {
+                  loader: require.resolve('url-loader'),
+                  options: {
+                    limit: imageInlineSizeLimit,
+                  },
+                },
+              ],
+              issuer: {
+                and: [/\.(ts|tsx|js|jsx|md|mdx)$/],
+              },
+            },
+            {
+              test: /\.md$/,
+              type: 'asset/source',
+            },
+            {
+              // 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.
+              test: /\.(?!(?:js|mjs|jsx|ts|tsx|html|json)$)[^.]+$/,
+              type: 'asset/resource',
+            },
+          ].filter(Boolean),
+        },
+      ],
+    },
+    plugins: [
+      qseCDN.isUseCommon &&
+        new rspack.DllReferencePlugin({
+          manifest: require('../asset/dll/libcommon3-manifest.json'),
+        }),
+      new rspack.NormalModuleReplacementPlugin(/createSocketURL\.js$/, (resource) => {
+        if (resource.context.includes('webpack-dev-server')) {
+          resource.request = require.resolve('./plugins/ws-utils-createSocketURL')
+        }
+      }),
+      new rspack.IgnorePlugin({
+        resourceRegExp: /^\.\/locale$/,
+        contextRegExp: /moment$/,
+      }),
+      new rspack.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),
+        ...override.define,
+      }),
+      new rspack.ProgressPlugin(),
+      isDev && new rspack.CaseSensitivePlugin(),
+      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(),
+      isDev &&
+        !!override.startup &&
+        ((compiler) => {
+          compiler.hooks.afterDone.tap(
+            'edu-scripts-startup',
+            once(() => {
+              const logger = compiler.getInfrastructureLogger('edu-scripts')
+              override.startup({ logger, chalk: require('chalk'), compiler })
+            })
+          )
+        }),
+    ].filter(Boolean),
+    optimization: {
+      minimize: isProd && override.minify !== false,
+      minimizer: [
+        new rspack.SwcJsMinimizerRspackPlugin({
+          minimizerOptions: {
+            ecma: 5,
+            compress: {
+              pure_funcs: override.pure_funcs,
+              drop_debugger: true,
+              ecma: 5,
+              // 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,
+            },
+          },
+        }),
+      ],
+      splitChunks: {
+        minChunks: 2,
+      },
+    },
+    performance: {
+      maxEntrypointSize: appConfig.single ? 1024 * 1024 : 30 * 1024,
+      maxAssetSize: 2 * 1024 * 1024,
+    },
+  }
+
+  return config
+}

package/src/config/webpackDevServerConfig.js

@@ -0,0 +1,83 @@
+import setupMockServer from './plugins/mock-server/index.js'
+
+function createProxy(context, target, origin) {
+  const url = new URL(origin || target)
+
+  return {
+    context: [context],
+    target: target,
+    changeOrigin: true,
+    onProxyReq: (proxyReq) => {
+      proxyReq.setHeader('host', url.host)
+      proxyReq.setHeader('origin', url.origin)
+      proxyReq.removeHeader('referer')
+    },
+  }
+}
+
+/**
+ * @param {*} args
+ * @param {import('../utils/defineConfig').Config} override
+ */
+export default function getWebpackDevServerConfig(args, override) {
+  const host = process.env.HOST || '0.0.0.0'
+
+  /** @type {import('@rspack/dev-server').Configuration} */
+  const devServer = {
+    allowedHosts: 'all',
+    historyApiFallback: true,
+    port: args.port,
+    open: args.open,
+    host,
+    client: {
+      webSocketURL: 'auto://0.0.0.0:0/ws',
+      overlay: {
+        runtimeErrors: false,
+        errors: true,
+        warnings: false,
+      },
+    },
+    headers: {
+      'Access-Control-Allow-Origin': '*',
+      'Access-Control-Allow-Methods': '*',
+      'Access-Control-Allow-Headers': '*',
+    },
+    setupMiddlewares: (middlewares, devServer) => {
+      if (override.mock !== false) {
+        setupMockServer(middlewares, devServer)
+      }
+
+      return middlewares
+    },
+    proxy: [
+      createProxy('/api', 'http://192.168.10.19:3339/qsxxwapdev', 'http://www.zhidianbao.cn'),
+    ],
+    compress: true,
+  }
+
+  if (override.proxy) {
+    if (Array.isArray(override.proxy)) {
+      devServer.proxy = [...override.proxy, ...devServer.proxy]
+    } else if (typeof override.proxy === 'object') {
+      const proxies = Object.entries(override.proxy).map(([context, target]) => {
+        return createProxy(context, target)
+      })
+      devServer.proxy = [...proxies, ...devServer.proxy]
+    } else {
+      throw new Error('proxy 必须是数组或对象')
+    }
+
+    // 清理重复的代理配置
+    const proxyMap = new Map()
+    devServer.proxy = devServer.proxy.filter((item) => {
+      const key = JSON.stringify([...item.context].sort())
+      if (!proxyMap.has(key)) {
+        proxyMap.set(key, true)
+        return true
+      }
+      return false
+    })
+  }
+
+  return devServer
+}

package/src/deploy.js

@@ -0,0 +1,182 @@
+import { sshSftp } from '@qse/ssh-sftp'
+import path from 'path'
+import paths from './config/paths.js'
+import chalk from 'chalk'
+import fs from 'fs-extra'
+import changeDeployVersion from './utils/changeDeployVersion.js'
+import ora from 'ora'
+import appConfig from './utils/appConfig.js'
+import { format } from 'prettier'
+
+const appPkg = fs.readJsonSync(paths.package)
+
+const baseConfig = {
+  localPath: 'dist',
+  ignore: [],
+  cleanRemoteFiles: false,
+  securityLock: false,
+  keepAlive: true,
+  noWarn: true,
+}
+
+async function normalDeploy(args) {
+  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 }
+  }
+
+  function dateTime() {
+    let date = new Date()
+    date = new Date(date.getTime() - date.getTimezoneOffset() * 60000)
+    return date.toISOString().replace(/T/, ' ').replace(/\..+/, '')
+  }
+  function updateLogContent(content, info) {
+    const lines = content.trim().split('\n')
+    lines.push(`[${dateTime()}] ${JSON.stringify(info)}\n`)
+    return lines.slice(-50).join('\n')
+  }
+
+  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 })
+
+      const info = {
+        name: appPkg.name,
+        version: appPkg.version,
+        grayscale: appConfig.grayscale,
+      }
+
+      {
+        // 拉取远程文件到本地
+        await sftp.fastGet(remoteFile, tmpFile)
+
+        // 读取本地文件内容
+        let code = await fs.readFile(tmpFile, { encoding: 'utf-8' })
+        code = await changeDeployVersion(code, info)
+        code = await format(code, { parser: 'babel', printWidth: 120 })
+
+        await sftp.fastPut(tmpFile, remoteFile + '.bak')
+        await fs.writeFile(tmpFile, code)
+        // 将修改完的内容传回服务器
+        await sftp.fastPut(tmpFile, remoteFile)
+      }
+
+      {
+        const remoteLogFile = remoteFile + '.log'
+        const tmpLogFile = tmpFile + '.log'
+        let content = ''
+        try {
+          await sftp.fastGet(remoteLogFile, tmpLogFile)
+          content = await fs.readFile(tmpLogFile, 'utf-8')
+        } catch (error) {}
+        content = updateLogContent(content, info)
+        await fs.writeFile(tmpLogFile, content)
+        await sftp.fastPut(tmpLogFile, remoteLogFile)
+      }
+
+      spinner.succeed('已更新 ver.js 版本配置')
+    } catch (e) {
+      spinner.fail(`自动修改 ver.js 失败，请手动修改`)
+      console.log(chalk.bgRed(e.message))
+    } finally {
+      await sftp.end()
+      // 清除临时文件夹
+      fs.removeSync(tmpBase)
+    }
+  }
+
+  const presetConfig = {
+    s: { preset: { context: 'eduwebngv1', folder: 'userportal' } },
+    b: { preset: { context: 'eduwebngv1', folder: 'bureaupc' } },
+    d: { preset: { context: 'eduwebngv1', folder: 'documentshelves' } },
+    c: { preset: { context: 'eduwebngv1', folder: 'compositionshelves' } },
+    cd: {
+      preset: { server: '19' },
+      remotePath: '/erp/edumaven/dingcorrection-page-dev/compositionshelves',
+    },
+  }
+  const uploadSftpConfigs = []
+  if (args.b) {
+    uploadSftpConfigs.push(presetConfig.b)
+  }
+  if (args.s) {
+    uploadSftpConfigs.push(presetConfig.s)
+  }
+  if (args.d) {
+    uploadSftpConfigs.push(presetConfig.d)
+  }
+  if (args.c) {
+    uploadSftpConfigs.push(presetConfig.c)
+  }
+  if (args.cd) {
+    uploadSftpConfigs.push(presetConfig.cd)
+  }
+  if (uploadSftpConfigs.length === 0) {
+    console.log(
+      `
+    ${chalk.red('指定 deploy 部署范围')}
+    执行 ${chalk.green('npx edu-scripts deploy -h')} 查看具体用法
+    `
+    )
+    process.exit()
+  }
+
+  const uploadConfig = { ...baseConfig, ignore: [...baseConfig.ignore, 'js/ver.js'] }
+  if (!appConfig.mainProject) {
+    uploadConfig.ignore = [...uploadConfig.ignore, '!(js|images)']
+  }
+
+  for (const config of uploadSftpConfigs) {
+    await upload({ ...uploadConfig, ...config })
+  }
+}
+
+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)
+}
+
+export default function deploy(args) {
+  if (appConfig.single) {
+    singleDeploy()
+  } else {
+    normalDeploy(args)
+  }
+}