@qse/edu-scripts 1.12.0

package/CHANGELOG.md

@@ -0,0 +1,333 @@
+# 更新日志
+
+## 1.12.0 (2022-09-28)
+
+- chore: 修改组织名 @qse，发布公网
+
+## 1.11.44 (2022-09-21)
+
+- feat: 增加 postcss-safe-area 插件，适配 env
+
+## 1.11.43 (2022-09-07)
+
+- feat: 增加 postcss-momentum-scrolling 插件，为所有 `overflow: auto/scroll` 自动增加 `-webkit-overflow-scrolling: touch`
+
+## 1.11.42 (2022-09-03)
+
+- fix: deploy 读取 ssh-sftp 错误
+
+## 1.11.41 (2022-09-02)
+
+- feat: start 增加 --open 参数
+- feat: webpack-dev-server 显示 overlay
+
+## 1.11.40 (2022-08-17)
+
+- refactor: 内部 externals 逻辑重构
+- feat: 启用 filesystem cache
+- feat: 显示编译时间
+
+## 1.11.39 (2022-08-17)
+
+- fix: proxy 顺序调整，用户配置更优先
+
+## 1.11.38 (2022-08-09)
+
+- refactor: 成功修改 ver.js 后再进行备份，教育工程上传时忽略 ver.js
+
+## 1.11.37 (2022-08-04)
+
+- refactor: 主工程打包不复制 public，改成复制 public/static
+- feat: deploy 修改 ver.js 前做个备份
+
+## 1.11.36 (2022-08-03)
+
+- refactor: 重构 CDN 判断
+- refactor: 修改 auto-refactor 提示语，执行完后自动打开文档页面
+- docs: 增加 react16 升级指南
+
+## 1.11.35 (2022-08-01)
+
+- feat: override 增加 extraPostCSSPlugins 参数
+
+## 1.11.34 (2022-07-27)
+
+- fix: 修复 globby 匹配失败
+
+## 1.11.33 (2022-07-26)
+
+- feat: @svgr/webpack 移除 ref 配置项, 这个修改让框架不再依赖 react16
+
+## 1.11.32 (2022-07-19)
+
+- refactor: build 从复制 public/static 改成复制 public 文件夹。[差异化看这里](/mode)
+
+## 1.11.31 (2022-07-15)
+
+- refactor: glob to globby
+
+## 1.11.30 (2022-07-15)
+
+- refactor: 重构 auto-refactor，使用 promise 替换 sync
+
+## 1.11.29 (2022-07-15)
+
+- fix: extensions add .web.js
+
+## 1.11.28 (2022-07-13)
+
+- fix: 修复 override proxy 默认值错误
+
+## 1.11.27 (2022-07-12)
+
+- refactor: 删除 react-error-overlay
+
+## 1.11.26 (2022-07-12)
+
+- fix: override proxy 类型错误
+
+## 1.11.25 (2022-07-12)
+
+- feat: override 增加 proxy，支持自定义接口代理
+
+## 1.11.24 (2022-07-12)
+
+- refactor: dev-server proxt 改用 Array 形式
+
+## 1.11.23 (2022-07-12)
+
+- feat: override 增加 define, 支持自定义参数
+
+## 1.11.22 (2022-07-08)
+
+- chore: 更新 tailwindcss 模版
+- chore: 删除无用的依赖
+- chore: 更新 eslint-config-qsb-react 版本
+
+## 1.11.21 (2022-07-04)
+
+- chore: 增加 rimraf 依赖
+
+## 1.11.20 (2022-06-14)
+
+- feat: 增加 @types/tailwindcss 依赖，更新 tailwindcss 模版
+
+## 1.11.19 (2022-06-13)
+
+- chore: 升级依赖版本
+
+## 1.11.18 (2022-06-08)
+
+- fix: 移除 webpack resolve modules 配置
+
+## 1.11.17 (2022-06-08)
+
+- fix: 修改 webpack resolve modules 配置
+
+## 1.11.16 (2022-06-07)
+
+- fix: 使用 postcss-preset-env 默认 [stage](https://preset-env.cssdb.org/features/#stage-2)
+
+## 1.11.15 (2022-05-24)
+
+- chore: 增加 prettier `tailwindcss` 插件
+
+## 1.11.14 (2022-05-24)
+
+- chore: 删除 prettier `组织 import` 插件
+
+## 1.11.13 (2022-05-24)
+
+- feat: prettier 增加 `组织 import` 插件
+- feat: generator tailwindcss 时候提示安装 `prettier-plugin-tailwindcss` 插件
+- chore: 添加 typescript 到依赖
+
+## 1.11.12 (2022-05-24)
+
+- fix: 修复 react-error-overlay 报错 `process is not defined`
+
+## 1.11.11 (2022-05-24)
+
+- feat: 增加两个环境变量 `process.env.APP_NAME` `process.env.APP_VERSION`
+
+## 1.11.10 (2022-05-20)
+
+- feat: auto-refactor 增加模式选择
+- refactor: 增加 qsb CDN 判断，自动 external 对应的模块
+
+## 1.11.9 (2022-05-17)
+
+- fix: auto-refactor scripts typo
+
+## 1.11.8 (2022-05-12)
+
+- feat: commit-dist 显示正在提交的信息
+
+## 1.11.7 (2022-05-06)
+
+- feat: auto-refactor 命令适配公文
+- fix: 修复 commit-dist 获取 info 记录错误
+
+## 1.11.6 (2022-05-05)
+
+- feat: 增加 commit-dist 命令
+
+## 1.11.5 (2022-04-25)
+
+- chore: 删除无用的 ofd.js 特殊规则
+- feat: 更新 @qsb/ssh-sftp 和 react-refresh
+
+## 1.11.4 (2022-04-25)
+
+- feat: 使用 esbuild 压缩代码，它比 terser 快 20-40 倍，实际压缩率差 10%左右。[Benchmarks](https://github.com/privatenumber/minification-benchmarks)
+- feat: override 增加 minify 选项
+
+## 1.11.3 (2022-04-18)
+
+- feat: override 增加 transformNodeModules 配置
+- feat: 优化 override webpack/babel 的返回值
+
+## 1.11.2 (2022-04-15)
+
+- feat: override 增加 babel 配置
+- refactor: 移除 lodash alias， 增加 babel-plugin-import lodash
+
+## 1.11.1 (2022-04-14)
+
+- fix: 教育集成模式不使用 `@babel/preset-react automatic mode`
+
+## 1.11.0 (2022-04-12)
+
+- chore: 调整适配，默认编译 node_modules 所有文件
+
+## 1.10.6 (2022-04-09)
+
+- feat: 增加 `generator tailwind` 命令
+- feat: 可配置是否清理 `console.log`
+- fix: 修复 `https:` 协议启动失败
+- refactor: 重构 `babel` 相关配置
+
+## 1.10.5 (2022-03-31)
+
+- fix: `@babel/preset-react` change runtime to `automatic`
+- refactor: 移除 `cache: 'filesystem'` 设置
+
+## 1.10.4 (2022-03-29)
+
+- feat: 支持 `tailwindcss`
+- revert: feat: `@babel/preset-react` change runtime to `automatic`
+
+## 1.10.3 (2022-03-29)
+
+- feat: 打包不再生成 LICENSE 文件
+
+## 1.10.2 (2022-03-25)
+
+- feat: 重构 override 功能
+- feat: `@babel/preset-react` change runtime to `automatic`
+
+## 1.10.1 (2022-03-15)
+
+- feat: 增加部署到公文
+
+## 1.10.0 (2022-03-12)
+
+- fix: 修复自动部署失败
+- fix: 修复自动删除失败
+
+## 1.9.4 (2022-03-11)
+
+- feat: 自动删除教育集成模式下 public/static 文件夹。
+- refactor: 重构 edu 配置项，single/mainProject 合并成 mode
+
+## 1.9.3 (2022-02-23)
+
+- chore: 更换 ssh-sftp 包
+
+## 1.9.2 (2022-02-23)
+
+- feat: webpack cache 改成 `filesystem`
+
+## 1.9.1 (2022-02-11)
+
+- feat: 增加 `css` 压缩
+
+## 1.9.0 (2022-02-11)
+
+- feat: 增加默认的环境变量，完善 `ts` 声明
+- feat: `generator ts` 生成 `edu-app-env.d.ts` 文件
+- feat: 修改 `postcss` 配置
+- feat: 支持 `*.module.(css|less)` 文件，导出 `local` 样式
+- feat: 开发时启用样式文件 `sourceMap`
+
+## 1.8.1 (2022-01-25)
+
+- feat: 自动换端口增加一个提示语
+
+## 1.8.0 (2022-01-19)
+
+- refactor: 重构标识符，全部归类到 `edu` 字段中
+- feat: 增加[主工程标识符](/mode)，限制教育模式子工程上传文件种类
+
+## 1.7.1 (2022-01-18)
+
+- feat: `patch` 迭代将不再强制更新
+- fix: 修复 `webpack-dev-server` 类型文件错误，移除 `@types/webpack-dev-server` 依赖
+
+## 1.7.0 (2022-01-13)
+
+- feat: 增加端口重试，默认 `3000` 端口
+- feat: 增加[独立项目模式](/mode)
+- feat: 默认热加载地址切换成 `ipv4` 地址
+- feat: 打包复制 `public/static` 内容
+- feat: `svg` 增加模块导出方式，`css` 中会导出 `dataURI`，`js` 中会默认导出 `dataURI` 并额外导出 `ReactComponent`
+- refactor: 重构 generator page 命令，`page <moudleName>` 改成 `page --name`
+- fix: 修复 `react-error-overlay` 无法响应 `webpack:` 协议
+- fix: 更新 `webpack-dev-server`，修复 `onBeforeSetupMiddleware` deprecated 警告
+
+## 1.6.0 (2021-12-21)
+
+- feat: 增加[灰度测试](/grayscale)适配
+
+## 1.5.0 (2021-12-14)
+
+- feat: 增加 `style` 标签属性，标记对应 `module` 与 `version`，方便排查样式污染
+- feat: 增加 `generator ts` 指令，用于生成 `tsconfig.json` 文件
+- refactor: 移除 `WebpackBar` 插件，使用 `webpack.ProgressPlugin`
+- chore: 固定 `react-error-overlay` 版本号
+
+## 1.4.0 (2021-11-23)
+
+- feat: 增加 `edu-scripts` 别名 `edu`
+- feat: 增加 `generator` 功能，自动生成模版代码
+- refactor: 移动 `override` 功能到 `generator` 下
+
+## 1.3.3 (2021-11-05)
+
+- feat: 适配 `ofd.js` 与 `pdfjs-dist`
+
+## 1.3.2 (2021-11-03)
+
+- feat: 增加 `--transform-node-modules` flag，支持编译 `node_modules` 下的代码
+
+## 1.3.1 (2021-11-03)
+
+- fix: 时刻保持更新
+
+## 1.3.0 (2021-11-02)
+
+- feat: 增加 `react-error-overlay`, 支持报错跳转到编辑器
+
+## 1.2.4 (2021-10-30)
+
+- feat: 优化 FileSizeReport 显示顺序
+- feat: 调整 splitChunks 策略
+- docs: 完善接入文档与错误处理
+
+## 1.2.3 (2021-10-29)
+
+- feat: alias lodash to lodash-es
+
+## 1.2.2 (2021-10-29)
+
+- fix: 修复 `update-notifier` 不起作用

package/README.md

@@ -0,0 +1,105 @@
+# 教育工程化基础框架
+
+svn://192.168.10.168/edu/code/A0.New-system/0A2.front-end-component/edu-scripts/trunk
+
+## 运行条件
+
+nodejs 版本至少 12+
+
+## 快速体验
+
+执行下面的命令，快速建立一个最小的应用模版，支持 [教育集成 与 独立项目模式](/mode)
+
+```shell
+# npm 安装
+npm create @qse/edu-app
+
+# 或者 yarn 安装
+yarn create @qse/edu-app
+
+# 或者 pnpm 安装
+pnpm create @qse/edu-app
+```
+
+## 安装
+
+<Alert>第一次使用这个框架，请看<Link to="/refactor">老项目接入流程</Link></Alert>
+
+```shell
+npm i @qse/edu-scripts -D
+```
+
+## 用法
+
+`edu-scripts` 可以使用缩写 `edu`，在手写命令行时方便使用
+
+```shell
+# 开发
+edu-scripts start
+# 开发指定端口 默认3000
+edu-scripts start --port 5000
+
+# 打包
+edu-scripts build
+# 打包并分析
+edu-scripts build --analyze
+# 打包并导出 html 文件
+edu-scripts build --output-html
+
+# 部署代码 校端
+edu-scripts deploy -s
+# 部署代码 局端
+edu-scripts deploy -b
+# 部署代码 公文端
+edu-scripts deploy -d
+# 部署代码 校端 + 局端 + 公文端
+edu-scripts deploy -s -b -d
+
+# 生成 override 文件
+edu-scripts generator override
+# 自动生成代码 可使用 npx edu-scripts generator page -h 查看具体效果
+edu-scripts generator page --name <module-name>
+# 生成 tailwind 配置
+edu-scripts generator tailwind
+# 生成 tsconfig 配置
+edu-scripts generator ts
+
+# SVN 提交 dist 到 dist 分支上
+edu-scripts commit-dist
+# SVN 提交 dist 到 dist 分支上，并且删除本地 dist
+edu-scripts commit-dist --rm-local
+```
+
+## ENV 环境变量
+
+| 参数    | 默认值 | 说明         |
+| ------- | ------ | ------------ |
+| PORT    | 3000   | 启动端口     |
+| ANALYZE | false  | 开启打包分析 |
+
+## 自定义配置
+
+```shell
+# 创建 edu-scripts.override.js 文件
+npx edu-scripts g override
+```
+
+具体看[override](/override)
+
+### 自定义 antd 样式
+
+如果不需要，可以跳过
+
+根目录生成 `theme.js` 或 `theme.json`
+
+```js
+module.exports = {
+  '@primary-color': '#99f',
+}
+```
+
+```json
+{
+  "@primary-color": "#99f"
+}
+```

package/app.d.ts

@@ -0,0 +1,68 @@
+declare namespace NodeJS {
+  interface ProcessEnv {
+    readonly NODE_ENV: 'development' | 'production'
+    readonly APP_NAME: string
+    readonly APP_VERSION: string
+  }
+}
+
+declare module '*.avif' {
+  const src: string
+  export default src
+}
+
+declare module '*.bmp' {
+  const src: string
+  export default src
+}
+
+declare module '*.html' {
+  const src: string
+  export default src
+}
+
+declare module '*.gif' {
+  const src: string
+  export default src
+}
+
+declare module '*.jpg' {
+  const src: string
+  export default src
+}
+
+declare module '*.jpeg' {
+  const src: string
+  export default src
+}
+
+declare module '*.png' {
+  const src: string
+  export default src
+}
+
+declare module '*.webp' {
+  const src: string
+  export default src
+}
+
+declare module '*.svg' {
+  import * as React from 'react'
+
+  export const ReactComponent: React.FunctionComponent<
+    React.SVGProps<SVGSVGElement> & { title?: string }
+  >
+
+  const src: string
+  export default src
+}
+
+declare module '*.module.css' {
+  const classes: { readonly [key: string]: string }
+  export default classes
+}
+
+declare module '*.less' {
+  const classes: { readonly [key: string]: string }
+  export default classes
+}

package/docs/changelog.md

@@ -0,0 +1,5 @@
+---
+title: 更新日志
+---
+
+<embed src="../CHANGELOG.md" />

package/docs/deploy.md

@@ -0,0 +1,53 @@
+# 部署 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
+{
+  "preset": {
+    "context": "qsxxwapdev"
+  }
+}
+```
+
+可以使用预设配置，`npx ssh-sftp show-config` 查看最终的配置
+
+其余配置请看 [@qse/ssh-sftp][1]
+
+[1]: http://www.zhidianbao.cn:8088/qsxxwapdev/edu-ssh-sftp/

package/docs/feat.md

@@ -0,0 +1,74 @@
+# 特性
+
+## svg 模块导出
+
+默认导出 `dataURI`，额外导出 `ReactComponent`
+
+两种使用方式是相同的
+
+```tsx | pure
+import logoURI, { ReactComponent as Logo } from './logo.svg'
+
+export default () => (
+  <>
+    <img src={logoURI} />
+    <Logo />
+  </>
+)
+```
+
+## 复制 public 文件
+
+`edu-scripts build` 会复制 `public` 或 `public/static` 文件到 `dist` 中
+
+教育子工程不会复制
+
+## 支持 typescript
+
+如果要开启 typescrit，只需要运行 `npx edu g ts`
+
+## 生成页面模版
+
+可以自动生成页面模版
+
+运行 `npx edu g page -h` 查看详细信息
+
+## 支持[自定义配置](/override)
+
+运行 `npx edu g override` 生成控制文件
+
+## 自动根据 qsb 的 CDN 调整内部配置
+
+根据 `public/*.html` 文件里的 CDN 按需自动配置 externals 与 dll
+
+### CDN 匹配关键字
+
+`/react16.14.*_common31?.js/`
+
+- external: `react`, `react-dom`, `natty-fetch`, `natty-store`, `common-utils`
+- 添加内置的 dll 文件
+
+`/react16.14.*_axios0.21.1/`
+
+- external: `react`, `react-dom`, `natty-fetch`, `natty-store`, `common-utils`, `axios`
+
+`moment2.29.1.js`
+
+- external: `moment`
+
+`antd3.26.20.js`
+
+- development external: `react`, `react-dom`, `moment`, `antd`
+- production external: 
+  - 教育模式 `react`, `react-dom`, `moment`, `antd`, `@qse/antd`, `@qse/scheme-render`
+  - 独立模式 `react`, `react-dom`, `moment`, `antd`
+
+## 支持 tailwindcss
+
+如果要开启 tailwindcss，只需要运行 `npx edu g tailwind`
+
+## PostCSS
+
+预处理很多样式[兼容性问题](https://preset-env.cssdb.org/features/#stage-2)
+
+为所有 `overflow: auto/scroll` 自动增加 `-webkit-overflow-scrolling: touch`

package/docs/grayscale.md

@@ -0,0 +1,31 @@
+# 灰度测试
+
+## 开启灰度测试
+
+### PC 端
+
+前端只要在 `package.json` 文件中加入 `grayscale` 字段即可
+
+```json
+{
+  "name": "模块名称",
+  "edu": { "grayscale": true }
+}
+```
+
+此时打包出来的模块就成了灰度测试用的模块，会部署到指定的目录下，主工程会处理调度问题
+
+模块名称可与运维讨论
+
+后端接口会由 `nginx` 处理，前端不需要关注
+
+### H5 端
+
+h5 与 pc 是完全不同的方案，前端是需要将代码部署到两个地方。
+
+`/project-name` 与 `/beta_project-name`。第二个名字需要去问运维要
+
+#### 流程
+
+1. 访问 `/qsxxwapdev/project-name/index.html`
+2. 网关拦截 `index.html` 请求，并根据后台灰度配置进行分流，分别进入`/qsxxwapdev/project-name/index1.html` 与 `/qsxxwapdev/beta_project-name/index1.html`

package/docs/index.md

@@ -0,0 +1,5 @@
+---
+title: 教育工程化基础框架
+---
+
+<embed src="../README.md" />

package/docs/mode.md

@@ -0,0 +1,42 @@
+# 模式
+
+目前有三种模式：教育主工程模式，教育子工程模式，独立模式
+
+## 教育子工程模式
+
+默认情况下使用**教育子工程模式**，无需配置
+
+## 教育主工程模式
+
+### 启用
+
+package.json 增加 mode 字段
+
+```json
+{
+  "edu": { "mode": "main" }
+}
+```
+
+## 独立项目模式
+
+### 启用
+
+package.json 增加 mode 字段
+
+```json
+{
+  "edu": { "mode": "single" }
+}
+```
+
+## 共同
+
+请查看[特性](/feat)
+
+## 差异
+
+| 差异点                 | 子工程                                   | 主工程                                        | 独立                                                                                    |
+| ---------------------- | ---------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------- |
+| 打包 build             | 不复制 `public`，不导出 `html` 文件      | 复制 `public/static` 文件夹，导出 `html` 文件 | 复制 `public` 文件夹，导出 `html` 文件，且输出的 `output.filename` 会添加 `contenthash` |
+| [部署 deploy](/deploy) | 只上传 `dist/js、dist/images` 两个文件夹 | 上传 `dist`                                   | 同主工程                                                                                |