@shijiu/jsview 1.9.909 → 1.9.912

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shijiu/jsview",
-  "version": "1.9.909",
+  "version": "1.9.912",
   "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,335 @@
+#!/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',
+    stageAudiotrack: '3',
+    stageImportPostfix: '4',
+    stageAppConfig: '5',
+    stageMainEntry: '6',
+  };
+
+  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,
+                         fromExtName, toExtName)
+{
+  for (const filePath of sourcePathList) {
+    if (filePath.endsWith(fromExtName) == false) {
+      continue;
+    }
+
+    const toFilePath = filePath.replace(new RegExp(fromExtName + '$'), toExtName);
+    fs.renameSync(filePath, toFilePath)
+    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 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 importFilePath = path.resolve(currentDir, importFromFile);
+    importFilePath += '.vue';
+    if (fs.existsSync(importFilePath) == false) {
+      return content;
+    }
+
+    // 执行到此处，则需要给给import的文件加上vue尾缀。
+    const 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 sourcePathList = getFilesRecursive(appConfigDir);
+
+  const ret = removeStageFile(options, sourcePathList, msgPrefix,
+                              '.js', '.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
+  && fs.existsSync(fixedMainEntryFilePath) == false) {
+    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.stageAudiotrack)) {
+      upgradeStageAudiotrack(options);
+    }
+
+    // Stage 4
+    if (options.stages.includes(options.stageImportPostfix)) {
+      upgradeStageImportPostfix(options);
+    }
+
+    // Stage 5
+    if (options.stages.includes(options.stageAppConfig)) {
+      upgradeStageAppConfig(options);
+    }
+
+    // Stage 6
+    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.
+                            2. Fix animation.
+                            3. Fix audiotrack.
+                            4. Fix import postfix.
+                            5. Fix appConfig.
+                            6. Rename main.ts to 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,

package/tools/jsview-upgrade.mjs

@@ -1,353 +0,0 @@
-#!/usr/bin/env node
-'use strict';
-
-import fs from 'fs';
-import path from 'path';
-import url from 'url';
-import {
-  checkNodeVersion,
-  execCommand,
-  parseArguments
-} from './jsview-common.mjs';
-
-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;
-}
-
-function getArgument(argument, usage)
-{
-  if (!argument) {
-    return argument;
-  }
-
-  if (typeof (argument) != 'string') {
-    console.error('JsView Error: ' + usage + ' is not a valid path.');
-    process.exit(1);
-  }
-  const argumentPath = path.resolve(process.cwd(), argument);
-  if (fs.existsSync(argumentPath) == false) {
-    console.error('JsView Error: ' + argument + ' is not exists.');
-    process.exit(1);
-  }
-
-  return argumentPath;
-}
-
-function getOptions(argv)
-{
-  const options = {};
-
-  const scriptPath = path.resolve(process.cwd(), process.argv[1]);
-  options.rootDir = scriptPath.replaceAll(/node_modules\/@shijiu\/jsview.*/g, '');
-
-  options.jsviewVersion = argv.jsviewVersion;
-
-  options.stagePixel = getArgument(argv.stagePixel, '--stage-pixel');
-  options.stageAnimation = getArgument(argv.stageAnimation, '--stage-animation');
-  options.stagePkgJson = getArgument(argv.stagePkgJson, '--stage-pkg-json');
-
-  console.info();
-  console.info('Upgrade to JsView version: ' + options.jsviewVersion);
-  console.info('  Project folder:    ' + options.rootDir);
-  console.info('=====================================');
-  console.info('  Stage pixel:        ' + (options.stagePixel ?? false));
-  console.info('  Stage animation:    ' + (options.stageAnimation ?? false));
-  console.info('  Stage package.json: ' + (options.stagePkgJson ?? false));
-  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);
-  }
-
-  return options;
-}
-
-function getFilesRecursive(dirPath) {
-  const ignoreFileList = [
-    '.git',
-    '.gitignore',
-    'node_modules',
-    'package.json',
-    'package-lock.json'
-  ];
-  const fileExtList = [
-    '!.min.js',
-    '.css',
-    '.js',
-    '.json',
-    '.mjs',
-    '.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 upgradeStagePixel(options) {
-  console.info('Upgrading stage pixel...');
-
-  const filePathList = getFilesRecursive(options.stagePixel);
-
-  for (const filePath of filePathList) {
-    try {
-      let content = fs.readFileSync(filePath, 'utf8');
-
-      content = content.replaceAll(/([0-9])px/g, '$1');
-
-      fs.writeFileSync(filePath, content, 'utf8');
-    } catch (ex) {
-      console.error('JsView Error: Failed to update pixel for file: ' + filePath);
-      console.error(ex);
-      process.exit(1);
-    }
-  }
-
-  console.info('Upgraded stage pixel...');
-
-  return 0;
-}
-
-function upgradeStageAnimation(options)
-{
-  console.info('Upgrading stage animation...');
-
-  if (typeof (options.stageAnimation) != 'string'
-    || fs.existsSync(options.stageAnimation) == false) {
-    console.error('JsView Error: --stage-animation is not a valid path.');
-    process.exit(1);
-  }
-
-  const filePathList = getFilesRecursive(options.stageAnimation);
-
-  for (const filePath of filePathList) {
-    try {
-      let content = fs.readFileSync(filePath, 'utf8');
-
-      content = content.replaceAll(':onAnimationEnd', '@animationend');
-
-      fs.writeFileSync(filePath, content, 'utf8');
-    } catch (ex) {
-      console.error('JsView Error: Failed to update animation for file: ' + filePath);
-      console.error(ex);
-      process.exit(1);
-    }
-  }
-
-  console.info('Upgraded stage animation...');
-
-  return 0;
-}
-
-function getFramework(pkgJsonFilePath)
-{
-  if (fs.existsSync(pkgJsonFilePath) == false) {
-    console.error('JsView Error: Failed to find package.json: ' + pkgJsonFilePath);
-    process.exit(1);
-  }
-
-  let framework = 'unknown';
-
-  const content = fs.readFileSync(pkgJsonFilePath, 'utf8');
-  const pkgObj = JSON.parse(content);
-  if (pkgObj.dependencies?.vue) {
-    framework = 'vue';
-  } else if (pkgObj.dependencies?.react) {
-    framework = 'react';
-  } else {
-    console.error('JsView Error: Failed to recognize framework.');
-    process.exit(1);
-  }
-
-  return framework;
-}
-
-function upgradeVueStagePackageJson(options)
-{
-  console.info('Upgrading stage package.json...');
-
-  const needRemovePkgs = [
-    // dependencies
-    '@shijiu/jsview-vue',
-    'core-js',
-    'deepmerge',
-    'fork-ts-checker-webpack-plugin',
-    'gifuct-js',
-    'qr.js',
-    'vue',
-    'vue-router',
-
-    // devDependencies
-    '@typescript-eslint/eslint-plugin',
-    '@typescript-eslint/parser',
-    '@vue/cli-plugin-babel',
-    '@vue/cli-plugin-eslint',
-    '@vue/cli-plugin-typescript',
-    '@vue/cli-service',
-    '@vue/compiler-sfc',
-    '@vue/eslint-config-typescript',
-    'babel-eslint',
-    'cache-loader',
-    'cosmiconfig',
-    'eslint',
-    'eslint-plugin-node',
-    'eslint-plugin-promise',
-    'eslint-plugin-standard',
-    'eslint-plugin-vue',
-    'fork-ts-checker-webpack-plugin-v5',
-    'postcss-import-sync',
-    'postcss-js',
-    'typescript',
-    'vue-class-component',
-    'webpack',
-  ];
-
-  const needAppendPkgs = {
-    '@shijiu/jsview': '1.9.888',
-    '@shijiu/jsview-vue': '1.9.888',
-    'vue': '3.2.45',
-    'vue-router': '4.1.6',
-  };
-  const needAppendDevPkgs = {
-    '@vitejs/plugin-vue': '4.0.0',
-    'typescript': '4.9.3',
-    'vite': '4.0.0',
-    'vue-tsc': '1.0.11',
-  };
-
-  if (typeof (options.stagePkgJson) != 'string'
-  || fs.existsSync(options.stagePkgJson) == false) {
-    console.error('JsView Error: --stage-pkg-json is not a valid path.');
-    process.exit(1);
-  }
-
-  try {
-    let content = fs.readFileSync(options.stagePkgJson, 'utf8');
-    const pkgObj = JSON.parse(content);
-
-    // 删除旧内容
-    delete pkgObj.main;
-    delete pkgObj.eslintConfig;
-    delete pkgObj.scripts.lint;
-    delete pkgObj.scripts.serve;
-    for (const removePkg of needRemovePkgs) {
-      delete pkgObj.dependencies[removePkg];
-      delete pkgObj.devDependencies[removePkg];
-    }
-
-    // 添加新内容
-    pkgObj.type = 'module';
-    pkgObj.scripts.android = 'node node_modules/@shijiu/jsview/tools/jsview-run-android.mjs --framework=vue';
-    pkgObj.scripts.build = 'vue-tsc && vite build && node node_modules/@shijiu/jsview/tools/jsview-post-build.mjs --framework=vue';
-    pkgObj.scripts.dev = 'vite';
-    pkgObj.scripts.postinstall = 'node node_modules/@shijiu/jsview/tools/jsview-post-install.mjs --framework=vue';
-    pkgObj.scripts.preview = 'vite preview';
-    pkgObj.scripts.start = 'vite';
-    pkgObj.browserslist = ['chrome 102', 'not dead'];
-
-    for (const [key, value] of Object.entries(needAppendPkgs)) {
-      pkgObj.dependencies[key] = value;
-    }
-    for (const [key, value] of Object.entries(needAppendDevPkgs)) {
-      pkgObj.devDependencies[key] = value;
-    }
-
-    content = JSON.stringify(pkgObj, null, 2);
-    fs.writeFileSync(options.stagePkgJson, content, 'utf8');
-  } catch (ex) {
-    console.error('JsView Error: Failed to update package.json: ' + options.stagePkgJson);
-    console.error(ex);
-    process.exit(1);
-  }
-
-  execCommand('npm install');
-
-  console.info('Upgraded stage package.json...');
-
-  return 0;
-}
-
-function main(argv)
-{
-  checkNodeVersion();
-
-  const options = getOptions(argv);
-
-  if (options.stagePixel) {
-    upgradeStagePixel(options);
-  }
-  if (options.stageAnimation) {
-    upgradeStageAnimation(options);
-  }
-  if (options.stagePkgJson) {
-    const framework = getFramework(options.stagePkgJson);
-    if (framework == 'vue') {
-      upgradeVueStagePackageJson(options);
-    } else {
-      console.error('JsView Error: Upgrade ' + framework + ' package.json is not implementation.');
-      process.exit(1);
-    }
-  }
-}
-
-const requiredUsages = {
-  '--jsv | --jsview-version': 'The version of jsview that is expected to be upgraded.',
-};
-const optionalUsages = {
-  '--stage-animation': 'Fix animations, value is a directory.',
-  '--stage-app-config': 'Upgrade appConfig to new version.',
-  '--stage-main-js': 'Upgrade main.js to new version.',
-  '--stage-pixel': 'Fix pixels, value is a directory.',
-  '--stage-pkg-json': 'Upgrade package.json to new version.',
-};
-const argv = parseArguments(requiredUsages, optionalUsages, false);
-main(argv)