@qse/edu-scripts 1.12.0

package/src/auto-refactor.js

@@ -0,0 +1,172 @@
+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) {
+  const spinner = ora(msg).start()
+  try {
+    await callback(spinner)
+    spinner.succeed()
+  } catch (error) {
+    spinner.fail()
+    throw error
+  }
+}
+
+module.exports = 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',
+      message: '项目需要部署到哪里',
+      when: (ans) => ans.mode !== 'single',
+      choices: [
+        { name: '校端', value: '-s' },
+        { name: '局端', value: '-b' },
+        { name: '公文端', value: '-d' },
+      ],
+      validate: (v) => (!!v && v.length > 0) || '必须选一个',
+    },
+  ])
+  appPkg.name = answers.name
+  appPkg.version = answers.version
+
+  await step('创建 public 文件夹', async () => {
+    await fs.mkdir(paths.public)
+  })
+
+  await step('移动 js 文件夹', async () => {
+    if (await fs.pathExists(path.resolve(paths.src, 'js'))) {
+      await fs.move(path.resolve(paths.src, 'js'), path.resolve(paths.public, 'js'))
+    }
+  })
+
+  await step('移动 html 文件', async () => {
+    const HTMLFiles = await glob('*.html', { cwd: paths.src })
+    for (const file of HTMLFiles) {
+      await fs.move(path.resolve(paths.src, file), path.resolve(paths.public, file))
+    }
+  })
+
+  await step('删除 dll 文件夹', async () => {
+    if (await fs.pathExists(path.resolve(paths.src, 'dll'))) {
+      await fs.remove(path.resolve(paths.src, 'dll'))
+    }
+  })
+
+  await step('删除没用的 babel 和 webpack 配置', async () => {
+    const deleteFiles = [
+      ...(await glob('{.,*}babel*')),
+      ...(await glob('*webpack*')),
+      ...(await glob('package-lock.json')),
+      paths.nodeModules,
+      paths.sshSftp,
+    ]
+    for (const filePath of deleteFiles) {
+      await fs.remove(filePath)
+    }
+  })
+
+  await step('设置项目模式', () => {
+    if (answers.mode) {
+      appPkg.edu = { mode: answers.mode }
+    }
+  })
+
+  await step('修改 package.json 的 scripts', () => {
+    const scripts = appPkg.scripts
+    scripts.start = 'edu-scripts start'
+    scripts.build = 'edu-scripts build'
+    scripts.analyze = 'edu-scripts build --analyze'
+    if (answers.mode !== 'single') {
+      scripts.deploy = `edu-scripts deploy ${answers.deploy.join(' ')}`
+    } else {
+      scripts.deploy = `edu-scripts deploy`
+      scripts['commit-dist'] = 'edu-scripts commit-dist --rm-local'
+    }
+    scripts['one-key-deploy'] = 'npm version patch'
+    scripts.postversion = 'npm run build && npm run deploy'
+  })
+
+  await step('删除 babel/webpack 相关依赖', (spinner) => {
+    const deleteRe =
+      /(babel|autoprefixer|webpack|loader|less|css|sass|hmr|ssh-sftp|regenerator-runtime|nowa)/i
+
+    const deletePkgs = {
+      dependencies: [],
+      devDependencies: [],
+    }
+    Object.entries(deletePkgs).forEach(([scope, pkgs]) => {
+      for (const key in appPkg[scope]) {
+        if (Object.hasOwnProperty.call(appPkg[scope], key)) {
+          if (deleteRe.test(key)) {
+            pkgs.push(key)
+            delete appPkg[scope][key]
+          }
+        }
+      }
+    })
+
+    spinner.clear()
+    console.log(`删除的pkgs\n${chalk.green(JSON.stringify(deletePkgs, null, 2))}\n`)
+    appPkg.devDependencies['@qse/edu-scripts'] = '^' + pkg.version
+  })
+
+  await fs.writeFile(paths.package, JSON.stringify(appPkg, null, 2), 'utf-8')
+
+  open(`${pkg.homepage}#/refactor`)
+
+  console.log(
+    chalk.green(`
+  改造还未完成，剩余步骤请查看文档
+  ${pkg.homepage}#/refactor
+
+  运行 npm i 安装依赖
+  运行 edu-scripts start 启动服务
+  `)
+  )
+}

