@qse/edu-scripts 1.13.1 → 1.13.3

package/lib/deploy.js

@@ -3,23 +3,14 @@
 const {
   sshSftp
 } = require('@qse/ssh-sftp');
-
 const path = require('path');
-
 const paths = require('./config/paths');
-
 const pkg = require(paths.package);
-
 const chalk = require('chalk');
-
 const fs = require('fs-extra');
-
 const changeDeployVersion = require('./utils/changeDeployVersion');
-
 const ora = require('ora');
-
 const appConfig = require('./utils/appConfig');
-
 const baseConfig = {
   localPath: 'dist',
   ignore: [],
@@ -28,7 +19,6 @@ const baseConfig = {
   keepAlive: true,
   noWarn: true
 };
-
 async function normalDeploy(args) {
   const presetConfig = {
     s: {
@@ -44,8 +34,8 @@ async function normalDeploy(args) {
       folder: 'documentshelves'
     }
   };
-
   const resolve = (...pathSegments) => path.resolve(process.cwd(), ...pathSegments);
+
   /**
    * 生成路径
    * @name remoteFile 远程文件
@@ -54,8 +44,6 @@ async function normalDeploy(args) {
    * @name tmpBase 本地临时文件夹 到`__tmp__`层
    * @param {string} remoteFilePath 远程文件相对`opts.remotePath`地址
    */
-
-
   function getLocalAndRemoteFilePath(remoteFilePath, opts) {
     const splited = remoteFilePath.split('/');
     const fileName = splited[splited.length - 1];
@@ -70,36 +58,32 @@ async function normalDeploy(args) {
       tmpBase
     };
   }
-
   function dateTime() {
     let date = new Date();
     date = new Date(date.getTime() - date.getTimezoneOffset() * 60000);
     return date.toISOString().replace(/T/, ' ').replace(/\..+/, '');
   }
-
   function updateLogContent(content, info) {
     const lines = content.trim().split('\n');
     lines.push(`[${dateTime()}] ${JSON.stringify(info)}\n`);
-    return lines.slice(0, 50).join('\n');
+    return lines.slice(-50).join('\n');
   }
-
   async function upload(opts) {
     // 上传dist文件
     const {
       sftp,
       opts: fullOpts
     } = await sshSftp(opts);
-    const spinner = ora('自动更新 ver.js 版本配置').start(); // 指定远程需要修改的文件
-
-    const fileName = 'js/ver.js'; // 生成各种路径
-
+    const spinner = ora('自动更新 ver.js 版本配置').start();
+    // 指定远程需要修改的文件
+    const fileName = 'js/ver.js';
+    // 生成各种路径
     const {
       remoteFile,
       tmpDir,
       tmpFile,
       tmpBase
     } = getLocalAndRemoteFilePath(fileName, fullOpts);
-
     try {
       // 创建本地临时文件夹，位置在 `opts.localPath` 下的 `__tmp__` 文件夹
       fs.mkdirSync(tmpDir, {
@@ -112,27 +96,26 @@ async function normalDeploy(args) {
       };
       {
         // 拉取远程文件到本地
-        await sftp.fastGet(remoteFile, tmpFile); // 读取本地文件内容
+        await sftp.fastGet(remoteFile, tmpFile);
 
+        // 读取本地文件内容
         let code = await fs.readFile(tmpFile, {
           encoding: 'utf-8'
         });
         code = changeDeployVersion(code, info);
         await sftp.fastPut(tmpFile, remoteFile + '.bak');
-        await fs.writeFile(tmpFile, code); // 将修改完的内容传回服务器
-
+        await fs.writeFile(tmpFile, code);
+        // 将修改完的内容传回服务器
         await sftp.fastPut(tmpFile, remoteFile);
       }
       {
         const remoteLogFile = remoteFile + '.log';
         const tmpLogFile = tmpFile + '.log';
         let content = '';
-
         try {
           await sftp.fastGet(remoteLogFile, tmpLogFile);
           content = await fs.readFile(tmpLogFile, 'utf-8');
         } catch (error) {}
-
         content = updateLogContent(content, info);
         await fs.writeFile(tmpLogFile, content);
         await sftp.fastPut(tmpLogFile, remoteLogFile);
@@ -142,26 +125,21 @@ async function normalDeploy(args) {
       spinner.fail(`自动修改 ver.js 失败，请手动修改`);
       console.log(chalk.bgRed(e.message));
     } finally {
-      await sftp.end(); // 清除临时文件夹
-
+      await sftp.end();
+      // 清除临时文件夹
       fs.removeSync(tmpBase);
     }
   }
-
   const presets = [];
-
   if (args.b) {
     presets.push(presetConfig.b);
   }
-
   if (args.s) {
     presets.push(presetConfig.s);
   }
-
   if (args.d) {
     presets.push(presetConfig.d);
   }
-
   if (presets.length === 0) {
     console.log(`
     ${chalk.red('指定 deploy 部署范围')}
@@ -177,24 +155,23 @@ async function normalDeploy(args) {
     `);
     process.exit();
   }
-
-  const uploadConfig = { ...baseConfig,
+  const uploadConfig = {
+    ...baseConfig,
     ignore: [...baseConfig.ignore, 'js/ver.js']
   };
-
   if (!appConfig.mainProject) {
     uploadConfig.ignore = [...uploadConfig.ignore, '!(js|images)'];
   }
-
   for (const preset of presets) {
-    await upload({ ...uploadConfig,
+    await upload({
+      ...uploadConfig,
       preset
     });
   }
 }
-
 async function singleDeploy() {
-  const config = fs.existsSync(paths.sshSftp) ? fs.readJsonSync(paths.sshSftp) : { ...baseConfig,
+  const config = fs.existsSync(paths.sshSftp) ? fs.readJsonSync(paths.sshSftp) : {
+    ...baseConfig,
     preset: {
       context: 'qsxxwapdev'
     },
@@ -205,7 +182,6 @@ async function singleDeploy() {
   };
   sshSftp(config);
 }
-
 module.exports = function deploy(args) {
   if (appConfig.single) {
     singleDeploy();

package/lib/generator.js

@@ -1,26 +1,20 @@
 "use strict";
 
 const path = require('path');
-
 const fs = require('fs-extra');
-
 const {
   upperFirst,
   camelCase,
   has
 } = require('lodash');
-
 const paths = require('./config/paths');
-
 const chalk = require('chalk');
+
 /**
  * @param {string[]} args
  * @returns {string}
  */
-
-
 const getTmpPath = (...args) => path.resolve(__dirname, 'asset', 'template', ...args);
-
 function genFile({
   source,
   target,
@@ -28,15 +22,14 @@ function genFile({
   replace
 }) {
   let content = fs.readFileSync(source, 'utf-8');
-
   if (typeof replace === 'object') {
     Object.entries(replace).forEach(([searchValue, replaceValue]) => {
       content = content.replaceAll(searchValue, replaceValue);
     });
   }
-
   fs.writeFileSync(path.resolve(modulePath, target), content);
 }
+
 /**
  * @typedef {Object} PageArgs
  * @property {string} name
@@ -46,8 +39,6 @@ function genFile({
  *
  * @param {PageArgs} args
  */
-
-
 async function generatorPage(args) {
   const tmpPath = getTmpPath('page', 'index.[type].[ext].tpl');
   const lessPath = tmpPath.replace('[type].[ext]', 'less');
@@ -80,7 +71,6 @@ async function generatorPage(args) {
     modulePath,
     replace
   });
-
   if (type === 'class' && ext === 'js') {
     genFile({
       source: logicPath,
@@ -89,7 +79,6 @@ async function generatorPage(args) {
       replace
     });
   }
-
   if (args.route) {
     genFile({
       source: routePath,
@@ -98,55 +87,43 @@ async function generatorPage(args) {
       replace
     });
   }
-
   console.log(chalk.green([`生成完毕:`, `import ${ModuleName} from '@/pages/${moduleName}'`, `const ${ModuleName} = lazy(() => import(/* webpackChunkName: '${moduleName}' */ '@/pages/${moduleName}'))`, `{ path: '/${moduleName}', element: <${ModuleName} /> },`].join('\n')));
 }
-
 async function generatorOverride() {
   if (fs.existsSync(paths.override)) {
     console.log(chalk.red(`文件已存在 ${paths.override}`));
     process.exit(0);
   }
-
   fs.copySync(getTmpPath('edu-scripts.override.js.tpl'), paths.override);
   console.log(chalk.green(`成功生成 ${paths.override}`));
 }
-
 async function generatorTsconfig() {
   if (fs.existsSync(paths.tsconfig)) {
     console.log(chalk.red(`文件已存在 ${paths.tsconfig}`));
     process.exit(0);
   }
-
   fs.copySync(getTmpPath('tsconfig.json.tpl'), paths.tsconfig);
   fs.copySync(getTmpPath('edu-app-env.d.ts.tpl'), paths.eduAppEnv);
   console.log(chalk.green(`成功生成 ${paths.tsconfig}`));
 }
-
 async function generatorTailwind() {
   if (fs.existsSync(paths.tailwind)) {
     console.log(chalk.red(`文件已存在 ${paths.tailwind}`));
     process.exit(0);
   }
-
   fs.copySync(getTmpPath('tailwind.config.js.tpl'), paths.tailwind);
   const code = ['@tailwind base;', '@tailwind components;', '@tailwind utilities;'].join('\n');
   const globalLessFile = paths.resolveApp('src', 'index.less');
-
   if (fs.existsSync(globalLessFile)) {
     const content = fs.readFileSync(globalLessFile, 'utf-8');
-
     if (!content.includes('@tailwind base')) {
       fs.writeFileSync(globalLessFile, [code, content].join('\n'));
     }
-
     console.log(chalk.green(`成功生成 ${paths.tailwind}`));
     return;
   }
-
   console.log(chalk.green([`成功生成 ${paths.tailwind}`, '', '添加以下代码到入口处的 index.less 中', code].join('\n')));
 }
-
 module.exports = {
   page: generatorPage,
   override: generatorOverride,

package/lib/index.js

@@ -9,5 +9,4 @@ Object.defineProperty(exports, "defineConfig", {
     return _defineConfig.defineConfig;
   }
 });
-
 var _defineConfig = require("./utils/defineConfig");

package/lib/start.js

@@ -3,32 +3,25 @@
 process.env.NODE_ENV = 'development';
 process.env.BABEL_ENV = 'development';
 process.env.BROWSERSLIST = 'chrome >= 70';
-process.env.WEBPACK_DEV_SERVER_BASE_PORT = '3000'; // Makes the script crash on unhandled rejections instead of silently
+process.env.WEBPACK_DEV_SERVER_BASE_PORT = '3000';
+
+// Makes the script crash on unhandled rejections instead of silently
 // ignoring them. In the future, promise rejections that are not handled will
 // terminate the Node.js process with a non-zero exit code.
-
 process.on('unhandledRejection', err => {
   throw err;
 });
-
 const WebpackDevServer = require('webpack-dev-server');
-
 const webpack = require('webpack');
-
 const getConfig = require('./utils/getConfig');
-
 const chalk = require('chalk');
-
 process.env.WDS_SOCKET_HOST = WebpackDevServer.internalIPSync('v4') || '127.0.0.1';
-
 module.exports = async function start(args) {
   const basePort = process.env.WEBPACK_DEV_SERVER_BASE_PORT;
   const port = await WebpackDevServer.getFreePort(args.port || process.env.PORT);
-
   if (!(args.port || process.env.PORT) && +port !== +basePort) {
     console.log(chalk.bgYellow(`${basePort} 端口已被占用，现切换到 ${port} 端口运行`));
   }
-
   process.env.WDS_SOCKET_PORT = port;
   args.port = port;
   const compiler = webpack(getConfig(args));
@@ -40,7 +33,6 @@ module.exports = async function start(args) {
       process.exit();
     });
   });
-
   if (process.env.CI !== 'true') {
     // Gracefully exit when stdin ends
     process.stdin.on('end', function () {

package/lib/utils/FileSizeReporter.js

@@ -6,25 +6,19 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-var fs = require('fs');
 
+var fs = require('fs');
 var path = require('path');
-
 var chalk = require('chalk');
-
 var filesize = require('filesize');
-
 var recursive = require('recursive-readdir');
-
 var stripAnsi = require('strip-ansi');
-
 var gzipSize = require('gzip-size').sync;
-
 function canReadAsset(asset) {
   return /\.(js|css)$/.test(asset) && !/service-worker\.js/.test(asset) && !/precache-manifest\.[0-9a-f]+\.js/.test(asset);
-} // Prints a detailed summary of build files.
-
+}
 
+// Prints a detailed summary of build files.
 function printFileSizesAfterBuild(webpackStats, previousSizeMap, buildFolder, maxBundleGzipSize, maxChunkGzipSize) {
   var root = previousSizeMap.root;
   var sizes = previousSizeMap.sizes;
@@ -43,8 +37,9 @@ function printFileSizesAfterBuild(webpackStats, previousSizeMap, buildFolder, ma
       sizeLabel: filesize(size) + (difference ? ' (' + difference + ')' : '')
     };
   })).reduce((single, all) => all.concat(single), []);
-  assets.sort((a, b) => b.size - a.size); // move main file to first
+  assets.sort((a, b) => b.size - a.size);
 
+  // move main file to first
   var mainAssetIdx = assets.findIndex(asset => /_\d+\.\d+\.\d+\./.test(asset.name));
   assets.unshift(assets.splice(mainAssetIdx, 1)[0]);
   var longestSizeLabelLength = Math.max.apply(null, assets.map(a => stripAnsi(a.sizeLabel).length));
@@ -52,27 +47,21 @@ function printFileSizesAfterBuild(webpackStats, previousSizeMap, buildFolder, ma
   assets.forEach(asset => {
     var sizeLabel = asset.sizeLabel;
     var sizeLength = stripAnsi(sizeLabel).length;
-
     if (sizeLength < longestSizeLabelLength) {
       var rightPadding = ' '.repeat(longestSizeLabelLength - sizeLength);
       sizeLabel += rightPadding;
     }
-
     var isMainBundle = /_\d+\.\d+\.\d+\./.test(asset.name);
     var maxRecommendedSize = isMainBundle ? maxBundleGzipSize : maxChunkGzipSize;
     var isLarge = maxRecommendedSize && asset.size > maxRecommendedSize;
-
     if (isLarge && path.extname(asset.name) === '.js') {
       suggestBundleSplitting = true;
     }
-
     console.log('  ' + (isLarge ? chalk.yellow(sizeLabel) : sizeLabel) + '  ' + chalk.dim(asset.folder + path.sep) + chalk.cyan(asset.name));
-
     if (isMainBundle) {
       console.log('');
     }
   });
-
   if (suggestBundleSplitting) {
     console.log();
     console.log(chalk.yellow('产物大小明显大于推荐的大小 (主文件 30k, chunk 1M, 黄色标注为偏大)'));
@@ -80,18 +69,16 @@ function printFileSizesAfterBuild(webpackStats, previousSizeMap, buildFolder, ma
     console.log(chalk.yellow('也可以使用 npm run analyze 命令分析产物'));
   }
 }
-
 function removeFileNameHash(buildFolder, fileName) {
   return fileName.replace(buildFolder, '').replace(/\\/g, '/').replace(/\/\d+\.\d+\.\d+\//, '/').replace(/\/?(.*)(\.[0-9a-f]+)(\.chunk)?(\.js|\.css)/, (match, p1, p2, p3, p4) => p1 + p4);
-} // Input: 1024, 2048
-// Output: "(+1 KB)"
-
+}
 
+// Input: 1024, 2048
+// Output: "(+1 KB)"
 function getDifferenceLabel(currentSize, previousSize) {
   var FIFTY_KILOBYTES = 1024 * 50;
   var difference = currentSize - previousSize;
   var fileSize = !Number.isNaN(difference) ? filesize(difference) : 0;
-
   if (difference >= FIFTY_KILOBYTES) {
     return chalk.red('+' + fileSize);
   } else if (difference < FIFTY_KILOBYTES && difference > 0) {
@@ -102,12 +89,10 @@ function getDifferenceLabel(currentSize, previousSize) {
     return '';
   }
 }
-
 function measureFileSizesBeforeBuild(buildFolder) {
   return new Promise(resolve => {
     recursive(buildFolder, (err, fileNames) => {
       var sizes;
-
       if (!err && fileNames) {
         sizes = fileNames.filter(canReadAsset).reduce((memo, fileName) => {
           var contents = fs.readFileSync(fileName);
@@ -116,7 +101,6 @@ function measureFileSizesBeforeBuild(buildFolder) {
           return memo;
         }, {});
       }
-
       resolve({
         root: buildFolder,
         sizes: sizes || {}
@@ -124,7 +108,6 @@ function measureFileSizesBeforeBuild(buildFolder) {
     });
   });
 }
-
 module.exports = {
   measureFileSizesBeforeBuild: measureFileSizesBeforeBuild,
   printFileSizesAfterBuild: printFileSizesAfterBuild

package/lib/utils/appConfig.js

@@ -1,44 +1,33 @@
 "use strict";
 
 const paths = require('../config/paths');
-
 const appPkg = require(paths.package);
-
 const fs = require('fs');
-
 const edu = appPkg.edu || {};
-
 if (edu.single || edu.mainProject) {
   if (edu.single) {
     edu.mode = 'single';
     delete edu.single;
   }
-
   if (edu.mainProject) {
     edu.mode = 'main';
     delete edu.mainProject;
   }
-
   fs.writeFileSync(paths.package, JSON.stringify(appPkg, null, 2), 'utf-8');
 }
-
 const appConfig = {
   /** @type {'main'|'single'} */
   get mode() {
     return edu.mode;
   },
-
   get mainProject() {
     return this.mode === 'main';
   },
-
   get single() {
     return this.mode === 'single';
   },
-
   get grayscale() {
     return !!edu.grayscale;
   }
-
 };
 module.exports = appConfig;

package/lib/utils/beforeStart.js

@@ -1,22 +1,15 @@
 "use strict";
 
 const fs = require('fs');
-
 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,
   shouldNotifyInNpmScript: true,
   updateCheckInterval: 1000 * 60 // 时刻保持更新
-
 });
 
 if (notifier.update && ['minor', 'major'].includes(notifier.update.type)) {
@@ -26,38 +19,29 @@ if (notifier.update && ['minor', 'major'].includes(notifier.update.type)) {
   });
   process.exit(1);
 }
-
 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('正在使用教育主工程模式'));
     break;
-
   case 'single':
     console.log(chalk.bgMagenta('正在使用独立项目模式'));
     break;
-
   default:
     console.log(chalk.bgMagenta('正在使用教育集成模式'));
     break;
 }
-
 if (appConfig.grayscale) {
   console.log(chalk.bgYellow('正在使用灰度测试模式'));
 }
-
 if (!(appConfig.single || appConfig.mainProject)) {
   if (fs.existsSync(paths.static)) {
     console.log(chalk.bgYellow('教育集成工程不能含有 public/static, 现已自动删除'));
-
     try {
       fs.rmSync(paths.static, {
         recursive: true
@@ -65,14 +49,12 @@ if (!(appConfig.single || appConfig.mainProject)) {
     } catch (e) {}
   }
 }
-
 if (!fs.existsSync(paths.public) && !process.argv.includes('auto-refactor')) {
   console.log(chalk.red(`public 文件夹不存在，请先按文档改造项目`));
   console.log(`文档: ${chalk.underline(pkg.homepage)}`);
   console.log(`\n使用 ${chalk.green('npx edu-scripts auto-refactor')} 自动改造\n`);
   process.exit(0);
 }
-
 if (appPkg.browserslist) {
   console.log(chalk.yellow('已删除 package.json 中 browserslist，该值由内部自动控制\n'));
   delete appPkg.browserslist;