@qse/edu-scripts 0.0.0-beta.2 → 0.0.0-beta.4

package/src/config/webpackDevServerConfig.js

@@ -1,4 +1,4 @@
-import setupMockServer from './plugins/mock-server/index.js'
+import setupMockServer from './plugins/mock-server'
 
 function createProxy(context, target, origin) {
   const url = new URL(origin || target)
@@ -17,7 +17,7 @@ function createProxy(context, target, origin) {
 
 /**
  * @param {*} args
- * @param {import('../utils/defineConfig').Config} override
+ * @param {import('../utils/defineConfig.js').Configuration} override
  */
 export default function getWebpackDevServerConfig(args, override) {
   const host = process.env.HOST || '0.0.0.0'
@@ -27,7 +27,6 @@ export default function getWebpackDevServerConfig(args, override) {
     allowedHosts: 'all',
     historyApiFallback: true,
     port: args.port,
-    open: args.open,
     host,
     client: {
       webSocketURL: 'auto://0.0.0.0:0/ws',

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

@@ -1,9 +1,10 @@
+// @ts-ignore
 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'
+// @ts-ignore
+import changeDeployVersion from './utils/changeDeployVersion'
 import ora from 'ora'
 import appConfig from './utils/appConfig.js'
 import { format } from 'prettier'
@@ -19,8 +20,8 @@ const baseConfig = {
   noWarn: true,
 }
 
-async function normalDeploy(args) {
-  const resolve = (...pathSegments) => path.resolve(process.cwd(), ...pathSegments)
+async function normalDeploy(args: DeployArgs) {
+  const resolve = paths.resolveApp
 
   /**
    * 生成路径
@@ -30,7 +31,7 @@ async function normalDeploy(args) {
    * @name tmpBase 本地临时文件夹 到`__tmp__`层
    * @param {string} remoteFilePath 远程文件相对`opts.remotePath`地址
    */
-  function getLocalAndRemoteFilePath(remoteFilePath, opts) {
+  function getLocalAndRemoteFilePath(remoteFilePath: string, opts: any) {
     const splited = remoteFilePath.split('/')
     const fileName = splited[splited.length - 1]
     const tmpBase = resolve(opts.localPath, '__tmp__')
@@ -47,13 +48,13 @@ async function normalDeploy(args) {
     date = new Date(date.getTime() - date.getTimezoneOffset() * 60000)
     return date.toISOString().replace(/T/, ' ').replace(/\..+/, '')
   }
-  function updateLogContent(content, info) {
+  function updateLogContent(content: string, info: any) {
     const lines = content.trim().split('\n')
     lines.push(`[${dateTime()}] ${JSON.stringify(info)}\n`)
     return lines.slice(-50).join('\n')
   }
 
-  async function upload(opts) {
+  async function upload(opts: any) {
     // 上传dist文件
     const { sftp, opts: fullOpts } = await sshSftp(opts)
 
@@ -95,14 +96,14 @@ async function normalDeploy(args) {
         try {
           await sftp.fastGet(remoteLogFile, tmpLogFile)
           content = await fs.readFile(tmpLogFile, 'utf-8')
-        } catch (error) {}
+        } catch (_error: any) {}
         content = updateLogContent(content, info)
         await fs.writeFile(tmpLogFile, content)
         await sftp.fastPut(tmpLogFile, remoteLogFile)
       }
 
       spinner.succeed('已更新 ver.js 版本配置')
-    } catch (e) {
+    } catch (e: any) {
       spinner.fail(`自动修改 ver.js 失败，请手动修改`)
       console.log(chalk.bgRed(e.message))
     } finally {
@@ -123,19 +124,19 @@ async function normalDeploy(args) {
     },
   }
   const uploadSftpConfigs = []
-  if (args.b) {
+  if (args.bureau) {
     uploadSftpConfigs.push(presetConfig.b)
   }
-  if (args.s) {
+  if (args.school) {
     uploadSftpConfigs.push(presetConfig.s)
   }
-  if (args.d) {
+  if (args.documentshelves) {
     uploadSftpConfigs.push(presetConfig.d)
   }
-  if (args.c) {
+  if (args.compositionshelves) {
     uploadSftpConfigs.push(presetConfig.c)
   }
-  if (args.cd) {
+  if (args.compositionshelvesDingtalk) {
     uploadSftpConfigs.push(presetConfig.cd)
   }
   if (uploadSftpConfigs.length === 0) {
@@ -173,7 +174,14 @@ async function singleDeploy() {
   sshSftp(config)
 }
 
-export default function deploy(args) {
+interface DeployArgs {
+  school?: boolean
+  bureau?: boolean
+  documentshelves?: boolean
+  compositionshelves?: boolean
+  compositionshelvesDingtalk?: boolean
+}
+export default function deploy(args: DeployArgs) {
   if (appConfig.single) {
     singleDeploy()
   } else {

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

@@ -1,16 +1,8 @@
-import path from 'path'
 import fs from 'fs-extra'
-import paths from './config/paths.js'
+import paths from './config/paths'
 import chalk from 'chalk'
-import { fileURLToPath } from 'node:url'
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url))
-
-/**
- * @param {string[]} args
- * @returns {string}
- */
-const getTmpPath = (...args) => path.resolve(__dirname, 'asset', 'template', ...args)
+const getTmpPath = (...args: string[]) => paths.resolveOwn('asset', 'template', ...args)
 
 async function generatorOverride() {
   if (fs.existsSync(paths.override)) {

package/src/index.ts

@@ -1,2 +1,2 @@
-export { defineConfig } from './utils/defineConfig.js'
-export { defineMock } from './config/plugins/mock-server/defineMock.js'
+export { defineConfig } from './utils/defineConfig'
+export { defineMock } from './config/plugins/mock-server/defineMock'

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

@@ -3,13 +3,17 @@ import { RspackDevServer } from '@rspack/dev-server'
 import getConfig from './utils/getConfig.js'
 import chalk from 'chalk'
 
-export default async function start(args) {
+interface StartArgs {
+  port?: string
+}
+export default async function start(args: StartArgs) {
   process.env.NODE_ENV = 'development'
   process.env.BABEL_ENV = 'development'
   process.env.BROWSERSLIST = 'chrome >= 70'
   process.env.WEBPACK_DEV_SERVER_BASE_PORT = '3000'
 
   const basePort = process.env.WEBPACK_DEV_SERVER_BASE_PORT
+  // @ts-ignore
   const port = await RspackDevServer.getFreePort(args.port || process.env.PORT)
   if (!(args.port || process.env.PORT) && +port !== +basePort) {
     console.log(chalk.bgYellow(`${basePort} 端口已被占用，现切换到 ${port} 端口运行`))
@@ -17,19 +21,20 @@ export default async function start(args) {
   args.port = port
   process.env.PORT = port
 
-  const compiler = rspack(getConfig(args))
+  const config = getConfig(args)
+  const compiler = rspack(config)
   const middleware = rspack.lazyCompilationMiddleware(compiler)
-  const oldSetupMiddlewares = compiler.options.devServer.setupMiddlewares
-  compiler.options.devServer.setupMiddlewares = (middlewares, devServer) => {
+  const oldSetupMiddlewares = config.devServer.setupMiddlewares
+  config.devServer.setupMiddlewares = (middlewares: any, devServer: any) => {
     if (oldSetupMiddlewares) {
       middlewares = oldSetupMiddlewares(middlewares, devServer)
     }
     middlewares.unshift(middleware)
     return middlewares
   }
-  const devServer = new RspackDevServer(compiler.options.devServer, compiler)
+  const devServer = new RspackDevServer(config.devServer, compiler)
   devServer.start()
-  ;[('SIGINT', 'SIGTERM')].forEach(function (sig) {
+  ;['SIGINT', 'SIGTERM'].forEach(function (sig) {
     process.on(sig, function () {
       devServer.stop()
       process.exit()

package/src/utils/FileSizeReporter.js

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import fs from 'fs'
+import fs from 'fs-extra'
 import path from 'path'
 import chalk from 'chalk'
 import filesize from 'filesize'
@@ -58,7 +58,7 @@ function printFileSizesAfterBuild(
   assets.sort((a, b) => b.size - a.size)
 
   // move main file to first
-  var mainAssetIdx = assets.findIndex((asset) => /_\d+\.\d+\.\d+\./.test(asset.name))
+  var mainAssetIdx = assets.findIndex((asset) => /_\d+\.\d+\.\d+/.test(asset.name))
   assets.unshift(assets.splice(mainAssetIdx, 1)[0])
 
   var longestSizeLabelLength = Math.max.apply(

package/src/utils/{appConfig.js → appConfig.ts}

@@ -1,4 +1,4 @@
-import paths from '../config/paths.js'
+import paths from '../config/paths'
 import fs from 'fs-extra'
 
 const appPkg = fs.readJsonSync(paths.package)

package/src/utils/{beforeStart.js → beforeStart.ts}

@@ -1,12 +1,10 @@
 import fs from 'fs-extra'
-import paths from '../config/paths.js'
+import paths from '../config/paths'
 import chalk from 'chalk'
 import semver from 'semver'
-import appConfig from './appConfig.js'
-import { fileURLToPath } from 'node:url'
-
-const pkg = fs.readJsonSync(fileURLToPath(import.meta.resolve('../../package.json')))
+import appConfig from './appConfig'
 
+const pkg = fs.readJsonSync(paths.resolveOwn('package.json'))
 const appPkg = fs.readJsonSync(paths.package)
 
 if (semver.valid(appPkg.version) === null) {
@@ -53,3 +51,14 @@ if (appPkg.browserslist) {
   delete appPkg.browserslist
   fs.writeFileSync(paths.package, JSON.stringify(appPkg, null, 2), 'utf-8')
 }
+
+if (appPkg.eslintConfig) {
+  console.log(
+    chalk.yellow('package.json 中 eslintConfig 已废弃，请改用 @qse/eslint-config 进行配置')
+  )
+  console.log(chalk.yellow('npm i eslint @qse/eslint-config -D'))
+  console.log()
+  console.log(chalk.gray('新建 eslint.config.mjs 文件，内容如下：'))
+  console.log(chalk.yellow('import config from "@qse/eslint-config"'))
+  console.log(chalk.yellow('export default config'))
+}

package/src/utils/changeDeployVersion.js

@@ -8,9 +8,9 @@ function changeDeployVersion(code, pkg) {
   const { name, version, grayscale } = pkg
   let ast
   try {
-    ast = parse(code)
+    ast = parse(code, { filename: 'ver.js' })
   } catch (error) {
-    throw new Error(`代码解析错误: ${error.message}`)
+    throw new Error(`代码解析错误: ${error.message}`, { cause: error })
   }
   const keyName = grayscale ? 'grayscale' : 'main'
 
@@ -113,7 +113,7 @@ function changeDeployVersion(code, pkg) {
   }
   deleteModuleComments(targetPath)
 
-  return transformFromAstSync(ast, undefined, { minified: true }).code
+  return transformFromAstSync(ast, undefined, { filename: 'ver.js', minified: true }).code
 }
 
 export default changeDeployVersion

package/src/utils/defineConfig.ts

@@ -1,5 +1,5 @@
 import type { Chalk } from 'chalk'
-import type { Compiler, Configuration } from '@rspack/core'
+import type { Compiler, Configuration as RspackConfiguration } from '@rspack/core'
 import type { Configuration as DevServerConfiguration } from '@rspack/dev-server'
 
 type ProxyConfigArray = NonNullable<DevServerConfiguration['proxy']>
@@ -11,8 +11,8 @@ export type BabelImportPlugin = {
   style?: boolean | 'css' | string
 }
 
-export type Config = {
-  webpack?: (config: Configuration) => Configuration | undefined
+export type Configuration = {
+  webpack?: (config: RspackConfiguration) => RspackConfiguration | undefined
   devServer?: (config: DevServerConfiguration) => DevServerConfiguration | undefined
   /**
    * webpack alias 配置，会与内置 alias 合并
@@ -83,6 +83,6 @@ export type Config = {
    */
   import?: BabelImportPlugin[]
 }
-export function defineConfig(config: Config) {
+export function defineConfig(config: Configuration) {
   return config
 }

package/src/utils/{exec.js → exec.ts}

@@ -1,5 +1,5 @@
 import cp from 'child_process'
-const exec = (cmd) => {
+const exec = (cmd: string) => {
   console.log(`> ${cmd}`)
   return cp.execSync(cmd, { stdio: 'inherit', encoding: 'utf-8' })
 }

package/src/utils/{getConfig.js → getConfig.ts}

@@ -1,8 +1,10 @@
-import getWebpackConfig from '../config/webpackConfig.js'
-import getWebpackDevServerConfig from '../config/webpackDevServerConfig.js'
-import getOverride from './getOverride.js'
+// @ts-ignore
+import getWebpackConfig from '../config/webpackConfig'
+// @ts-ignore
+import getWebpackDevServerConfig from '../config/webpackDevServerConfig'
+import getOverride from './getOverride'
 
-function getConfig(args) {
+function getConfig(args: any) {
   const override = getOverride()
 
   let webpackConfig = getWebpackConfig(args, override)

package/src/utils/{getOverride.js → getOverride.ts}

@@ -1,10 +1,11 @@
 import fs from 'fs-extra'
-import paths from '../config/paths.js'
+import paths from '../config/paths'
 import { createRequire } from 'node:module'
+import { type Configuration } from './defineConfig'
+
 const require = createRequire(import.meta.url)
 
-/** @type {import('./defineConfig').Config} */
-const defaultOverride = {
+const defaultOverride: Configuration = {
   minify: true,
   proxy: [],
   extraPostCSSPlugins: [],
@@ -12,12 +13,9 @@ const defaultOverride = {
   pure_funcs: ['console.log'],
 }
 
-let override = null
+let override: Configuration | null = null
 
-/**
- * @return {import('./defineConfig').Config}
- */
-export default function getOverride() {
+export default function getOverride(): Configuration {
   if (override) return override
 
   override = Object.assign({}, defaultOverride)

package/tsconfig.json

@@ -1,8 +1,8 @@
 {
   "compilerOptions": {
     "target": "esnext",
-    "module": "node16",
-    "moduleResolution": "node16",
+    "module": "preserve",
+    "moduleResolution": "bundler",
     "importHelpers": true,
     "jsx": "react",
     "esModuleInterop": true,
@@ -11,7 +11,6 @@
     "strict": true,
     "paths": {
       "@/*": ["src/*"],
-      "@@/*": ["src/.umi/*"]
     },
     "allowSyntheticDefaultImports": true,
     "skipLibCheck": true,

package/tsdown.config.ts

@@ -0,0 +1,5 @@
+import { defineConfig } from 'tsdown'
+
+export default defineConfig({
+  entry: ['src/index.ts', 'src/cli.js'],
+})

package/docs/.vitepress/config.ts

@@ -1,35 +0,0 @@
-import { defineConfig } from 'vitepress'
-import fs from 'fs-extra'
-import path from 'path'
-
-const mds = fs.readdirSync(path.resolve(import.meta.dirname, '..')).filter((s) => s.endsWith('.md'))
-
-const sidebarItems = mds
-  .map((file) => {
-    const md = fs.readFileSync(path.resolve(import.meta.dirname, '..', file), 'utf-8')
-    const title = md.split('\n')[0].match(/#\s+(.+)/)?.[1]
-    if (title) {
-      return { text: title, link: `/${file.replace('.md', '')}` }
-    }
-    return null
-  })
-  .filter((o) => !!o)
-
-// https://vitepress.dev/reference/site-config
-export default defineConfig({
-  title: '@qse/edu-scripts',
-  description: '教育工程化基础框架',
-  base: '/qsxxwapdev/edu-scripts/',
-  themeConfig: {
-    // https://vitepress.dev/reference/default-theme-config
-    nav: [],
-
-    sidebar: [
-      { text: '快速开始', link: '/install' },
-      { text: '更新日志', link: '/changelog' },
-      { text: '教程', items: sidebarItems },
-    ],
-
-    socialLinks: [{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }],
-  },
-})

package/docs/changelog.md

@@ -1 +0,0 @@
-<!-- @include: ../CHANGELOG.md -->

package/docs/debug.md

@@ -1,17 +0,0 @@
-# 代码调试
-
-## 使用 `React Developer Tools` 调试
-
-1. 安装 `React Developer Tools` 插件
-2. 打开控制台(F12)
-3. 切换到 `Component` 标签页
-4. 选中需要查看的组件，可以看到 `state/props/hooks` 等信息
-
-## 使用 vscode 调试代码
-
-1. 打开 `JavaScript Debug Terminal` 终端，输入 `npm run start` 命令启动项目。
-
-![](https://p0.meituan.net/dpplatform/78a65449d74d1fbd61cc47e98c419a011041253.gif)
-
-2. 按住 `ctrl/command` 点击 `http://localhost:port` 打开链接
-3. 代码里打断点，网页点击触发断点

package/docs/deploy.md

@@ -1,54 +0,0 @@
-# 部署 v1
-
-项目使用 [@qse/ssh-sftp][1] 部署代码到 v1 环境
-
-## 教育模式
-
-支持 局端/校端/公文 部署。无需额外的配置即可使用
-
-```bash
-# 局端
-npx edu-scripts deploy -b
-
-# 校端
-npx edu-scripts deploy -s
-
-# 公文
-npx edu-scripts deploy -d
-```
-
-## 独立模式
-
-### 默认部署
-
-默认会部署到 `/qsxxwapdev/${package.name}` 路径下
-
-```bash
-npx edu-scripts deploy
-```
-
-### 自定义部署
-
-自定义配置部署路径
-
-```bash
-# 生成配置文件
-npx ssh-sftp init
-```
-
-编辑配置文件
-
-```json
-{
-  "$schema": "http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/sftprc.schema.json",
-  "preset": {
-    "context": "qsxxwapdev"
-  }
-}
-```
-
-可以使用预设配置，`npx ssh-sftp show-config` 查看最终的配置
-
-其余配置请看 [@qse/ssh-sftp][1]
-
-[1]: http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/

package/docs/faq.md

@@ -1,144 +0,0 @@
-# 错误处理
-
-## moment 没有 external 掉
-
-全局搜索 `moment/locale/zh-cn`，把这些引入都删除掉即可
-
-## ueditor 提示 css 文件加载不到
-
-移动 `src/ueditor` 到 `public/ueditor`, 导入地址也修改下
-
-例子: `require('../../../public/ueditor/<something>')`
-
-## style 文件报错
-
-```js
-import * as style from './index.less'
-//=> 改成
-import style from './index.less'
-```
-
-## 如果判断是缺少 `alias` 配置，使用 `npx edu-scripts g override` 生成配置文件，并且配置 `alias` 参数
-
-```js
-const { defineConfig } = require('@qse/edu-scripts')
-const path = require('path')
-
-module.exports = defineConfig({
-  alias: {
-    pages: path.resolve('src/pages'),
-  },
-})
-```
-
-## 动态导入 `import`，webpack4 以后 `import` 默认导出改成 `default`
-
-```js
-// 以前写法
-import('lodash/get').then((get) => {
-  get()
-})
-
-// 现在写法
-import('lodash/get').then(({ default: get }) => {
-  get()
-})
-```
-
-## `react` 组件热更新失效
-
-把上面的 `CDN` 加入到首页(index\*.html)中
-
-其中 `process.env.NODE_ENV` 那段代码是关键
-
-热更新需要 react16，请阅读[升级指南](/refactor-react-16)
-
-## 主文件过大，代码分割失效
-
-检查是否有 `require('./chunkfile').default` 这种写法，这会导致代码分割失效，直接打进 main 中
-
-```js
-export default (callback) => {
-  require.ensure([], (require) => {
-    // 错误例子
-    callback(require('./chunkfile').default)
-
-    // 正确写法
-    const mod = require('./chunkfile')
-    callback(mod.default)
-  })
-}
-```
-
-另外，webpack2 开始就不推荐使用 `require.ensure` 做代码分割了。现在可以使用 `import` 方式代码分割
-
-```js
-export default (callback) => {
-  import(/* webpackChunkName: 'chunkfileName' */ './chunkfile').then((mod) => {
-    callback(mod.default)
-  })
-}
-```
-
-## 子工程不能含有 public/static，现已自动删除
-
-子工程不能含有 static 是因为 新建子工程 如果拷贝了主工程代码，那 static 也复制了，打包部署 v1 后可能会覆盖主工程的 static。而且子工程本身就不应该有 static，不可以引入本地外部资源
-
-## qsbAntd is not defiend
-
-子工程项目如果出现这个错误，引入下面的静态资源
-
-```html
-<!-- 确保已经引入 react moment antd -->
-<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/react-dev-preset.js"></script>
-<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/moment2.29.1.js"></script>
-<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/antd3.26.20.js"></script>
-
-<!-- 引入 @qsb/antd -->
-<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/qsb-antd.min.js"></script>
-```
-
-## 钉钉遇到页面打开白屏
-
-这种情况多半是链接中带了 hash，导致页面跳转失败。（复制出来可能是新的链接，但页面其实是老的并未跳转）
-
-将下面两段代码分别加入对应的文件中，必须保证其位置在所有 `script` 最前面
-
-原理： 将 hash 转存至 localStorage，跳转后再取出
-
-```html
-<!-- index.html -->
-<script>
-  ;(function () {
-    var searchString = location.search
-    if (!/(\?|&)S=/.test(searchString)) {
-      var randomHexString = Math.random().toString(32).substring(2)
-      searchString = searchString.substring(1)
-      searchString = '?S=' + randomHexString + (searchString.length > 0 ? '&' + searchString : '')
-    }
-    if (location.hash) {
-      localStorage.setItem('qse:H', location.hash)
-    }
-    var pathnameArr = location.pathname.split('/')
-    var pathname = pathnameArr.slice(0, -1).concat('index1.html').join('/')
-    var __tmp_URL = location.origin + pathname + searchString
-    history.replaceState(null, document.title, __tmp_URL)
-    location.reload()
-  })()
-</script>
-```
-
-```html
-<!-- index1.html -->
-<script>
-  ;(function () {
-    var hash = localStorage.getItem('qse:H')
-    if (hash) {
-      localStorage.removeItem('qse:H')
-      hash = /^#/.test(hash) ? hash : '#' + hash
-      var url = location.origin + location.pathname + location.search + hash
-      history.replaceState(history.state, null, url)
-    }
-  })()
-</script>
-```