package/src/build.js

@@ -0,0 +1,74 @@
+process.env.NODE_ENV = 'production'
+process.env.BABEL_ENV = 'production'
+process.env.BROWSERSLIST = '>0.25%, not dead, not op_mini all'
+
+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) {
+  if (args.analyze) {
+    process.env.ANALYZE = '1'
+  }
+  if (args.outputHtml) {
+    process.env.OUTPUT_HTML = '1'
+  }
+
+  const previousSizeMap = await measureFileSizesBeforeBuild(paths.dist)
+  fs.emptyDirSync(paths.dist)
+
+  if (appConfig.single) {
+    fs.copySync(paths.public, paths.resolveApp('dist'))
+  }
+  if (appConfig.mainProject && fs.existsSync(paths.static)) {
+    fs.copySync(paths.static, paths.resolveApp('dist', 'static'))
+  }
+
+  webpack(getConfig(args), (error, stats) => {
+    if (error) {
+      console.log(chalk.red('编译失败'))
+      console.log(chalk.red(error.message || error))
+      console.log()
+      process.exit(1)
+    }
+
+    if (stats.compilation.errors.length) {
+      console.log(chalk.red('编译失败'))
+      console.log(stats.toString({ all: false, errors: true, colors: true }))
+    }
+
+    // Fail the build if running in a CI server
+    if (error || stats.compilation.errors.length) {
+      process.exit(1)
+    }
+
+    console.log(stats.toString({ colors: true, preset: 'errors-warnings', timings: true }))
+    console.log()
+
+    console.log('gzip 后文件大小:\n')
+    printFileSizesAfterBuild(
+      stats,
+      previousSizeMap,
+      paths.dist,
+      WARN_AFTER_BUNDLE_GZIP_SIZE,
+      WARN_AFTER_CHUNK_GZIP_SIZE
+    )
+    console.log()
+
+    if (appConfig.single) {
+      console.log(`打包完成，可以使用 ${chalk.green('@qse/ssh-sftp')} 自动部署代码到 v1`)
+    } else {
+      console.log(`打包完成，可以运行 ${chalk.green('npx edu-scripts deploy')} 部署代码到 v1`)
+    }
+    console.log()
+  })
+}

package/src/cli.js

@@ -0,0 +1,91 @@
+#!/usr/bin/env node
+const pkg = require('../package.json')
+
+// 检查运行条件
+require('./utils/beforeStart')
+
+// eslint-disable-next-line no-unused-expressions
+require('yargs')
+  .usage(`教育工程化 webpack5 基础框架\n文档: ${pkg.homepage}`)
+  .command(
+    'start',
+    '开发',
+    (yargs) =>
+      yargs
+        .option('port', { alias: 'p', desc: '指定端口' })
+        .option('open', { desc: '启动后打开页面' }),
+    (args) => require('./start')(args)
+  )
+  .command(
+    'build',
+    '打包',
+    (yargs) =>
+      yargs
+        .option('analyze', {
+          alias: 'a',
+          desc: '分析代码',
+          default: false,
+          boolean: true,
+        })
+        .option('output-html', {
+          alias: 'o',
+          desc: '输出 html 文件',
+          default: false,
+          boolean: true,
+        }),
+    (args) => require('./build')(args)
+  )
+  .command(
+    'deploy',
+    '自动部署 dist 到 v1 服务器',
+    (yargs) =>
+      yargs
+        .option('school', { alias: 's', desc: '上传到校端', default: false, boolean: true })
+        .option('bureau', { alias: 'b', desc: '上传到局端', default: false, boolean: true })
+        .option('documentshelves', {
+          alias: 'd',
+          desc: '上传到公文',
+          default: false,
+          boolean: true,
+        }),
+    (args) => require('./deploy')(args)
+  )
+  .command(['generator', 'g'], '自动生成代码', (yargs) =>
+    yargs
+      .command(
+        'page',
+        '生成 page 模版, 默认根据环境生成 js/ts 与 less 文件',
+        (yargs) =>
+          yargs
+            .option('name', { desc: '模块名称', string: true })
+            .demandOption('name', '必须输入模块名称')
+            .option('ts', { alias: 't', desc: '生成 ts 文件', boolean: true, default: true })
+            .option('route', {
+              alias: 'r',
+              desc: '生成 index.js 路由文件',
+              boolean: true,
+              default: true,
+            })
+            .option('fc', { alias: 'f', desc: '生成 Function Component 文件', boolean: true }),
+        (args) => require('./generator').page(args)
+      )
+      .command('override', '创建 override 文件', {}, (args) =>
+        require('./generator').override(args)
+      )
+      .command('tailwind', '创建 tailwind 文件', {}, (args) =>
+        require('./generator').tailwind(args)
+      )
+      .command('ts', '创建 tsconfig 文件', {}, (args) => require('./generator').ts(args))
+      .showHelpOnFail(true)
+      .demandCommand(1, '')
+  )
+  .command('auto-refactor', '自动改造项目', {}, () => require('./auto-refactor')())
+  .command(
+    'commit-dist',
+    '提交 dist 目录到 dist 分支',
+    (yargs) => yargs.option('rm-local', { desc: '提交完后删除本地 dist', type: 'boolean' }),
+    (args) => require('./commit-dist')(args)
+  )
+  .showHelpOnFail(true)
+  .demandCommand(1, '')
+  .alias({ v: 'version', h: 'help' }).argv

