@qse/edu-scripts 1.12.1 → 1.12.3

package/CHANGELOG.md

@@ -1,6 +1,15 @@
 # 更新日志
 
-## 1.12.0 (2022-09-28)
+## 1.12.3 (2022-11-01)
+
+- fix: 修复 commit-dist 错误
+
+## 1.12.2 (2022-09-29)
+
+- feat: 校验 version 字段
+- feat: 优化 cdn external 规则
+
+## 1.12.1 (2022-09-28)
 
 - chore: 修改组织名 @qse，发布公网
 

package/docs/faq.md

@@ -0,0 +1,99 @@
+# 错误处理
+
+## 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>
+```

package/docs/feat.md

@@ -33,7 +33,7 @@ export default () => (
 
 运行 `npx edu g page -h` 查看详细信息
 
-## 支持[自定义配置](/override)
+## 支持[自定义配置](override.md)
 
 运行 `npx edu g override` 生成控制文件
 
@@ -58,10 +58,17 @@ export default () => (
 
 `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`
+- external: `react`, `react-dom`, `moment`, `antd`
+
+如果使用 `antd3.26.20.js` 将额外执行下列规则
+
+`qsb-antd.min.js`
+
+- external: `@qsb/antd`, `@qse/antd`
+
+`qsb-scheme-render.min.js`
+
+- external: `@qsb/scheme-render` `@qse/scheme-render`
 
 ## 支持 tailwindcss
 
@@ -72,3 +79,5 @@ export default () => (
 预处理很多样式[兼容性问题](https://preset-env.cssdb.org/features/#stage-2)
 
 为所有 `overflow: auto/scroll` 自动增加 `-webkit-overflow-scrolling: touch`
+
+为所有 `env(safe-area-inset-*)` 增加 fallback

package/docs/mode.md

@@ -32,11 +32,11 @@ package.json 增加 mode 字段
 
 ## 共同
 
-请查看[特性](/feat)
+请查看[特性](feat.md)
 
 ## 差异
 
 | 差异点                 | 子工程                                   | 主工程                                        | 独立                                                                                    |
 | ---------------------- | ---------------------------------------- | --------------------------------------------- | --------------------------------------------------------------------------------------- |
 | 打包 build             | 不复制 `public`，不导出 `html` 文件      | 复制 `public/static` 文件夹，导出 `html` 文件 | 复制 `public` 文件夹，导出 `html` 文件，且输出的 `output.filename` 会添加 `contenthash` |
-| [部署 deploy](/deploy) | 只上传 `dist/js、dist/images` 两个文件夹 | 上传 `dist`                                   | 同主工程                                                                                |
+| [部署 deploy](deploy.md) | 只上传 `dist/js、dist/images` 两个文件夹 | 上传 `dist`                                   | 同主工程                                                                                |

package/docs/refactor.md

@@ -58,82 +58,4 @@
 
 ## 报错处理
 
-## 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)
-  })
-}
-```
+请看[错误处理](faq.md)

package/docs/static.md

@@ -0,0 +1,28 @@
+# 静态资源
+
+## 开发环境使用的静态资源
+
+```html
+<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 @1.5.4 -->
+<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/qsb-antd.min.js"></script>
+<!-- @qsb/scheme-render @1.2.3  -->
+<script src="//www.zhidianbao.cn:8088/qsxxwapdev/edu-scripts/qsb-scheme-render.min.js"></script>
+```
+
+## 生产环境使用的静态资源
+
+```html
+<!-- 包含 react react-dom natty-fetch common-utils dll(refast react-keeper) -->
+<script src="//static.qsepay.net/lib/react16.14_fastclick1.0.6_natty-storage2.0.2-fetch2.4.2_common31.js"></script>
+<!-- 额外包含 axios @0.21.1 -->
+<script src="//static.qsepay.net/lib/react16.14_fastclick1.0.6_natty-storage2.0.2-fetch2.4.2_axios0.21.1_common31.js"></script>
+
+<!-- 包含 moment 与 moment-locale-zh-cn -->
+<script src="//static.qsepay.net/lib/moment2.29.1.js"></script>
+<script src="//static.qsepay.net/lib/antd3.26.20.js"></script>
+```

package/lib/build.js

@@ -59,10 +59,6 @@ module.exports = async function build(args) {
         errors: true,
         colors: true
       }));
-    } // Fail the build if running in a CI server
-
-
-    if (error || stats.compilation.errors.length) {
       process.exit(1);
     }
 

package/lib/commit-dist.js

@@ -14,8 +14,6 @@ const exec = (cmd, opts) => require('child_process').execSync(cmd, {
 
 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));
@@ -67,17 +65,15 @@ function copyDistToRepo(info) {
   }
 
   exec(`svn co ${info.distBranchDirURL} ${tmpdir}`);
