@spcsn/taro-cli 0.1.0

package/src/cli.ts

@@ -0,0 +1,240 @@
+import * as path from 'node:path';
+
+import { dotenvParse, fs, 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';
+
+const DISABLE_GLOBAL_CONFIG_COMMANDS = ['global-config', 'doctor', 'update', 'config'];
+const DEFAULT_FRAMEWORK = 'react';
+
+export default class CLI {
+  appPath: string;
+  constructor(appPath?: string) {
+    this.appPath = appPath || process.cwd();
+    const majorVersion = parseInt(process.version.substring(1).split('.')[0], 10);
+    if (majorVersion < 20) {
+      console.warn('Taro 将不再支持 Node.js 小于 20 的版本。请升级 Node.js 至 20 或更高版本。');
+    }
+  }
+
+  run() {
+    return this.parseArgs();
+  }
+
+  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 _ = 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`;
+
+      // 设置环境变量
+      process.env.NODE_ENV ||= args.env;
+      if (process.env.NODE_ENV === 'undefined' && (command === 'build' || command === 'inspect')) {
+        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 = 'weapp';
+      }
+      if (args.type) {
+        process.env.TARO_ENV = args.type;
+      }
+      if (typeof args.plugin === 'string') {
+        process.env.TARO_ENV = 'plugin';
+      }
+      const mode = args.mode || process.env.NODE_ENV;
+      // 这里解析 dotenv 以便于 config 解析时能获取 dotenv 配置信息
+      const expandEnv = dotenvParse(appPath, args.envPrefix, mode);
+
+      const disableGlobalConfig = !!(args['disable-global-config'] || DISABLE_GLOBAL_CONFIG_COMMANDS.includes(command));
+
+      const configEnv = {
+        mode,
+        command,
+      };
+      const config = new Config({
+        appPath: this.appPath,
+        disableGlobalConfig: disableGlobalConfig,
+      });
+      await config.init(configEnv);
+
+      const kernel = new Kernel({
+        appPath,
+        presets: [path.resolve(__dirname, '.', 'presets', 'index.js')],
+        config,
+        plugins: [],
+      });
+      kernel.optsPlugins ||= [];
+
+      // 将自定义的 变量 添加到 config.env 中，实现 definePlugin 字段定义
+      const initialConfig = kernel.config?.initialConfig;
+      if (initialConfig) {
+        initialConfig.env = patchEnv(initialConfig, expandEnv);
+      }
+      if (command === 'doctor') {
+        kernel.optsPlugins.push('@tarojs/plugin-doctor');
+      } else if (commandPlugins.includes(targetPlugin)) {
+        // 针对不同的内置命令注册对应的命令插件
+        kernel.optsPlugins.push(path.resolve(commandsPath, targetPlugin));
+      }
+
+      // 把内置命令插件传递给 kernel，可以暴露给其他插件使用
+      kernel.cliCommandsPath = commandsPath;
+      kernel.cliCommands = commandPlugins
+        .filter((commandFileName) => /^[\w-]+(\.[\w-]+)*\.js$/.test(commandFileName))
+        .map((fileName) => fileName.replace(/\.js$/, ''));
+
+      switch (command) {
+        case 'inspect':
+        case 'build': {
+          let plugin;
+          let platform = args.type;
+          const { publicPath, bundleOutput, sourcemapOutput, sourceMapUrl, sourcemapSourcesRoot, assetsDest } = args;
+
+          // 针对不同的内置平台注册对应的端平台插件
+          switch (platform) {
+            case 'weapp':
+              kernel.optsPlugins.push(`@spcsn/taro-plugin-platform-${platform}`);
+              break;
+            default: {
+              if (platform) {
+                console.log('当前 Fork 仅支持微信小程序（weapp）构建。');
+                return;
+              }
+              break;
+            }
+          }
+
+          // 根据 framework 启用插件
+          const framework = kernel.config?.initialConfig.framework || DEFAULT_FRAMEWORK;
+          if (framework !== 'react') {
+            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,
+          });
+          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,
+          });
+          break;
+        }
+        default:
+          customCommand(command, kernel, args);
+          break;
+      }
+    } else {
+      if (args.h) {
+        console.log('Usage: taro <command> [options]');
+        console.log();
+        console.log('Options:');
+        console.log('  -v, --version       output the version number');
+        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]');
+      } else if (args.v) {
+        console.log(getPkgVersion());
+      }
+    }
+  }
+}

package/src/commands/customCommand.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') {
+    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];
+      }
+    });
+
+    kernel.run({
+      name: command,
+      opts: {
+        _: args._,
+        options,
+        isHelp: args.h,
+      },
+    });
+  }
+}

package/src/config/index.ts

@@ -0,0 +1,7 @@
+export default {
+  OUTPUT_DIR: 'dist',
+  SOURCE_DIR: 'src',
+  TEMP_DIR: '.temp',
+  NPM_DIR: 'npm',
+  ENTRY: 'app',
+};

package/src/config/manifest.default.json

@@ -0,0 +1,33 @@
+{
+  "package": "com.application.demo",
+  "name": "TaroQuickApp",
+  "versionName": "1.0.0",
+  "versionCode": 1,
+  "minPlatformVersion": 1040,
+  "features": [
+    { "name": "system.prompt" },
+    { "name": "system.router" },
+    { "name": "system.shortcut" },
+    { "name": "system.fetch" },
+    { "name": "system.storage" },
+    { "name": "system.barcode" },
+    { "name": "system.vibrator" },
+    { "name": "system.clipboard" },
+    { "name": "system.sensor" },
+    { "name": "system.geolocation" },
+    { "name": "system.share" },
+    { "name": "system.notification" },
+    { "name": "system.device" },
+    { "name": "system.webview" },
+    { "name": "system.request" },
+    { "name": "system.audio" },
+    { "name": "system.record" },
+    { "name": "system.contact" },
+    { "name": "system.sms" }
+  ],
+  "icon": "logo.png",
+  "permissions": [{ "origin": "*" }],
+  "config": {
+    "logLevel": "debug"
+  }
+}

package/src/config/packagesManagement.ts

@@ -0,0 +1,20 @@
+const packagesManagement = {
+  yarn: {
+    command: 'yarn install',
+    globalCommand: 'yarn global add @spcsn/taro-cli',
+  },
+  pnpm: {
+    command: 'pnpm install',
+    globalCommand: 'pnpm add -g @spcsn/taro-cli',
+  },
+  cnpm: {
+    command: 'cnpm install',
+    globalCommand: 'cnpm i -g @spcsn/taro-cli',
+  },
+  npm: {
+    command: 'npm install',
+    globalCommand: 'npm i -g @spcsn/taro-cli',
+  },
+};
+
+export default packagesManagement;

package/src/config/rn-stylelint.json

@@ -0,0 +1,4 @@
+{
+  "extends": "stylelint-config-taro-rn",
+  "rules": {}
+}

package/src/config/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "allowSyntheticDefaultImports": true,
+    "declaration": false,
+    "experimentalDecorators": true,
+    "jsx": "react",
+    "jsxFactory": "React.createElement",
+    "module": "commonjs",
+    "noImplicitAny": false,
+    "noUnusedLocals": true,
+    "outDir": "./dist/",
+    "preserveConstEnums": true,
+    "removeComments": false,
+    "rootDir": ".",
+    "sourceMap": true,
+    "strictNullChecks": true,
+    "target": "es6"
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules"],
+  "compileOnSave": false
+}

package/src/create/constants.ts

@@ -0,0 +1 @@
+export const TEMPLATE_CREATOR = 'template_creator.js';

package/src/create/creator.ts

@@ -0,0 +1,37 @@
+import * as path from 'node:path';
+
+import { fs } from '@spcsn/taro-helper';
+
+import { getRootPath } from '../util';
+
+export default class Creator {
+  protected _rootPath!: string;
+  public rootPath: string;
+
+  constructor(sourceRoot?: string) {
+    this.rootPath = this.sourceRoot(sourceRoot || path.join(getRootPath()));
+    this.init();
+  }
+
+  init() {}
+
+  sourceRoot(rootPath?: string) {
+    if (typeof rootPath === 'string') {
+      this._rootPath = path.resolve(rootPath);
+    }
+    if (!fs.existsSync(this._rootPath)) {
+      fs.ensureDirSync(this._rootPath);
+    }
+    return this._rootPath;
+  }
+
+  templatePath(...args: string[]): string {
+    let filepath = path.join.apply(path, args);
+    if (!path.isAbsolute(filepath)) {
+      filepath = path.join(this._rootPath, 'templates', filepath);
+    }
+    return filepath;
+  }
+
+  write() {}
+}

package/src/create/fetchTemplate.ts

@@ -0,0 +1,161 @@
+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';
+
+import { getTemplateSourceType, readDirWithFileTypes } from '../util';
+import { TEMPLATE_CREATOR } from './constants';
+
+export interface ITemplates {
+  name: string;
+  value: string;
+  platforms?: string | string[];
+  desc?: string;
+  compiler?: string[];
+}
+
+const TEMP_DOWNLOAD_FOLDER = 'taro-temp';
+
+export default function fetchTemplate(
+  templateSource: string,
+  templateRootPath: string,
+  clone?: boolean,
+): Promise<ITemplates[]> {
+  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);
+
+    const spinner = ora(`正在从 ${templateSource} 拉取远程模板...`).start();
+
+    if (type === 'git') {
+      name = path.basename(templateSource);
+      download(templateSource, path.join(tempPath, name), { clone }, async (error) => {
+        if (error) {
+          console.log(error);
+          spinner.color = 'red';
+          spinner.fail(chalk.red('拉取远程模板仓库失败！'));
+          await fs.remove(tempPath);
+          return resolve();
+        }
+        spinner.color = 'green';
+        spinner.succeed(`${chalk.grey('拉取远程模板仓库成功！')}`);
+        resolve();
+      });
+    } else if (type === 'url') {
+      // url 模板源，因为不知道来源名称，临时取名方便后续开发者从列表中选择
+      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;
+          });
+        })
+        .catch(async (error) => {
+          spinner.color = 'red';
+          spinner.fail(chalk.red(`拉取远程模板仓库失败！\n${error}`));
+          await fs.remove(tempPath);
+          return resolve();
+        });
+    }
+  }).then(async () => {
+    const templateFolder = name ? path.join(tempPath, name) : '';
+
+    // 下载失败，只显示默认模板
+    if (!fs.existsSync(templateFolder)) return Promise.resolve([]);
+
+    const isTemplateGroup = !(
+      fs.existsSync(path.join(templateFolder, 'package.json')) ||
+      fs.existsSync(path.join(templateFolder, 'package.json.tmpl'))
+    );
+
+    if (isTemplateGroup) {
+      // 模板组
+      const files = readDirWithFileTypes(templateFolder)
+        .filter((file) => !file.name.startsWith('.') && file.isDirectory && file.name !== '__MACOSX')
+        .map((file) => file.name);
+      await Promise.all(
+        files.map((file) => {
+          const src = path.join(templateFolder, file);
+          const dest = path.join(templateRootPath, file);
+          return fs.move(src, dest, { overwrite: true });
+        }),
+      );
+      await fs.remove(tempPath);
+
+      const res: ITemplates[] = files
+        .map((name) => {
+          const creatorFile = path.join(templateRootPath, name, TEMPLATE_CREATOR);
+
+          if (!fs.existsSync(creatorFile)) return { name, value: name };
+          const { name: displayName, platforms = '', desc = '', isPrivate = false, compiler } = require(creatorFile);
+          if (isPrivate) return null;
+
+          return {
+            name: displayName || name,
+            value: name,
+            platforms,
+            compiler,
+            desc,
+          };
+        })
+        .filter(Boolean) as ITemplates[];
+
+      return Promise.resolve(res);
+    } else {
+      // 单模板
+      await fs.move(templateFolder, path.join(templateRootPath, name), { overwrite: true });
+      await fs.remove(tempPath);
+
+      let res: ITemplates = { name, value: name, desc: type === 'url' ? templateSource : '' };
+
+      const creatorFile = path.join(templateRootPath, name, TEMPLATE_CREATOR);
+
+      if (fs.existsSync(creatorFile)) {
+        const { name: displayName, platforms = '', desc = '', compiler } = require(creatorFile);
+
+        res = {
+          name: displayName || name,
+          value: name,
+          platforms,
+          compiler,
+          desc: desc || templateSource,
+        };
+      }
+
+      return Promise.resolve([res]);
+    }
+  });
+}