package/src/commit-dist.js

@@ -0,0 +1,103 @@
+const chalk = require('chalk')
+const paths = require('./config/paths')
+const fs = require('fs-extra')
+const exec = (cmd, opts) =>
+  require('child_process').execSync(cmd, { encoding: 'utf-8', stdio: 'pipe', ...opts })
+const tmp = require('tmp')
+const glob = require('globby')
+
+function validateSVNRoot(root) {
+  const ls = exec(`svn ls ${root}`)
+  return ['trunk', 'branches'].every((s) => ls.includes(s))
+}
+
+function getWorkingCopyInfo() {
+  exec(`svn up`)
+  const url = exec(`svn info --show-item url`).trim()
+  const revision = exec(`svn info --show-item last-changed-revision`).trim()
+  const author = exec(`svn info --show-item last-changed-author`).trim()
+
+  let branch = 'trunk'
+  let root = url.replace(/\/trunk$/, '')
+  if (url.includes('/branches/')) {
+    branch = url.split('/').pop()
+    root = url.replace(/\/branches\/[^/]+$/, '')
+  }
+  let distBranchURL = root + '/branches/dist'
+  let distBranchDirURL = distBranchURL + '/' + branch
+  if (!validateSVNRoot(root)) {
+    console.log(chalk.red('SVN目录不符合规则，必须包含 trunk branches'))
+    process.exit(1)
+  }
+
+  return { url, branch, revision, author, distBranchURL, distBranchDirURL, root }
+}
+
+function copyDistToRepo(info) {
+  const tmpdir = tmp.dirSync().name
+
+  try {
+    exec(`svn ls ${info.distBranchDirURL} --depth empty`)
+  } catch (error) {
+    if (error.message.includes('non-existent')) {
+      exec(
+        `svn mkdir ${info.distBranchDirURL} --parents -m "[edu-scripts] create ${info.branch} dist"`
+      )
+    } else {
+      throw error
+    }
+  }
+  exec(`svn co ${info.distBranchDirURL} ${tmpdir}`)
+
+  let files = glob.sync('**/*', { cwd: tmpdir })
+  exec(`svn rm "${files.join('" "')}"`, { cwd: tmpdir })
+
+  fs.copySync(paths.dist, tmpdir)
+
+  files = glob.sync('**/*', { cwd: tmpdir })
+  exec(`svn add "${files.join('" "')}"`, { cwd: tmpdir })
+
+  const msg = `[edu-scripts] commit ${info.branch} dist #${info.revision} @${info.author}`
+  exec(`svn ci -m "${msg}"`, { cwd: tmpdir })
+
+  fs.removeSync(tmpdir)
+}
+
+/**
+ * svn commit dist folder to dish branches
+ *
+ * @param {Object} args
+ * @param {boolean} args.rmLocal
+ */
+module.exports = async function commitDist(args) {
+  if (!fs.existsSync(paths.dist)) {
+    console.log(chalk.red('未找到 dist 文件夹，请先 edu-scpirts build'))
+    process.exit(1)
+  }
+
+  if (exec('svn st').trim().length) {
+    console.log(chalk.red('似乎存在未提交的代码，请提交后重试。运行 svn st 查看具体信息'))
+    process.exit(1)
+  }
+
+  const info = getWorkingCopyInfo()
+
+  console.log(
+    chalk.green(
+      [
+        `分支: ${info.branch}`,
+        `版本: ${info.revision}`,
+        `作者: ${info.author}`,
+        `地址: ${info.distBranchDirURL}`,
+      ].join('\n')
+    )
+  )
+
+  copyDistToRepo(info)
+
+  if (args.rmLocal) {
+    fs.removeSync(paths.dist)
+  }
+
+  console.log(chalk.green('提交完成'))
+}