-  let files = glob.sync('**/*', {
-    cwd: tmpdir
-  });
-  exec(`svn rm "${files.join('" "')}"`, {
-    cwd: tmpdir
-  });
+
+  try {
+    exec(`svn rm * --force -q`, {
+      cwd: tmpdir
+    });
+  } catch (error) {}
+
   fs.copySync(paths.dist, tmpdir);
-  files = glob.sync('**/*', {
-    cwd: tmpdir
-  });
-  exec(`svn add "${files.join('" "')}"`, {
+  exec(`svn add * --force --auto-props --parents --depth infinity -q`, {
     cwd: tmpdir
   });
   const msg = `[edu-scripts] commit ${info.branch} dist #${info.revision} @${info.author}`;

package/lib/config/webpackConfig.js

@@ -40,13 +40,17 @@ const qsbCDN = (() => {
   const isUseAxios = contents.some(content => /react16.14.*_axios0.21.1/.test(content));
   const isUseMoment = contents.some(content => content.includes('moment2.29.1.js'));
   const isUseAntd = contents.some(content => content.includes('antd3.26.20.js'));
-  const isUse = isUseAntd || isUseCommon || isUseMoment || isUseAxios;
+  const isUseQsbAntd = contents.some(content => content.includes('qsb-antd.min.js'));
+  const isUseQsbSchemeRender = contents.some(content => content.includes('qsb-scheme-render.min.js'));
+  const isUse = isUseAntd || isUseCommon || isUseMoment || isUseAxios || isUseQsbAntd || isUseQsbSchemeRender;
   return {
     isUse,
     isUseAntd,
     isUseCommon,
     isUseMoment,
-    isUseAxios
+    isUseAxios,
+    isUseQsbAntd,
+    isUseQsbSchemeRender
   };
 })();
 /**
@@ -137,18 +141,18 @@ module.exports = function getWebpackConfig(args, override) {
       axios: 'axios'
     }, qsbCDN.isUseMoment && {
       moment: 'moment'
-    }, qsbCDN.isUseAntd && {
+    }, qsbCDN.isUseAntd && Object.assign({
       react: 'React',
       'react-dom': 'ReactDOM',
       moment: 'moment',
-      antd: 'antd',
-      ...(isProd && !appConfig.single ? {
-        '@qse/antd': 'qsbAntd',
-        '@qse/scheme-render': 'qsbSchemeRender',
-        '@qsb/antd': 'qsbAntd',
-        '@qsb/scheme-render': 'qsbSchemeRender'
-      } : {})
-    }, override.externals),
+      antd: 'antd'
+    }, qsbCDN.isUseQsbAntd && {
+      '@qse/antd': 'qsbAntd',
+      '@qsb/antd': 'qsbAntd'
+    }, qsbCDN.isUseQsbSchemeRender && {
+      '@qse/scheme-render': 'qsbSchemeRender',
+      '@qsb/scheme-render': 'qsbSchemeRender'
+    }), override.externals),
     resolve: {
       alias: {
         '@': paths.src,
@@ -271,7 +275,6 @@ module.exports = function getWebpackConfig(args, override) {
           }, {
             loader: 'url-loader',
             options: {
-              name: `images/${assetPath}/[name].[hash:6].[ext]`,
               limit: imageInlineSizeLimit
             }
           }],

package/lib/utils/beforeStart.js

@@ -10,6 +10,8 @@ const pkg = require('../../package.json');
 
 const updateNotifier = require('update-notifier');
 
+const semver = require('semver');
+
 const notifier = updateNotifier({
   pkg,
   shouldNotifyInNpmScript: true,
@@ -29,6 +31,11 @@ const appPkg = require(paths.package);
 
 const appConfig = require('./appConfig');
 
+if (semver.valid(appPkg.version) === null) {
+  console.log(chalk.red(`package.version 不符合 semver 规范 https://docs.npmjs.com/about-semantic-versioning`));
+  process.exit(1);
+}
+
 switch (appConfig.mode) {
   case 'main':
     console.log(chalk.bgMagenta('正在使用教育主工程模式'));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qse/edu-scripts",
-  "version": "1.12.1",
+  "version": "1.12.3",
   "author": "Kinoko",
   "license": "MIT",
   "description": "教育工程化基础框架",
@@ -73,6 +73,7 @@
     "react-refresh": "^0.13.0",
     "recursive-readdir": "^2.2.2",
     "rimraf": "^3.0.2",
+    "semver": "^7.3.7",
     "strip-ansi": "^6.0.1",
     "style-loader": "^3.3.1",
     "tailwindcss": "^3.1.2",

package/src/build.js

@@ -44,10 +44,6 @@ module.exports = async function build(args) {
     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)
     }
 

package/src/commit-dist.js

@@ -4,7 +4,6 @@ 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}`)
@@ -49,13 +48,13 @@ function copyDistToRepo(info) {
   }
   exec(`svn co ${info.distBranchDirURL} ${tmpdir}`)
 
-  let files = glob.sync('**/*', { cwd: tmpdir })
-  exec(`svn rm "${files.join('" "')}"`, { cwd: tmpdir })
+  try {
+    exec(`svn rm * --force -q`, { cwd: tmpdir })
+  } catch (error) {}
 
   fs.copySync(paths.dist, tmpdir)
 
-  files = glob.sync('**/*', { cwd: tmpdir })
-  exec(`svn add "${files.join('" "')}"`, { cwd: tmpdir })
+  exec(`svn add * --force --auto-props --parents --depth infinity -q`, { cwd: tmpdir })
 
   const msg = `[edu-scripts] commit ${info.branch} dist #${info.revision} @${info.author}`
   exec(`svn ci -m "${msg}"`, { cwd: tmpdir })

package/src/config/webpackConfig.js

@@ -30,9 +30,22 @@ const qsbCDN = (() => {
   const isUseAxios = contents.some((content) => /react16.14.*_axios0.21.1/.test(content))
   const isUseMoment = contents.some((content) => content.includes('moment2.29.1.js'))
   const isUseAntd = contents.some((content) => content.includes('antd3.26.20.js'))
+  const isUseQsbAntd = contents.some((content) => content.includes('qsb-antd.min.js'))
+  const isUseQsbSchemeRender = contents.some((content) =>
+    content.includes('qsb-scheme-render.min.js')
+  )
 
-  const isUse = isUseAntd || isUseCommon || isUseMoment || isUseAxios
-  return { isUse, isUseAntd, isUseCommon, isUseMoment, isUseAxios }
+  const isUse =
+    isUseAntd || isUseCommon || isUseMoment || isUseAxios || isUseQsbAntd || isUseQsbSchemeRender
+  return {
+    isUse,
+    isUseAntd,
+    isUseCommon,
+    isUseMoment,
+    isUseAxios,
+    isUseQsbAntd,
+    isUseQsbSchemeRender,
+  }
 })()
 
 /**
@@ -129,20 +142,23 @@ module.exports = function getWebpackConfig(args, override) {
       },
       qsbCDN.isUseAxios && { axios: 'axios' },
       qsbCDN.isUseMoment && { moment: 'moment' },
-      qsbCDN.isUseAntd && {
-        react: 'React',
-        'react-dom': 'ReactDOM',
-        moment: 'moment',
-        antd: 'antd',
-        ...(isProd && !appConfig.single
-          ? {
-              '@qse/antd': 'qsbAntd',
-              '@qse/scheme-render': 'qsbSchemeRender',
-              '@qsb/antd': 'qsbAntd',
-              '@qsb/scheme-render': 'qsbSchemeRender',
-            }
-          : {}),
-      },
+      qsbCDN.isUseAntd &&
+        Object.assign(
+          {
+            react: 'React',
+            'react-dom': 'ReactDOM',
+            moment: 'moment',
+            antd: 'antd',
+          },
+          qsbCDN.isUseQsbAntd && {
+            '@qse/antd': 'qsbAntd',
+            '@qsb/antd': 'qsbAntd',
+          },
+          qsbCDN.isUseQsbSchemeRender && {
+            '@qse/scheme-render': 'qsbSchemeRender',
+            '@qsb/scheme-render': 'qsbSchemeRender',
+          }
+        ),
       override.externals
     ),
     resolve: {
@@ -274,7 +290,6 @@ module.exports = function getWebpackConfig(args, override) {
                 {
                   loader: 'url-loader',
                   options: {
-                    name: `images/${assetPath}/[name].[hash:6].[ext]`,
                     limit: imageInlineSizeLimit,
                   },
                 },

package/src/utils/beforeStart.js

@@ -3,6 +3,7 @@ const paths = require('../config/paths')
 const chalk = require('chalk')
 const pkg = require('../../package.json')
 const updateNotifier = require('update-notifier')
+const semver = require('semver')
 
 const notifier = updateNotifier({
   pkg,
@@ -27,6 +28,14 @@ if (notifier.update && ['minor', 'major'].includes(notifier.update.type)) {
 
 const appPkg = require(paths.package)
 const appConfig = require('./appConfig')
+
+if (semver.valid(appPkg.version) === null) {
+  console.log(
+    chalk.red(`package.version 不符合 semver 规范 https://docs.npmjs.com/about-semantic-versioning`)
+  )
+  process.exit(1)
+}
+
 switch (appConfig.mode) {
   case 'main':
     console.log(chalk.bgMagenta('正在使用教育主工程模式'))