@spcsn/taro-cli 0.1.5 → 1.0.0

package/src/cli.ts

@@ -1,14 +1,117 @@
 import * as path from 'node:path';
 
-import { dotenvParse, fs, patchEnv } from '@spcsn/taro-helper';
+import { dotenvParse, patchEnv } from '@spcsn/taro-helper';
 import { Config, Kernel } from '@spcsn/taro-service';
-import minimist from 'minimist';
 
-import customCommand from './commands/customCommand';
-import { getPkgVersion } from './util';
+import customCommand from './commands/custom-command';
+import { cliProfiler, getPkgVersion } from './util/index.js';
 
-const DISABLE_GLOBAL_CONFIG_COMMANDS = ['global-config', 'doctor', 'update', 'config'];
 const DEFAULT_FRAMEWORK = 'react';
+const SUPPORTED_COMMANDS = new Set(['build', 'init']);
+
+interface CliArgs {
+  _: string[];
+  [key: string]: boolean | number | string | string[] | undefined;
+}
+
+const ARG_ALIASES: Record<string, string[]> = {
+  envPrefix: ['env-prefix'],
+  help: ['h'],
+  port: ['p'],
+  version: ['v'],
+};
+
+const BOOLEAN_ARGS = new Set(['disable-global-config', 'h', 'help', 'v', 'version']);
+
+function parseArgValue(value: string): number | string {
+  if (value.trim() !== '' && /^-?\d+(\.\d+)?$/.test(value)) {
+    return Number(value);
+  }
+
+  return value;
+}
+
+function setArgValue(args: CliArgs, key: string, value: boolean | number | string) {
+  args[key] = value;
+
+  for (const [canonicalKey, aliases] of Object.entries(ARG_ALIASES)) {
+    if (key === canonicalKey || aliases.includes(key)) {
+      args[canonicalKey] = value;
+      aliases.forEach((alias) => {
+        args[alias] = value;
+      });
+      return;
+    }
+  }
+}
+
+function getStringArg(args: CliArgs, key: string): string | undefined {
+  const value = args[key];
+  return typeof value === 'string' ? value : undefined;
+}
+
+function getNumberArg(args: CliArgs, key: string): number | undefined {
+  const value = args[key];
+  return typeof value === 'number' ? value : undefined;
+}
+
+function parseCliArgs(argv: string[]): CliArgs {
+  const args: CliArgs = {
+    _: [],
+    build: true,
+    check: true,
+    h: false,
+    help: false,
+    'inject-global-style': true,
+    v: false,
+    version: false,
+  };
+
+  for (let index = 0; index < argv.length; index++) {
+    const item = argv[index];
+    if (!item.startsWith('-') || item === '-') {
+      args._.push(item);
+      continue;
+    }
+
+    if (item === '--') {
+      args._.push(...argv.slice(index + 1));
+      break;
+    }
+
+    const normalizedItem = item.replace(/^--?/, '');
+    const equalIndex = normalizedItem.indexOf('=');
+    const rawKey = equalIndex >= 0 ? normalizedItem.slice(0, equalIndex) : normalizedItem;
+    const inlineValue = equalIndex >= 0 ? normalizedItem.slice(equalIndex + 1) : undefined;
+    const isNegativeBoolean = rawKey.startsWith('no-');
+    const key = isNegativeBoolean ? rawKey.slice(3) : rawKey;
+
+    if (isNegativeBoolean) {
+      setArgValue(args, key, false);
+      continue;
+    }
+
+    if (inlineValue !== undefined) {
+      setArgValue(args, key, parseArgValue(inlineValue));
+      continue;
+    }
+
+    if (BOOLEAN_ARGS.has(key)) {
+      setArgValue(args, key, true);
+      continue;
+    }
+
+    const nextItem = argv[index + 1];
+    if (nextItem && !nextItem.startsWith('-')) {
+      setArgValue(args, key, parseArgValue(nextItem));
+      index++;
+    } else {
+      setArgValue(args, key, true);
+    }
+  }
+
+  return args;
+}
 
 export default class CLI {
   appPath: string;
@@ -25,58 +128,45 @@ export default class CLI {
   }
 
   async parseArgs() {
-    const args = minimist(process.argv.slice(2), {
-      alias: {
-        version: ['v'],
-        help: ['h'],
-        port: ['p'],
-        resetCache: ['reset-cache'], // specially for rn, Removes cached files.
-        publicPath: ['public-path'], // specially for rn, assets public path.
-        bundleOutput: ['bundle-output'], // specially for rn, File name where to store the resulting bundle.
-        sourcemapOutput: ['sourcemap-output'], // specially for rn, File name where to store the sourcemap file for resulting bundle.
-        sourceMapUrl: ['sourcemap-use-absolute-path'], // specially for rn, Report SourceMapURL using its full path.
-        sourcemapSourcesRoot: ['sourcemap-sources-root'], // specially for rn, Path to make sourcemaps sources entries relative to.
-        assetsDest: ['assets-dest'], // specially for rn, Directory name where to store assets referenced in the bundle.
-        envPrefix: ['env-prefix'],
-      },
-      boolean: ['version', 'help', 'disable-global-config'],
-      default: {
-        build: true,
-        check: true,
-        'inject-global-style': true,
-      },
-    });
+    const totalStartMs = cliProfiler.start();
+    const parseArgsStartMs = cliProfiler.start();
+    const args = parseCliArgs(process.argv.slice(2));
+    cliProfiler.end('parse args', parseArgsStartMs);
     const _ = args._;
     const command = _[0];
     if (command) {
       const appPath = this.appPath;
       const presetsPath = path.resolve(__dirname, 'presets');
       const commandsPath = path.resolve(presetsPath, 'commands');
-      const platformsPath = path.resolve(presetsPath, 'platforms');
-      const commandPlugins = fs.readdirSync(commandsPath);
       const targetPlugin = `${command}.js`;
 
+      if (!SUPPORTED_COMMANDS.has(command)) {
+        console.log('当前 CLI 仅支持 build 和 init 命令。');
+        return;
+      }
+
       // 设置环境变量
-      process.env.NODE_ENV ||= args.env;
-      if (process.env.NODE_ENV === 'undefined' && (command === 'build' || command === 'inspect')) {
+      const env = getStringArg(args, 'env');
+      const envPrefix = getStringArg(args, 'envPrefix');
+      process.env.NODE_ENV ||= env;
+      if (process.env.NODE_ENV === 'undefined' && command === 'build') {
         process.env.NODE_ENV = args.watch ? 'development' : 'production';
       }
-      args.type ||= args.t;
-      // React-only / weapp-first fork：build/inspect 命令未显式指定 --type 时默认 weapp
-      if (!args.type && (command === 'build' || command === 'inspect') && typeof args.plugin !== 'string') {
+      args.type ||= getStringArg(args, 't');
+      if (!args.type && command === 'build') {
         args.type = 'weapp';
       }
-      if (args.type) {
-        process.env.TARO_ENV = args.type;
+      const type = getStringArg(args, 'type');
+      if (type) {
+        process.env.TARO_ENV = type;
       }
-      if (typeof args.plugin === 'string') {
-        process.env.TARO_ENV = 'plugin';
-      }
-      const mode = args.mode || process.env.NODE_ENV;
+      const mode = getStringArg(args, 'mode') || process.env.NODE_ENV || 'production';
       // 这里解析 dotenv 以便于 config 解析时能获取 dotenv 配置信息
-      const expandEnv = dotenvParse(appPath, args.envPrefix, mode);
+      const dotenvStartMs = cliProfiler.start();
+      const expandEnv = dotenvParse(appPath, envPrefix, mode);
+      cliProfiler.end('dotenv parse', dotenvStartMs);
 
-      const disableGlobalConfig = !!(args['disable-global-config'] || DISABLE_GLOBAL_CONFIG_COMMANDS.includes(command));
+      const disableGlobalConfig = !!args['disable-global-config'];
 
       const configEnv = {
         mode,
@@ -86,14 +176,16 @@ export default class CLI {
         appPath: this.appPath,
         disableGlobalConfig: disableGlobalConfig,
       });
-      await config.init(configEnv);
+      await cliProfiler.measure('config init', () => config.init(configEnv));
 
+      const kernelStartMs = cliProfiler.start();
       const kernel = new Kernel({
         appPath,
         presets: [path.resolve(__dirname, '.', 'presets', 'index.js')],
         config,
         plugins: [],
       });
+      cliProfiler.end('kernel init', kernelStartMs);
       kernel.optsPlugins ||= [];
 
       // 将自定义的 变量 添加到 config.env 中，实现 definePlugin 字段定义
@@ -101,28 +193,18 @@ export default class CLI {
       if (initialConfig) {
         initialConfig.env = patchEnv(initialConfig, expandEnv);
       }
-      if (commandPlugins.includes(targetPlugin)) {
-        // 针对不同的内置命令注册对应的命令插件
-        kernel.optsPlugins.push(path.resolve(commandsPath, targetPlugin));
-      }
-
-      // 把内置命令插件传递给 kernel，可以暴露给其他插件使用
+      kernel.optsPlugins.push(path.resolve(commandsPath, targetPlugin));
       kernel.cliCommandsPath = commandsPath;
-      kernel.cliCommands = commandPlugins
-        .filter((commandFileName) => /^[\w-]+(\.[\w-]+)*\.js$/.test(commandFileName))
-        .map((fileName) => fileName.replace(/\.js$/, ''));
+      kernel.cliCommands = Array.from(SUPPORTED_COMMANDS);
 
       switch (command) {
-        case 'inspect':
         case 'build': {
-          let plugin;
-          let platform = args.type;
-          const { publicPath, bundleOutput, sourcemapOutput, sourceMapUrl, sourcemapSourcesRoot, assetsDest } = args;
+          let platform = getStringArg(args, 'type');
 
           // 针对不同的内置平台注册对应的端平台插件
           switch (platform) {
             case 'weapp':
-              kernel.optsPlugins.push(`@spcsn/taro-plugin-platform-${platform}`);
+              kernel.optsPlugins.push(path.resolve(__dirname, 'platform-weapp'));
               break;
             default: {
               if (platform) {
@@ -139,78 +221,56 @@ export default class CLI {
             console.log('当前 Fork 仅支持 React 框架。');
             return;
           }
-          kernel.optsPlugins.push('@spcsn/taro-plugin-framework-react');
-
-          // 编译小程序插件
-          if (typeof args.plugin === 'string') {
-            plugin = args.plugin;
-            if (plugin !== 'weapp') {
-              console.log('当前 Fork 仅支持 weapp 小程序插件编译。');
-              return;
-            }
-            platform = 'plugin';
-            kernel.optsPlugins.push(path.resolve(platformsPath, 'plugin.js'));
-            kernel.optsPlugins.push(`@spcsn/taro-plugin-platform-${plugin}`);
-          }
-
-          // 传递 inspect 参数即可
-          if (command === 'inspect') {
-            customCommand(command, kernel, args);
-            break;
-          }
-          customCommand(command, kernel, {
-            args,
-            _,
-            platform,
-            plugin,
-            isWatch: Boolean(args.watch),
-            // Note: 是否把 Taro 组件编译为原生自定义组件
-            isBuildNativeComp: _[1] === 'native-components',
-            // Note: 新的混合编译模式，支持把组件单独编译为原生组件
-            newBlended: Boolean(args['new-blended']),
-            // Note: 是否禁用编译
-            withoutBuild: !args.build,
-            noInjectGlobalStyle: !args['inject-global-style'],
-            noCheck: !args.check,
-            port: args.port,
-            env: args.env,
-            deviceType: args.platform,
-            resetCache: !!args.resetCache,
-            publicPath,
-            bundleOutput,
-            sourcemapOutput,
-            sourceMapUrl,
-            sourcemapSourcesRoot,
-            assetsDest,
-            qr: !!args.qr,
-            blended: Boolean(args.blended),
-            h: args.h,
-          });
+          kernel.optsPlugins.push(require.resolve('@spcsn/taro-mini-runner/framework-react'));
+          await cliProfiler.measure('build command', () =>
+            customCommand(command, kernel, {
+              args,
+              _,
+              platform,
+              isWatch: Boolean(args.watch),
+              // Note: 是否把 Taro 组件编译为原生自定义组件
+              isBuildNativeComp: _[1] === 'native-components',
+              // Note: 新的混合编译模式，支持把组件单独编译为原生组件
+              newBlended: Boolean(args['new-blended']),
+              // Note: 是否禁用编译
+              withoutBuild: !args.build,
+              noInjectGlobalStyle: !args['inject-global-style'],
+              noCheck: !args.check,
+              port: getNumberArg(args, 'port'),
+              env,
+              deviceType: getStringArg(args, 'platform'),
+              qr: !!args.qr,
+              blended: Boolean(args.blended),
+              h: args.h,
+            }),
+          );
+          cliProfiler.end('total', totalStartMs);
+          cliProfiler.print();
           break;
         }
         case 'init': {
-          customCommand(command, kernel, {
-            _,
-            appPath,
-            projectName: _[1] || args.name,
-            description: args.description,
-            typescript: args.typescript,
-            buildEs5: args['build-es5'],
-            framework: args.framework,
-            compiler: args.compiler,
-            npm: args.npm,
-            templateSource: args['template-source'],
-            clone: !!args.clone,
-            template: args.template,
-            css: args.css,
-            autoInstall: args.autoInstall,
-            h: args.h,
-          });
+          await cliProfiler.measure('init command', () =>
+            customCommand(command, kernel, {
+              _,
+              appPath,
+              projectName: _[1] || getStringArg(args, 'name'),
+              description: getStringArg(args, 'description'),
+              typescript: args.typescript,
+              framework: getStringArg(args, 'framework'),
+              compiler: getStringArg(args, 'compiler'),
+              npm: getStringArg(args, 'npm'),
+              templateSource: getStringArg(args, 'template-source'),
+              clone: !!args.clone,
+              template: getStringArg(args, 'template'),
+              css: getStringArg(args, 'css'),
+              autoInstall: args.autoInstall,
+              h: args.h,
+            }),
+          );
+          cliProfiler.end('total', totalStartMs);
+          cliProfiler.print();
           break;
         }
-        default:
-          customCommand(command, kernel, args);
-          break;
       }
     } else {
       if (args.h) {
@@ -221,15 +281,8 @@ export default class CLI {
         console.log('  -h, --help          output usage information');
         console.log();
         console.log('Commands:');
-        console.log('  init [projectName]  Init a project with default templete');
-        console.log('  config <cmd>        Taro config');
-        console.log('  create              Create page for project');
-        console.log('  build               Build a project with options');
-        console.log('  update              Update packages of taro');
-        console.log('  info                Diagnostics Taro env info');
-        console.log('  doctor              Diagnose taro project');
-        console.log('  inspect             Inspect the webpack config');
-        console.log('  help [cmd]          display help for [cmd]');
+        console.log('  init [projectName]  Init a project with default template');
+        console.log('  build               Build a WeApp project');
       } else if (args.v) {
         console.log(getPkgVersion());
       }

package/src/commands/custom-command.ts

@@ -0,0 +1,22 @@
+import { Kernel } from '@spcsn/taro-service';
+
+export default function customCommand(command: string, kernel: Kernel, args: { _: string[]; [key: string]: any }) {
+  if (typeof command !== 'string') return Promise.resolve();
+
+  const options: any = {};
+  const excludeKeys = ['_', 'version', 'v', 'help', 'h', 'disable-global-config'];
+  Object.keys(args).forEach((key) => {
+    if (!excludeKeys.includes(key)) {
+      options[key] = args[key];
+    }
+  });
+
+  return kernel.run({
+    name: command,
+    opts: {
+      _: args._,
+      options,
+      isHelp: args.h,
+    },
+  });
+}

package/src/create/{fetchTemplate.ts → fetch-template.ts}

@@ -2,7 +2,6 @@ import * as path from 'node:path';
 
 import { chalk, fs } from '@spcsn/taro-helper';
 import * as AdmZip from 'adm-zip';
-import axios from 'axios';
 import * as download from 'download-git-repo';
 import ora from 'ora';
 
@@ -19,7 +18,7 @@ export interface ITemplates {
 
 const TEMP_DOWNLOAD_FOLDER = 'taro-temp';
 
-export default function fetchTemplate(
+export default async function fetchTemplate(
   templateSource: string,
   templateRootPath: string,
   clone?: boolean,
@@ -27,13 +26,13 @@ export default function fetchTemplate(
   const type = getTemplateSourceType(templateSource);
   const tempPath = path.join(templateRootPath, TEMP_DOWNLOAD_FOLDER);
   let name: string;
-  // eslint-disable-next-line no-async-promise-executor
-  return new Promise<void>(async (resolve) => {
-    // 下载文件的缓存目录
-    if (fs.existsSync(tempPath)) await fs.remove(tempPath);
-    await fs.mkdirp(templateRootPath);
-    await fs.mkdir(tempPath);
 
+  // 下载文件的缓存目录
+  if (fs.existsSync(tempPath)) await fs.remove(tempPath);
+  await fs.mkdirp(templateRootPath);
+  await fs.mkdir(tempPath);
+
+  return new Promise<void>((resolve) => {
     const spinner = ora(`正在从 ${templateSource} 拉取远程模板...`).start();
 
     if (type === 'git') {
@@ -55,33 +54,29 @@ export default function fetchTemplate(
       name = 'from-remote-url';
       const zipPath = path.join(tempPath, name + '.zip');
       const unZipPath = path.join(tempPath, name);
-      axios
-        .get<fs.ReadStream>(templateSource, { responseType: 'stream' })
-        .then((response) => {
-          const ws = fs.createWriteStream(zipPath);
-          response.data.pipe(ws);
-          ws.on('finish', () => {
-            // unzip
-            const zip = new AdmZip(zipPath);
-            zip.extractAllTo(unZipPath, true);
-            const files = readDirWithFileTypes(unZipPath).filter(
-              (file) => !file.name.startsWith('.') && file.isDirectory && file.name !== '__MACOSX',
-            );
-
-            if (files.length !== 1) {
-              spinner.color = 'red';
-              spinner.fail(chalk.red(`拉取远程模板仓库失败！\n${new Error('远程模板源组织格式错误')}`));
-              return resolve();
-            }
-            name = path.join(name, files[0].name);
-
-            spinner.color = 'green';
-            spinner.succeed(`${chalk.grey('拉取远程模板仓库成功！')}`);
-            resolve();
-          });
-          ws.on('error', (error) => {
-            throw error;
-          });
+      fetch(templateSource)
+        .then(async (response) => {
+          if (!response.ok) {
+            throw new Error(`HTTP ${response.status} ${response.statusText}`);
+          }
+
+          await fs.writeFile(zipPath, Buffer.from(await response.arrayBuffer()));
+          const zip = new AdmZip(zipPath);
+          zip.extractAllTo(unZipPath, true);
+          const files = readDirWithFileTypes(unZipPath).filter(
+            (file) => !file.name.startsWith('.') && file.isDirectory && file.name !== '__MACOSX',
+          );
+
+          if (files.length !== 1) {
+            spinner.color = 'red';
+            spinner.fail(chalk.red(`拉取远程模板仓库失败！\n${new Error('远程模板源组织格式错误')}`));
+            return resolve();
+          }
+          name = path.join(name, files[0].name);
+
+          spinner.color = 'green';
+          spinner.succeed(`${chalk.grey('拉取远程模板仓库成功！')}`);
+          resolve();
         })
         .catch(async (error) => {
           spinner.color = 'red';