package/src/config/babel.dependencies.js

@@ -0,0 +1,65 @@
+const getOverride = require('../utils/getOverride')
+
+/**
+ * @typedef {Object} Opts
+ * @property {string} [modules]
+ *
+ * @param {Opts} [opts]
+ * @return {*}
+ */
+module.exports = function getBabelConfig(opts = {}) {
+  const isDev = process.env.NODE_ENV === 'development'
+
+  let config = {
+    cacheDirectory: true,
+    cacheCompression: false,
+    babelrc: false,
+    configFile: false,
+    sourceType: 'unambiguous',
+    compact: false,
+    sourceMaps: isDev,
+    inputSourceMap: isDev,
+    presets: [
+      [
+        '@babel/preset-env',
+        {
+          modules: opts.modules,
+          useBuiltIns: 'entry',
+          corejs: 3,
+          // Exclude transforms that make all code slower
+          exclude: ['transform-typeof-symbol'],
+        },
+      ],
+    ].filter(Boolean),
+    plugins: [
+      [
+        '@babel/plugin-transform-runtime',
+        {
+          corejs: false,
+          helpers: true,
+          // By default, babel assumes babel/runtime version 7.0.0-beta.0,
+          // explicitly resolving to match the provided helper functions.
+          // https://github.com/babel/babel/issues/10261
+          version: require('@babel/runtime/package.json').version,
+          regenerator: true,
+          // // https://babeljs.io/docs/en/babel-plugin-transform-runtime#useesmodules
+          // // We should turn this on once the lowest version of Node LTS
+          // // supports ES Modules.
+          // useESModules: true,
+        },
+      ],
+      [
+        'import',
+        { libraryName: 'lodash', libraryDirectory: '', camel2DashComponentName: false },
+        'lodash',
+      ],
+    ].filter(Boolean),
+  }
+
+  const override = getOverride()
+  if (override.babel) {
+    config = override.babel(config, 'node_modules') || config
+  }
+
+  return config
+}

package/src/config/babel.js

