@shijiu/jsview 1.9.909 → 1.9.914

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shijiu/jsview",
-  "version": "1.9.909",
+  "version": "1.9.914",
   "bin": {
     "jsview-post-build": "./tools/jsview-post-build.js",
     "jsview-post-install": "./tools/jsview-post-install.js"

package/tools/jsview-batch-upgrade.mjs

@@ -0,0 +1,382 @@
+#!/usr/bin/env node
+'use strict';
+
+import fs from 'fs';
+import path from 'path';
+import url from 'url';
+import {
+  askAndAnswer,
+  checkNodeVersion,
+  execCommand,
+  parseArguments
+} from './jsview-common.mjs';
+
+function getOptions(argv)
+{
+  const options = {
+    stagePixels: '1',
+    stageAnimation: '2',
+    stageHashHistory: '3',
+    stageAudiotrack: '4',
+    stageImportPostfix: '5',
+    stageAppConfig: '6',
+    stageMainEntry: '7',
+  };
+
+  const scriptPath = path.resolve(process.cwd(), process.argv[1]);
+  options.rootDir = scriptPath.replaceAll(/node_modules\/@shijiu\/jsview.*/g, '');
+
+  options.stages = argv.stages?.split(',') ?? [];
+
+  const defaultUpgradeDir = path.resolve(options.rootDir, 'src');
+  options.upgradeDir = path.resolve(process.cwd(), argv.dir ?? defaultUpgradeDir);
+  if (fs.existsSync(options.upgradeDir) == false) {
+    console.error('JsView Error: Upgrade dir [' + options.upgradeDir + '] is not exists.');
+    process.exit(1);
+  }
+
+  console.info();
+  console.info('Upgrade JsView source: ');
+  console.info('  Project folder: ' + options.rootDir);
+  console.info('=====================================');
+  console.info('  Upgrade folder: ' + path.relative(options.rootDir, options.upgradeDir));
+  console.info('  Stages:         [ ' + options.stages.join(', ') + ' ]');
+  console.info('=====================================');
+
+  console.info();
+  console.info('Are you sure to upgrade it?');
+  const answer = askAndAnswer('(y/N) ');
+  if (answer.substring(0, 1) != 'y' && answer.substring(0, 3) != 'yes') {
+    console.error('JsView Info: User cancelled.')
+    process.exit(1);
+  }
+
+  options.sourcePathList = getFilesRecursive(options.upgradeDir);
+
+  return options;
+}
+
+function getFilesRecursive(dirPath) {
+  const ignoreFileList = [
+    '.git',
+    '.gitignore',
+    'node_modules',
+    'package.json',
+    'package-lock.json'
+  ];
+  const fileExtList = [
+    '!.d.ts',
+    '!.min.js',
+    '.css',
+    '.js',
+    '.json',
+    '.mjs',
+    '.ts',
+    '.tsx',
+    '.vue',
+  ];
+
+  let filePathList = [];
+
+  const fileNameList = fs.readdirSync(dirPath);
+  for (const fileName of fileNameList) {
+    if (ignoreFileList.includes(fileName)) {
+      continue;
+    }
+
+    const filePath = path.join(dirPath, fileName);
+    if (fs.statSync(filePath).isDirectory()) {
+      const subFilePathList = getFilesRecursive(filePath);
+      filePathList = [...filePathList, ...subFilePathList];
+    } else {
+      let needUpgrade = false;
+      for (let fileExtName of fileExtList) {
+        if (fileExtName.startsWith('!')) { // 强制忽略该文件
+          fileExtName = fileExtName.substring(1);
+          if (filePath.endsWith(fileExtName)) {
+            break;
+          }
+        } else {
+          if (filePath.endsWith(fileExtName)) {
+            needUpgrade = true;
+            break;
+          }
+        }
+      }
+      if (needUpgrade == false) {
+        continue;
+      }
+
+      const fileExtName = path.extname(filePath);
+      if (fileExtList.includes(fileExtName) == false) {
+        continue;
+      } else if (fileExtList.includes('!' + fileExtName)) {
+        continue;
+      }
+      filePathList.push(filePath);
+    }
+  }
+
+  return filePathList;
+}
+
+function replaceStageContent(options, sourcePathList, msgPrefix,
+                             repleceRegExp, replaceto) {
+  for (const filePath of sourcePathList) {
+    const content = fs.readFileSync(filePath, 'utf8');
+
+    const fixedContent = content.replaceAll(repleceRegExp, replaceto);
+    if (fixedContent === content) {
+      continue;
+    }
+
+    fs.writeFileSync(filePath, fixedContent, 'utf8');
+    console.info(msgPrefix + ': Upgraded ' + path.relative(options.rootDir, filePath));
+  }
+
+  return 0;
+}
+
+function removeStageFile(options, sourcePathList, msgPrefix,
+                         fromExtNameList, toExtName)
+{
+  for (const filePath of sourcePathList) {
+    let fromExtName = null;
+    for (const extName of fromExtNameList) {
+      if (filePath.endsWith(extName)) {
+        fromExtName = extName;
+        break;
+      }
+    }
+    if (fromExtName == null) {
+      continue;
+    }
+
+    const toFilePath = filePath.replace(new RegExp(fromExtName + '$'), toExtName);
+    fs.renameSync(filePath, toFilePath)
+
+    // json => mjs
+    if (fromExtName == '.json') {
+      const content = fs.readFileSync(toFilePath, 'utf8');
+      const fixedContent = 'export default ' + content;
+      fs.writeFileSync(toFilePath, fixedContent, 'utf8');
+    }
+
+    console.info(msgPrefix + ': Upgraded ' + path.relative(options.rootDir, filePath));
+  }
+
+  return 0;
+}
+
+function upgradeStagePixel(options) {
+  const msgPrefix = 'Stage ' + options.stagePixels;
+  console.info(msgPrefix + ': Upgrading pixels...');
+
+  const ret = replaceStageContent(options, options.sourcePathList, msgPrefix,
+                                  /([0-9}])px/g, '$1');
+  return ret;
+}
+
+function upgradeStageAnimation(options)
+{
+  const msgPrefix = 'Stage ' + options.stageAnimation;
+  console.info(msgPrefix + ': Upgrading animation...');
+
+  const ret = replaceStageContent(options, options.sourcePathList, msgPrefix,
+                                  ':onAnimationEnd', '@animationend');
+
+  return ret;
+}
+
+function upgradeStageHashHistory(options)
+{
+  const msgPrefix = 'Stage ' + options.stageHashHistory;
+  console.info(msgPrefix + ': Upgrading hash history...');
+
+  const ret = replaceStageContent(options, options.sourcePathList, msgPrefix,
+                                  'createJsvHashHistory', 'jsvCreateHashHistory');
+
+  return ret;
+}
+
+function upgradeStageAudiotrack(options)
+{
+  const msgPrefix = 'Stage ' + options.stageAudiotrack;
+  console.info(msgPrefix + ': Upgrading audiotrack...');
+
+  const ret = replaceStageContent(options, options.sourcePathList, msgPrefix,
+                                  '<audiotrack', '<jsv-audiotrack');
+
+  return ret;
+}
+
+function upgradeStageImportPostfix(options)
+{
+  const msgPrefix = 'Stage ' + options.stageImportPostfix;
+  console.info(msgPrefix + ': upgrading import postfix...');
+
+  const amendImportPostfix = function(currentDir, content) {
+    if (content.trim().startsWith('import') == false) {
+      return content;
+    }
+
+    let importFromFile = content.replaceAll(/.*'(.*)'.*/g, '$1');
+    if (importFromFile === content) {
+      importFromFile = content.replaceAll(/.*"\(\)".*/g, "$1");
+    }
+    if (importFromFile === content) {
+      return content;
+    }
+
+    let fixedContent = content;
+
+    const importFilePath = path.resolve(currentDir, importFromFile);
+    if (fs.existsSync(importFilePath + '.js')) {
+      // 执行到此处，则需要给给import的文件加上js尾缀。当同时存在.js和.vue时，.js优先。
+      fixedContent = content.replace(importFromFile, importFromFile + '.js');
+    } else if (fs.existsSync(importFilePath + '.vue')) {
+      // 执行到此处，则需要给给import的文件加上vue尾缀。
+      fixedContent = content.replace(importFromFile, importFromFile + '.vue');
+    }
+
+    return fixedContent;
+  }
+
+  for (const filePath of options.sourcePathList) {
+    const currentDir = path.dirname(filePath);
+    const content = fs.readFileSync(filePath, 'utf8');
+
+    const lineContentList = content.split('\n');
+    for (let idx = 0; idx < lineContentList.length; idx++) {
+      let lineContent = lineContentList[idx];
+      lineContent = amendImportPostfix(currentDir, lineContent);
+      lineContentList[idx] = lineContent;
+    }
+
+    const fixedContent = lineContentList.join('\n');
+    if (fixedContent == content) {
+      continue;
+    }
+
+    fs.writeFileSync(filePath, fixedContent, 'utf8');
+    console.info(msgPrefix + ': Upgraded ' + path.relative(options.rootDir, filePath));
+  }
+
+  return 0;
+}
+
+function upgradeStageAppConfig(options)
+{
+  const msgPrefix = 'Stage ' + options.stageAppConfig;
+  console.info(msgPrefix + ': Upgrading appConfig...');
+
+
+  const appConfigDir = path.resolve(options.upgradeDir, 'appConfig');
+  if (fs.existsSync(appConfigDir) == false) {
+    console.error(msgPrefix + ': Failed to upgrading appConfig, appConfig folder is not found.');
+    process.exit(1);
+  }
+
+  const appConfigFilePath = path.resolve(appConfigDir, 'app_config.json');
+
+  let ret = removeStageFile(options, [ appConfigFilePath ], msgPrefix,
+                            [ 'app_config.json' ], 'app.config.json');
+  if (ret < 0) {
+    console.error(msgPrefix + ': Failed to upgrading app config file, is not found.');
+    process.exit(1);
+  }
+
+  const sourcePathList = getFilesRecursive(appConfigDir);
+
+  ret = removeStageFile(options, sourcePathList, msgPrefix,
+                              [ '.js', '.json' ], '.mjs');
+
+  return ret;
+}
+
+function upgradeStageMainEntry(options)
+{
+  const msgPrefix = 'Stage ' + options.stageMainEntry;
+  console.info(msgPrefix + ': Upgrading main entry...');
+
+  const mainEntryFilePath = path.resolve(options.upgradeDir, 'main.ts');
+  const fixedMainEntryFilePath = path.resolve(options.upgradeDir, 'main.tsx');
+  if (fs.existsSync(mainEntryFilePath) == false) {
+    if (fs.existsSync(fixedMainEntryFilePath)) {
+      return 0;
+    }
+    console.error(msgPrefix + ': Failed to upgrading main entry, main.ts is not found.');
+    process.exit(1);
+  }
+
+  const ret = removeStageFile(options, [ mainEntryFilePath ], msgPrefix,
+                              [ 'main.ts' ], 'main.tsx');
+
+  return ret;
+}
+
+function main(argv)
+{
+  checkNodeVersion();
+
+  try {
+    const options = getOptions(argv);
+
+    // Stage 1
+    if (options.stages.includes(options.stagePixels)) {
+      upgradeStagePixel(options);
+    }
+
+    // Stage 2
+    if (options.stages.includes(options.stageAnimation)) {
+      upgradeStageAnimation(options);
+    }
+
+    // Stage 3
+    if (options.stages.includes(options.stageHashHistory)) {
+      upgradeStageHashHistory(options);
+    }
+
+    // Stage 4
+    if (options.stages.includes(options.stageAudiotrack)) {
+      upgradeStageAudiotrack(options);
+    }
+
+    // Stage 5
+    if (options.stages.includes(options.stageImportPostfix)) {
+      upgradeStageImportPostfix(options);
+    }
+
+    // Stage 6
+    if (options.stages.includes(options.stageAppConfig)) {
+      upgradeStageAppConfig(options);
+    }
+
+    // Stage 7
+    if (options.stages.includes(options.stageMainEntry)) {
+      upgradeStageMainEntry(options);
+    }
+  } catch (ex) {
+    console.error('JsView Error: Failed to update jsview source!');
+    console.error(ex);
+    process.exit(1);
+  }
+
+  console.error('JsView Info: Done!');
+}
+
+const requiredUsages = {
+  '--stages': `Upgrade stages, separate by comma(,). The value means the following:
+                            1. Fix pixels.          "[0-9}]px => [0-9}]"
+                            2. Fix animation.       ":onAnimationEnd => @animationend"
+                            3. Fix hash history.    "createJsvHashHistory => jsvCreateHashHistory"
+                            4. Fix audiotrack.      "<audiotrack => <jsv-audiotrack"
+                            5. Fix import postfix.  "import xxx from 'xxx' => import xxx from 'xxx.vue'"
+                            6. Fix appConfig.       "xxx.config.js => xxx.config.mjs"
+                            7. Fix main.ts.         "main.ts => main.tsx"`,
+};
+const optionalUsages = {
+  '--dir': 'Upgrade directory, default is [src].',
+};
+const argv = parseArguments(requiredUsages, optionalUsages, false);
+main(argv)

package/tools/jsview-common.mjs

@@ -320,7 +320,18 @@ function checkNodeVersion(minMajorVersion = 16)
   }
 }
 
+function askAndAnswer(question)
+{
+  process.stdout.write(question)
+  let buffer = Buffer.alloc(100)
+  fs.readSync(0, buffer, 0, 100)
+  let answer = buffer.toString().toLowerCase().replace('\n', '');
+  answer = answer.substring(0, answer.indexOf('\0'));
+  return answer;
+}
+
 export {
+  askAndAnswer,
   checkNodeVersion,
   cpSync,
   execCommand,