@qse/edu-scripts 1.14.17 → 2.0.0

package/dist/index.d.mts

@@ -0,0 +1,83 @@
+import { Chalk } from "chalk";
+import { Compiler, Configuration, SwcLoaderOptions } from "@rspack/core";
+import { Configuration as Configuration$1 } from "@rspack/dev-server";
+import { RequestHandler } from "express";
+
+//#region src/utils/defineConfig.d.ts
+type ProxyConfigArray = NonNullable<Configuration$1['proxy']>;
+type Configuration$2 = {
+  webpack?: (config: Configuration) => Configuration | undefined;
+  devServer?: (config: Configuration$1) => Configuration$1 | undefined;
+  /**
+   * webpack alias 配置，会与内置 alias 合并
+   *
+   * 会自动读取 tsconfig 里 baseUrl + paths 的配置
+   *
+   * @default
+   * { '@': './src' }
+   */
+  alias?: Record<string, string>;
+  /**
+   * webpack externals 配置，会与内置 externals 合并
+   */
+  externals?: Record<string, string>;
+  /**
+   * terser pure_funcs，esbuild pure 配置，传 [] 可以不清空 console.log
+   * @default ['console.log']
+   */
+  pure_funcs?: string[];
+  /**
+   * 是否压缩代码
+   * @default true
+   */
+  minify?: boolean; /** 自定义全局参数 */
+  define?: Record<string, any>;
+  /**
+   * context 填写的顺序很重要，前面的会优先匹配。可以重复定义 /api 来覆盖默认的配置
+   *
+   * proxy 会自动删除请求头 referer，避免某些后端校验失败的问题
+   * @see https://webpack.js.org/configuration/dev-server/#devserverproxy
+   * @default /api -> /qsxxwapdev/api
+   * @example { '/api': 'http://localhost:3000' }
+   * @example [{ context: ['/api'], target: 'http://localhost:3000' }]
+   */
+  proxy?: ProxyConfigArray | Record<string, string>;
+  extraPostCSSPlugins?: any[];
+  /**
+   * 开启 mock 功能，会自动加载 mock 文件夹下的文件
+   *
+   * 默认情况下自动判断根目录是否存在 mock 文件夹，如果存在则开启 mock 功能。
+   * 如果设置 false，会关闭 mock 功能
+   */
+  mock?: boolean;
+  /**
+   * 开发模式启动后用来展示启动后的提示信息，或者自定义的逻辑
+   */
+  startup?: (params: {
+    /** 控制台输出内容 */logger: ReturnType<Compiler['getInfrastructureLogger']>; /** 字体颜色相关工具 */
+    chalk: Chalk; /** webpack compiler 自定义的时候会用到 */
+    compiler: Compiler;
+  }) => void;
+  /**
+   * 是否开启装饰器语法支持 只支持 legacy 版本
+   * @see https://babeljs.io/docs/en/babel-plugin-proposal-decorators
+   * @default false
+   */
+  decorators?: boolean;
+  /**
+   * 与 babel-plugin-import 类似，但是内部是 rspack 重构，libraryDirectory 默认值是 lib
+   *
+   * @see https://rspack.rs/zh/guide/features/builtin-swc-loader#rspackexperimentsimport
+   * @default [{libraryName: 'lodash',libraryDirectory: '',camelToDashComponentName: false}]
+   */
+  import?: NonNullable<SwcLoaderOptions['rspackExperiments']>['import'];
+};
+declare function defineConfig(config: Configuration$2): Configuration$2;
+//#endregion
+//#region src/config/plugins/mock-server/defineMock.d.ts
+type Method = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS' | 'CONNECT' | 'TRACE';
+type API = string;
+type MockConfig = Record<`${Method} ${API}`, string | number | null | undefined | boolean | Record<string, any> | RequestHandler>;
+declare function defineMock(config: MockConfig): MockConfig;
+//#endregion
+export { defineConfig, defineMock };

package/dist/index.mjs