@@ -0,0 +1,88 @@
+const fs = require('fs')
+const paths = require('./paths')
+const appConfig = require('../utils/appConfig')
+const getOverride = require('../utils/getOverride')
+const hasJsxRuntime = (() => {
+  try {
+    require.resolve('react/jsx-runtime')
+    return true && appConfig.single
+  } catch (error) {
+    return false
+  }
+})()
+
+/**
+ * @typedef {Object} Opts
+ * @property {string} [modules]
+ *
+ * @param {Opts} [opts]
+ * @return {*}
+ */
+module.exports = function getBabelConfig(opts = {}) {
+  const isTypeScriptEnabled = fs.existsSync(paths.tsconfig)
+  const isDev = process.env.NODE_ENV === 'development'
+
+  let config = {
+    cacheDirectory: true,
+    cacheCompression: false,
+    compact: !isDev,
+    babelrc: false,
+    configFile: false,
+    presets: [
+      [
+        '@babel/preset-env',
+        {
+          modules: opts.modules,
+          useBuiltIns: 'entry',
+          corejs: 3,
+          // Exclude transforms that make all code slower
+          exclude: ['transform-typeof-symbol'],
+        },
+      ],
+      [
+        '@babel/preset-react',
+        {
+          development: isDev,
+          runtime: hasJsxRuntime ? 'automatic' : 'classic',
+          useBuiltIns: !hasJsxRuntime,
+        },
+      ],
+      isTypeScriptEnabled && '@babel/preset-typescript',
+    ].filter(Boolean),
+    plugins: [
+      [
+        '@babel/plugin-transform-runtime',
+        {
+          corejs: false,
+          helpers: true,
+          // By default, babel assumes babel/runtime version 7.0.0-beta.0,
+          // explicitly resolving to match the provided helper functions.
+          // https://github.com/babel/babel/issues/10261
+          version: require('@babel/runtime/package.json').version,
+          regenerator: true,
+          // // https://babeljs.io/docs/en/babel-plugin-transform-runtime#useesmodules
+          // // We should turn this on once the lowest version of Node LTS
+          // // supports ES Modules.
+          // useESModules: true,
+        },
+      ],
+      ['@babel/plugin-proposal-decorators', { legacy: true }],
+      ['@babel/plugin-proposal-class-properties', { loose: true }],
+      ['@babel/plugin-proposal-private-methods', { loose: true }],
+      ['@babel/plugin-proposal-private-property-in-object', { loose: true }],
+      [
+        'import',
+        { libraryName: 'lodash', libraryDirectory: '', camel2DashComponentName: false },
+        'lodash',
+      ],
+      isDev && 'react-refresh/babel',
+    ].filter(Boolean),
+  }
+
+  const override = getOverride()
+  if (override.babel) {
+    config = override.babel(config, 'src') || config
+  }
+
+  return config
+}

package/src/config/paths.js

@@ -0,0 +1,37 @@
+const path = require('path')
+const fs = require('fs')
+const glob = require('globby')
+
+function resolveApp(...filePath) {
+  return path.resolve(process.cwd(), ...filePath)
+}
+
+function getExistPath(...paths) {
+  for (const path of paths) {
+    if (fs.existsSync(path)) {
+      return path
+    }
+  }
+  return paths[0]
+}
+
+const paths = {
+  resolveApp,
+  eduAppEnv: resolveApp('src', 'edu-app-env.d.ts'),
+  dist: resolveApp('dist'),
+  sshSftp: resolveApp('.sftprc.json'),
+  nodeModules: resolveApp('node_modules'),
+  tsconfig: resolveApp('tsconfig.json'),
+  jsconfig: resolveApp('jsconfig.json'),
+  package: resolveApp('package.json'),
+  tailwind: resolveApp('tailwind.config.js'),
+  indexJS: resolveApp('src', 'index.js'),
+  pages: resolveApp('src', 'pages'),
+  override: resolveApp('edu-scripts.override.js'),
+  indexHTML: glob.sync('./public/*.html', { absolute: true }),
+  src: resolveApp('src'),
+  public: resolveApp('public'),
+  static: resolveApp('public', 'static'),
+  theme: getExistPath(resolveApp('theme.json'), resolveApp('theme.js')),
+}
+module.exports = paths

package/src/config/plugins/postcss-safe-area.js

@@ -0,0 +1,21 @@
+const vars = [
+  'safe-area-inset-top',
+  'safe-area-inset-bottom',
+  'safe-area-inset-left',
+  'safe-area-inset-right',
+]
+
+const expr = new RegExp(`env\\(\\s*(${vars.join('|')})\\s*,?\\s*([^)]+)?\\s*\\)`, 'g')
+
+/** @type {import('postcss').PluginCreator} */
+module.exports = () => {
+  return {
+    postcssPlugin: 'postcss-safe-area',
+    Declaration(decl) {
+      const fallback = decl.value.replace(expr, (match, param, defaultValue) => defaultValue || '0')
+      if (fallback !== decl.value) {
+        decl.cloneBefore({ value: fallback })
+      }
+    },
+  }
+}