@@ -0,0 +1,13 @@
+//#region src/utils/defineConfig.ts
+function defineConfig(config) {
+	return config;
+}
+
+//#endregion
+//#region src/config/plugins/mock-server/defineMock.ts
+function defineMock(config) {
+	return config;
+}
+
+//#endregion
+export { defineConfig, defineMock };

package/eslint.config.mjs

@@ -0,0 +1,3 @@
+import config from '@qse/eslint-config'
+
+export default config

package/{jest.config.js → jest.config.mjs}

@@ -3,7 +3,7 @@
  * https://jestjs.io/docs/configuration
  */
 
-module.exports = {
+export default {
   // All imported modules in your tests should be mocked automatically
   // automock: false,
 
@@ -11,11 +11,15 @@ module.exports = {
   // bail: 0,
 
   // The directory where Jest should store its cached dependency information
-  // cacheDirectory: "/private/var/folders/3q/7klqgj0j63z08zcx0skwjm500000gn/T/jest_dx",
+  // cacheDirectory: "/private/var/folders/71/g8xbd8f97pzcxd6csv8wxw6h0000gn/T/jest_dx",
 
   // Automatically clear mock calls, instances, contexts and results before every test
   clearMocks: true,
 
+  // Enable ESM support for Node.js test environment
+  extensionsToTreatAsEsm: ['.ts'],
+  testEnvironment: 'node',
+
   // Indicates whether the coverage information should be collected while executing the test
   // collectCoverage: false,
 
@@ -173,7 +177,7 @@ module.exports = {
   // testRunner: "jest-circus/runner",
 
   // A map from regular expressions to paths to transformers
-  // transform: undefined,
+  // transform: undefined
 
   // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
   // transformIgnorePatterns: [
@@ -192,4 +196,4 @@ module.exports = {
 
   // Whether to use watchman for file crawling
   // watchman: true,
-};
+}

package/package.json

@@ -1,19 +1,21 @@
 {
   "name": "@qse/edu-scripts",
-  "version": "1.14.17",
+  "version": "2.0.0",
   "author": "Kinoko",
   "license": "MIT",
+  "type": "module",
   "description": "教育工程化基础框架",
   "engines": {
-    "node": ">=14"
+    "node": ">=18"
   },
   "scripts": {
-    "start": "dumi dev",
-    "docs:build": "dumi build",
+    "dev": "tsdown --watch",
+    "docs:dev": "vitepress dev docs",
+    "docs:build": "vitepress build docs",
     "docs:deploy": "ssh-sftp",
-    "build": "father build",
-    "deploy": "node scripts/deploy && rimraf docs-dist",
-    "release": "npm run test && npm run build && npm publish && rimraf lib",
+    "build": "tsdown",
+    "deploy": "node scripts/deploy.js",
+    "release": "npm run test && npm run build && npm publish && rimraf dist",
     "prettier": "prettier -c -w \"src/**/*.{js,jsx,tsx,ts,less,md,json}\"",
     "lint": "eslint --fix src",
     "postversion": "npm run release",
@@ -22,52 +24,43 @@
   "homepage": "http://192.168.10.19:3339/qsxxwapdev/edu-scripts/",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
-    "access": "public"
+    "access": "public",
+    "tag": "beta"
   },
   "bin": {
-    "edu-scripts": "lib/cli.js",
-    "edu": "lib/cli.js"
-  },
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
-  "eslintConfig": {
-    "extends": "qsb-react"
+    "edu-scripts": "dist/cli.mjs",
+    "edu": "dist/cli.mjs"
   },
+  "main": "dist/index.mjs",
+  "typings": "dist/index.d.mts",
   "dependencies": {
-    "@babel/core": "~7.26.10",
-    "@babel/plugin-proposal-decorators": "~7.25.9",
-    "@babel/plugin-transform-runtime": "~7.26.10",
-    "@babel/preset-env": "~7.26.9",
-    "@babel/preset-react": "~7.26.3",
-    "@babel/preset-typescript": "~7.27.0",
-    "@babel/register": "~7.25.9",
-    "@babel/runtime": "~7.27.0",
-    "@pmmmwh/react-refresh-webpack-plugin": "^0.5.16",
-    "@qse/ssh-sftp": "^1.1.0",
+    "@babel/core": "~7.29.0",
+    "@qse/ssh-sftp": "^1.3.1",
+    "@rsdoctor/rspack-plugin": "^1.5.2",
+    "@rspack/core": "^1.7.6",
+    "@rspack/dev-server": "^1.2.1",
+    "@rspack/plugin-react-refresh": "^1.6.1",
     "@svgr/webpack": "^8.1.0",
-    "@types/express": "^4.17.21",
-    "babel-loader": "^9.2.1",
-    "babel-plugin-import": "^1.13.8",
-    "case-sensitive-paths-webpack-plugin": "^2.4.0",
+    "@swc-node/register": "^1.11.1",
+    "@swc/helpers": "^0.5.19",
+    "@types/express": "^4.17.25",
     "chalk": "^4.1.2",
     "chokidar": "^3.6.0",
     "cookie-parser": "^1.4.7",
     "css-loader": "^6.11.0",
     "cssnano": "^6.1.2",
-    "debug": "^4.4.0",
-    "esbuild-loader": "^2.21.0",
     "express": "^4.21.2",
     "filesize": "^8.0.7",
-    "fs-extra": "^10.1.0",
-    "globby": "^11.1.0",
-    "gzip-size": "^6.0.0",
-    "html-webpack-plugin": "^5.6.3",
-    "inquirer": "^8.2.6",
+    "fs-extra": "^11.3.3",
+    "globby": "^16.1.1",
+    "gzip-size": "^7.0.0",
+    "html-webpack-plugin": "^5.6.6",
+    "@inquirer/prompts": "^8.3.0",
     "less": "^3.13.1",
     "less-loader": "^10.2.0",
-    "lodash": "^4.17.21",
-    "multer": "^1.4.5-lts.2",
-    "open": "^8.4.2",
+    "lodash-es": "^4.17.23",
+    "multer": "^2.1.0",
+    "ora": "^9.3.0",
     "path-to-regexp": "^6.3.0",
     "postcss": "^8.5.3",
     "postcss-flexbugs-fixes": "^5.0.2",
@@ -75,33 +68,35 @@
     "postcss-momentum-scrolling": "^3.14.22",
     "postcss-normalize": "^8.0.1",
     "postcss-preset-env": "^9.6.0",
-    "prettier": "^2.8.8",
-    "prettier-plugin-tailwindcss": "^0.4.1",
+    "prettier": "^3.8.1",
+    "prettier-plugin-tailwindcss": "^0.7.2",
     "react-refresh": "^0.14.2",
     "recursive-readdir": "^2.2.3",
-    "rimraf": "^3.0.2",
     "semver": "^7.7.1",
     "strip-ansi": "^6.0.1",
     "style-loader": "^3.3.4",
-    "tailwindcss": "^3.4.17",
-    "terser-webpack-plugin": "~5.3.14",
+    "tailwindcss": "^3.4.19",
     "tmp": "^0.2.3",
-    "typescript": "^5.8.3",
-    "update-notifier": "^5.1.0",
+    "typescript": "^5.9.3",
     "url-loader": "^4.1.1",
-    "webpack": "^5.99.6",
-    "webpack-bundle-analyzer": "^4.10.2",
-    "webpack-dev-server": "^4.15.2",
-    "webpack-retry-chunk-load-plugin": "^3.1.1",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
-    "@types/fs-extra": "^9.0.13",
-    "@types/jest": "^28.1.8",
-    "@types/yargs": "^17.0.33",
-    "dumi": "^1.1.54",
-    "eslint-config-qsb-react": "^1.1.1",
-    "father": "^4.5.2",
-    "jest": "^28.1.3"
+    "@babel/preset-env": "~7.29.0",
+    "@babel/preset-typescript": "^7.28.5",
+    "@qse/eslint-config": "^1.0.0",
+    "@types/cookie-parser": "^1.4.10",
+    "@types/fs-extra": "^11.0.4",
+    "@types/jest": "^30.0.0",
+    "@types/lodash-es": "^4.17.12",
+    "@types/multer": "^2.0.0",
+    "@types/semver": "^7.7.1",
+    "@types/tmp": "^0.2.6",
+    "@types/yargs": "^17.0.35",
+    "eslint": "^9.39.3",
+    "jest": "^30.2.0",
+    "rimraf": "^6.1.3",
+    "tsdown": "^0.20.3",
+    "vitepress": "^1.6.4"
   }
 }

package/src/{auto-refactor.js → auto-refactor.ts}

@@ -1,18 +1,14 @@
-const fs = require('fs-extra')
-const paths = require('./config/paths')
-const path = require('path')
-const chalk = require('chalk')
-const pkg = require('../package.json')
-const glob = require('globby')
-const ora = require('ora')
-const { prompt } = require('inquirer')
-const open = require('open')
-
-/**
- * @param {string} msg
- * @param {(spinner:ora.Ora) => void | Promise<void>} callback
- */
-async function step(msg, callback) {
+import fs from 'fs-extra'
+import paths from './config/paths'
+import path from 'path'
+import chalk from 'chalk'
+import { globby } from 'globby'
+import ora from 'ora'
+import { input, select, checkbox } from '@inquirer/prompts'
+
+const pkg = fs.readJsonSync(paths.resolveOwn('package.json'))
+
+async function step(msg: string, callback: (spinner: import('ora').Ora) => void | Promise<void>) {
   const spinner = ora(msg).start()
   try {
     await callback(spinner)
@@ -23,55 +19,53 @@ async function step(msg, callback) {
   }
 }
 
-module.exports = async function autoRefactor() {
+export default async function autoRefactor() {
   if (await fs.pathExists(paths.public)) {
     console.log(chalk.green('已完成改造，不需要重复执行，如果运行报错请查看文档'))
     console.log(`文档: ${chalk.underline(pkg.homepage)}`)
     process.exit(0)
   }
 
-  const appPkg = require(paths.package)
-  const answers = await prompt([
-    {
-      type: 'input',
-      name: 'name',
-      message: '请输入模块名称，要求唯一，不能与其他工程相同',
-      default: appPkg.name,
-      validate: (v) =>
-        /^[a-z][a-z0-9_-]+$/.test(v) ||
-        '请按格式输入 /^[a-z][a-z0-9_-]+$/ 只能使用小写字母、连字符、下划线',
-    },
-    {
-      type: 'input',
-      name: 'version',
-      message: '版本号',
-      default: '1.0.0',
-      validate: (v) =>
-        /^\d+\.\d+\.\d+$/.test(v) || '请按格式输入 /^\\d+\\.\\d+\\.\\d+$/ 例如: 1.0.0',
-    },
-    {
-      type: 'list',
-      name: 'mode',
-      message: '项目使用的哪种模式',
-      choices: [
-        { name: '教育子工程模式', value: '' },
-        { name: '教育主工程模式', value: 'main' },
-        { name: '独立模式', value: 'single' },
-      ],
-    },
-    {
-      type: 'checkbox',
-      name: 'deploy',
+  const appPkg = fs.readJsonSync(paths.package)
+
+  const name = await input({
+    message: '请输入模块名称，要求唯一，不能与其他工程相同',
+    default: appPkg.name,
+    validate: (v) =>
+      /^[a-z][a-z0-9_-]+$/.test(v) ||
+      '请按格式输入 /^[a-z][a-z0-9_-]+$/ 只能使用小写字母、连字符、下划线',
+  })
+
+  const version = await input({
+    message: '版本号',
+    default: '1.0.0',
+    validate: (v) =>
+      /^\d+\.\d+\.\d+$/.test(v) || '请按格式输入 /^\\d+\\.\\d+\\.\\d+$/ 例如: 1.0.0',
+  })
+
+  const mode = await select({
+    message: '项目使用的哪种模式',
+    choices: [
+      { name: '教育子工程模式', value: '' },
+      { name: '教育主工程模式', value: 'main' },
+      { name: '独立模式', value: 'single' },
+    ],
+  })
+
+  let deploy: string[] = []
+  if (mode !== 'single') {
+    deploy = await checkbox({
       message: '项目需要部署到哪里',
-      when: (ans) => ans.mode !== 'single',
       choices: [
         { name: '校端', value: '-s' },
         { name: '局端', value: '-b' },
         { name: '公文端', value: '-d' },
       ],
       validate: (v) => (!!v && v.length > 0) || '必须选一个',
-    },
-  ])
+    })
+  }
+
+  const answers = { name, version, mode, deploy }
   appPkg.name = answers.name
   appPkg.version = answers.version
 
@@ -86,7 +80,7 @@ module.exports = async function autoRefactor() {
   })
 
   await step('移动 html 文件', async () => {
-    const HTMLFiles = await glob('*.html', { cwd: paths.src })
+    const HTMLFiles = await globby('*.html', { cwd: paths.src })
     for (const file of HTMLFiles) {
       await fs.move(path.resolve(paths.src, file), path.resolve(paths.public, file))
     }
@@ -100,9 +94,9 @@ module.exports = async function autoRefactor() {
 
   await step('删除没用的 babel 和 webpack 配置', async () => {
     const deleteFiles = [
-      ...(await glob('{.,*}babel*')),
-      ...(await glob('*webpack*')),
-      ...(await glob('package-lock.json')),
+      ...(await globby('{.,*}babel*')),
+      ...(await globby('*webpack*')),
+      ...(await globby('package-lock.json')),
       paths.nodeModules,
       paths.sshSftp,
     ]
@@ -137,8 +131,8 @@ module.exports = async function autoRefactor() {
       /(babel|autoprefixer|webpack|loader|less|css|sass|hmr|ssh-sftp|regenerator-runtime|nowa|prettier)/i
 
     const deletePkgs = {
-      dependencies: [],
-      devDependencies: [],
+      dependencies: [] as string[],
+      devDependencies: [] as string[],
     }
     Object.entries(deletePkgs).forEach(([scope, pkgs]) => {
       for (const key in appPkg[scope]) {
@@ -158,8 +152,6 @@ module.exports = async function autoRefactor() {
 
   await fs.writeFile(paths.package, JSON.stringify(appPkg, null, 2), 'utf-8')
 
-  open(`${pkg.homepage}#/refactor`)
-
   console.log(
     chalk.green(`
   改造还未完成，剩余步骤请查看文档

package/src/{build.js → build.ts}

@@ -1,21 +1,25 @@
-process.env.NODE_ENV = 'production'
-process.env.BABEL_ENV = 'production'
-process.env.BROWSERSLIST = '>0.2%, iOS>=9, ie 11, chrome>=49, not op_mini all'
+import { rspack, type Stats } from '@rspack/core'
+import chalk from 'chalk'
+import getConfig from './utils/getConfig'
+// @ts-ignore
+import { measureFileSizesBeforeBuild, printFileSizesAfterBuild } from './utils/FileSizeReporter'
+import paths from './config/paths'
+import fs from 'fs-extra'
+import appConfig from './utils/appConfig'
 
-const webpack = require('webpack')
-const chalk = require('chalk')
-const getConfig = require('./utils/getConfig')
-const {
-  measureFileSizesBeforeBuild,
-  printFileSizesAfterBuild,
-} = require('./utils/FileSizeReporter')
-const paths = require('./config/paths')
-const fs = require('fs-extra')
-const appConfig = require('./utils/appConfig')
 const WARN_AFTER_BUNDLE_GZIP_SIZE = appConfig.single ? 1024 * 1024 : 30 * 1024
 const WARN_AFTER_CHUNK_GZIP_SIZE = 1024 * 1024
 
-module.exports = async function build(args) {
+interface BuildArgs {
+  analyze?: boolean
+  outputHtml?: boolean
+}
+export default async function build(args: BuildArgs) {
+  process.env.NODE_ENV = 'production'
+  process.env.BABEL_ENV = 'production'
+  process.env.BROWSERSLIST = '>0.2%, iOS>=9, ie 11, chrome>=49, not op_mini all'
+  process.env.BROWSERSLIST_IGNORE_OLD_DATA = 'true'
+
   if (args.analyze) {
     process.env.ANALYZE = '1'
   }
@@ -33,14 +37,16 @@ module.exports = async function build(args) {
     fs.copySync(paths.static, paths.resolveApp('dist', 'static'))
   }
 
-  webpack(getConfig(args), (error, stats) => {
+  const config = getConfig(args)
+  rspack(config, (error, stats: Stats | undefined) => {
     if (error) {
       console.log(chalk.red('编译失败'))
       console.log(chalk.red(error.message || error))
-      console.log()
       process.exit(1)
     }
 
+    if (!stats) return
+
     if (stats.compilation.errors.length) {
       console.log(chalk.red('编译失败'))
       console.log(stats.toString({ all: false, errors: true, colors: true }))

package/src/{cli.js → cli.ts}

@@ -1,20 +1,28 @@
 #!/usr/bin/env node
-const pkg = require('../package.json')
+import '@swc-node/register/esm-register'
+import './utils/beforeStart'
 
-// 检查运行条件
-require('./utils/beforeStart')
+import fs from 'fs-extra'
+import yargs from 'yargs'
+import paths from './config/paths'
 
-// eslint-disable-next-line no-unused-expressions
-require('yargs')
+import start from './start'
+import build from './build'
+import deploy from './deploy'
+import autoRefactor from './auto-refactor'
+import commitDist from './commit-dist'
+import * as generator from './generator'
+
+const pkg = fs.readJsonSync(paths.resolveOwn('package.json'))
+
+// eslint-disable-next-line @typescript-eslint/no-unused-expressions
+yargs(process.argv.slice(2))
   .usage(`教育工程化 webpack5 基础框架\n文档: ${pkg.homepage}`)
   .command(
     'start',
     '开发',
-    (yargs) =>
-      yargs
-        .option('port', { alias: 'p', desc: '指定端口' })
-        .option('open', { desc: '启动后打开页面' }),
-    (args) => require('./start')(args)
+    (yargs) => yargs.option('port', { alias: 'p', desc: '指定端口', string: true }),
+    (args) => start(args)
   )
   .command(
     'build',
@@ -33,7 +41,7 @@ require('yargs')
           default: false,
           boolean: true,
         }),
-    (args) => require('./build')(args)
+    (args) => build(args)
   )
   .command(
     'deploy',
@@ -60,26 +68,22 @@ require('yargs')
           default: false,
           boolean: true,
         }),
-    (args) => require('./deploy')(args)
+    (args) => deploy(args)
   )
   .command(['generator', 'g'], '自动生成代码', (yargs) =>
     yargs
-      .command('override', '创建 override 文件', {}, (args) =>
-        require('./generator').override(args)
-      )
-      .command('tailwind', '创建 tailwind 文件', {}, (args) =>
-        require('./generator').tailwind(args)
-      )
-      .command('ts', '创建 tsconfig 文件', {}, (args) => require('./generator').ts(args))
+      .command('override', '创建 override 文件', {}, () => generator.override())
+      .command('tailwind', '创建 tailwind 文件', {}, () => generator.tailwind())
+      .command('ts', '创建 tsconfig 文件', {}, () => generator.ts())
       .showHelpOnFail(true)
       .demandCommand(1, '')
   )
-  .command('auto-refactor', '自动改造项目', {}, () => require('./auto-refactor')())
+  .command('auto-refactor', '自动改造项目', {}, () => autoRefactor())
   .command(
     'commit-dist',
     '提交 dist 目录到 dist 分支',
     (yargs) => yargs.option('rm-local', { desc: '提交完后删除本地 dist', type: 'boolean' }),
-    (args) => require('./commit-dist')(args)
+    (args) => commitDist(args)
   )
   .showHelpOnFail(true)
   .demandCommand(1, '')