@spcsn/taro-cli 0.1.6 → 1.0.1

package/src/create/page.ts

@@ -1,325 +0,0 @@
-import * as path from 'node:path';
-
-import {
-  CompilerType,
-  createPage as createPageBinding,
-  CSSType,
-  FrameworkType,
-  NpmType,
-  PeriodType,
-} from '@spcsn/taro-binding';
-import {
-  babelKit,
-  chalk,
-  DEFAULT_TEMPLATE_SRC,
-  fs,
-  getUserHomeDir,
-  resolveScriptPath,
-  TARO_BASE_CONFIG,
-  TARO_CONFIG_FOLDER,
-} from '@spcsn/taro-helper';
-
-import { getPkgVersion, getRootPath, isNil } from '../util';
-import { modifyPagesOrSubPackages } from '../util/createPage';
-import { TEMPLATE_CREATOR } from './constants';
-import Creator from './creator';
-import fetchTemplate from './fetchTemplate';
-
-export interface IPageConf {
-  projectDir: string;
-  projectName: string;
-  npm: NpmType;
-  template: string;
-  clone?: boolean;
-  templateSource?: string;
-  description?: string;
-  pageName: string;
-  date?: string;
-  framework: FrameworkType;
-  css: CSSType;
-  typescript?: boolean;
-  compiler?: CompilerType;
-  isCustomTemplate?: boolean;
-  customTemplatePath?: string;
-  pageDir?: string;
-  subPkg?: string;
-}
-interface IPageArgs extends IPageConf {
-  modifyCustomTemplateConfig: TGetCustomTemplate;
-  afterCreate?: TAfterCreate;
-}
-interface ITemplateInfo {
-  css: CSSType;
-  typescript?: boolean;
-  compiler?: CompilerType;
-  template?: string;
-  templateSource?: string;
-  clone?: boolean;
-}
-
-type TCustomTemplateInfo = Omit<
-  ITemplateInfo & {
-    isCustomTemplate?: boolean;
-    customTemplatePath?: string;
-  },
-  'template'
->;
-
-export type TSetCustomTemplateConfig = (customTemplateConfig: TCustomTemplateInfo) => void;
-
-type TGetCustomTemplate = (cb: TSetCustomTemplateConfig) => Promise<void>;
-type TAfterCreate = (state: boolean) => void;
-
-const DEFAULT_TEMPLATE_INFO = {
-  name: 'default',
-  css: CSSType.None,
-  typescript: false,
-  compiler: CompilerType.Vite,
-  framework: FrameworkType.React,
-};
-
-export enum ConfigModificationState {
-  Success,
-  Fail,
-  NeedLess,
-}
-
-export type ModifyCallback = (state: ConfigModificationState) => void;
-
-export default class Page extends Creator {
-  public rootPath: string;
-  public conf: IPageConf;
-  private modifyCustomTemplateConfig: TGetCustomTemplate;
-  private afterCreate: TAfterCreate | undefined;
-  private pageEntryPath!: string;
-
-  constructor(args: IPageArgs) {
-    super();
-    this.rootPath = this._rootPath;
-    const { modifyCustomTemplateConfig, afterCreate, ...otherOptions } = args;
-    this.conf = Object.assign(
-      {
-        projectDir: '',
-        projectName: '',
-        template: '',
-        description: '',
-        pageDir: '',
-      },
-      otherOptions,
-    );
-
-    this.conf.projectName = path.basename(this.conf.projectDir);
-    this.modifyCustomTemplateConfig = modifyCustomTemplateConfig;
-    this.afterCreate = afterCreate;
-    this.processPageName();
-  }
-
-  processPageName() {
-    const { pageName } = this.conf;
-    // todo 目前还没有对 subPkg 和 pageName 这两个字段做 格式验证或者处理
-    const lastDirSplitSymbolIndex = pageName.lastIndexOf('/');
-    if (lastDirSplitSymbolIndex !== -1) {
-      this.conf.pageDir = pageName.substring(0, lastDirSplitSymbolIndex);
-      this.conf.pageName = pageName.substring(lastDirSplitSymbolIndex + 1);
-    }
-  }
-
-  getPkgPath() {
-    const projectDir = this.conf.projectDir as string;
-    let pkgPath = path.join(projectDir, 'package.json');
-    if (!fs.existsSync(pkgPath)) {
-      // 适配 云开发 项目
-      pkgPath = path.join(projectDir, 'client', 'package.json');
-      if (!fs.existsSync(pkgPath)) {
-        console.log(chalk.yellow('请在项目根目录下执行 taro create 命令!'));
-        process.exit(0);
-      }
-    }
-    return pkgPath;
-  }
-
-  getPkgTemplateInfo() {
-    const pkg = fs.readJSONSync(this.getPkgPath());
-    const templateInfo = pkg.templateInfo || DEFAULT_TEMPLATE_INFO;
-    // set template name
-    templateInfo.template = templateInfo.name;
-    delete templateInfo.name;
-    return templateInfo;
-  }
-
-  setPageEntryPath(files: string[], handler) {
-    const configFileName = files.find((filename) => /\.config\.(js|ts)$/.test(filename));
-    if (!configFileName) return;
-    const getPageFn = handler[configFileName];
-    const { setPageName = '', setSubPkgName = '' } = getPageFn?.(() => {}, this.conf) || {};
-    if (this.conf.subPkg) {
-      this.pageEntryPath = setSubPkgName.replace(/\.config\.(js|ts)$/, '');
-    } else {
-      this.pageEntryPath = setPageName.replace(/\.config\.(js|ts)$/, '');
-    }
-  }
-
-  setCustomTemplateConfig(customTemplateConfig: TCustomTemplateInfo) {
-    const pkgTemplateInfo = this.getPkgTemplateInfo();
-    const { compiler, css, customTemplatePath, typescript } = customTemplateConfig;
-    const conf = {
-      compiler: compiler || pkgTemplateInfo.compiler,
-      css: css || pkgTemplateInfo.css,
-      typescript: !isNil(typescript) ? typescript : pkgTemplateInfo.typescript,
-      customTemplatePath,
-      isCustomTemplate: true,
-    };
-    this.setTemplateConfig(conf);
-  }
-
-  setTemplateConfig(templateInfo: ITemplateInfo) {
-    this.conf = Object.assign(this.conf, templateInfo);
-  }
-
-  async fetchTemplates() {
-    const homedir = getUserHomeDir();
-    let templateSource = DEFAULT_TEMPLATE_SRC;
-    if (!homedir) chalk.yellow('找不到用户根目录，使用默认模版源！');
-
-    if (this.conf.templateSource) {
-      templateSource = this.conf.templateSource;
-    } else {
-      const taroConfigPath = path.join(homedir, TARO_CONFIG_FOLDER);
-      const taroConfig = path.join(taroConfigPath, TARO_BASE_CONFIG);
-      if (fs.existsSync(taroConfig)) {
-        const config = await fs.readJSON(taroConfig);
-        templateSource = config && config.templateSource ? config.templateSource : DEFAULT_TEMPLATE_SRC;
-      } else {
-        await fs.createFile(taroConfig);
-        await fs.writeJSON(taroConfig, { templateSource });
-        templateSource = DEFAULT_TEMPLATE_SRC;
-      }
-    }
-
-    // 从模板源下载模板
-    await fetchTemplate(templateSource, this.templatePath(''), this.conf.clone);
-  }
-
-  async create() {
-    const date = new Date();
-    this.conf.date = `${date.getFullYear()}-${date.getMonth() + 1}-${date.getDate()}`;
-    // apply 插件，由插件设置自定义模版 config
-    await this.modifyCustomTemplateConfig(this.setCustomTemplateConfig.bind(this));
-    if (!this.conf.isCustomTemplate) {
-      const pkgTemplateInfo = this.getPkgTemplateInfo();
-      this.setTemplateConfig(pkgTemplateInfo);
-      if (!fs.existsSync(this.templatePath(this.conf.template))) {
-        await this.fetchTemplates();
-      }
-    }
-    this.write();
-  }
-
-  updateAppConfig() {
-    const { parse, generate, traverse } = babelKit;
-
-    let modifyState: ConfigModificationState = ConfigModificationState.Fail;
-    const { subPkg, projectDir, typescript } = this.conf;
-    const [sourceString, pageString] = this.pageEntryPath.split('/src/');
-    const appConfigPath = resolveScriptPath(path.join(projectDir, sourceString, 'src', 'app.config'));
-    if (!fs.existsSync(appConfigPath)) {
-      return console.log(
-        `${chalk.red('x ')}${chalk.grey(`无法获取 ${appConfigPath} 配置文件，请手动到配置文件中补全新页面信息`)}`,
-      );
-    }
-    const configFileContent = fs.readFileSync(appConfigPath, 'utf-8');
-    const ast = parse(configFileContent, {
-      sourceType: 'module',
-      plugins: typescript ? ['typescript'] : [],
-    });
-
-    const callback = (state: ConfigModificationState) => {
-      modifyState = state;
-    };
-
-    traverse(ast as any, {
-      ExportDefaultDeclaration(path) {
-        modifyPagesOrSubPackages({
-          path: path as any,
-          fullPagePath: pageString,
-          subPkgRootPath: subPkg,
-          callback,
-        });
-      },
-    });
-
-    switch (modifyState as ConfigModificationState) {
-      case ConfigModificationState.Fail:
-        console.log(
-          `${chalk.red('x ')}${chalk.grey(`自动补全新页面信息失败， 请手动到 ${appConfigPath} 文件中补全新页面信息`)}`,
-        );
-        break;
-      case ConfigModificationState.Success: {
-        const newCode = generate(ast as any, { retainLines: true });
-        fs.writeFileSync(appConfigPath, newCode.code);
-        console.log(`${chalk.green('✔ ')}${chalk.grey(`新页面信息已在 ${appConfigPath} 文件中自动补全`)}`);
-        break;
-      }
-      case ConfigModificationState.NeedLess:
-        console.log(`${chalk.green('✔ ')}${chalk.grey(`新页面信息已存在在 ${appConfigPath} 文件中，不需要补全`)}`);
-        break;
-    }
-  }
-
-  write() {
-    const { projectName, projectDir, template, pageName, isCustomTemplate, customTemplatePath, subPkg, pageDir } = this
-      .conf as IPageConf;
-    let templatePath;
-
-    if (isCustomTemplate) {
-      templatePath = customTemplatePath;
-    } else {
-      templatePath = this.templatePath(template);
-    }
-
-    if (!fs.existsSync(templatePath)) return console.log(chalk.red(`创建页面错误：找不到模板${templatePath}`));
-
-    // 引入模板编写者的自定义逻辑
-    const handlerPath = path.join(templatePath, TEMPLATE_CREATOR);
-    const basePageFiles = fs.existsSync(handlerPath) ? require(handlerPath).basePageFiles : [];
-    const files = Array.isArray(basePageFiles) ? basePageFiles : [];
-    const handler = fs.existsSync(handlerPath) ? require(handlerPath).handler : {};
-
-    this.setPageEntryPath(files, handler);
-
-    createPageBinding(
-      {
-        pageDir,
-        subPkg,
-        projectDir,
-        projectName,
-        template,
-        framework: this.conf.framework,
-        css: this.conf.css || CSSType.None,
-        typescript: this.conf.typescript,
-        compiler: this.conf.compiler,
-        templateRoot: getRootPath(),
-        version: getPkgVersion(),
-        date: this.conf.date,
-        description: this.conf.description,
-        pageName,
-        isCustomTemplate,
-        customTemplatePath,
-        basePageFiles: files,
-        period: PeriodType.CreatePage,
-      },
-      handler,
-    )
-      .then(() => {
-        console.log(`${chalk.green('✔ ')}${chalk.grey(`创建页面 ${this.conf.pageName} 成功！`)}`);
-        this.updateAppConfig();
-        this.afterCreate && this.afterCreate(true);
-      })
-      .catch((err) => {
-        console.log(err);
-        this.afterCreate && this.afterCreate(false);
-      });
-  }
-}
-
-export type { Page as PageCreator };

package/src/create/plugin.ts

@@ -1,55 +0,0 @@
-import * as path from 'node:path';
-
-import { createPlugin } from '@spcsn/taro-binding';
-import { chalk, fs } from '@spcsn/taro-helper';
-
-import { getRootPath } from '../util';
-import Creator from './creator';
-
-export interface IPluginConf {
-  pluginName: string;
-  type: string;
-  description?: string;
-  projectDir: string;
-  projectName: string;
-  template: string;
-  version: string;
-}
-
-export default class Plugin extends Creator {
-  public conf: IPluginConf;
-
-  constructor(options: IPluginConf) {
-    super();
-    this.conf = {
-      ...options,
-      projectName: path.basename(options.projectDir),
-      version: this.getCliVersion(),
-    };
-  }
-
-  getCliVersion() {
-    const pkgPath = path.join(this._rootPath, 'package.json');
-    const pkg = fs.readJSONSync(pkgPath);
-    return pkg.version;
-  }
-
-  async create() {
-    const { projectDir, template, pluginName } = this.conf;
-    const templatePath = this.templatePath(template);
-
-    if (!fs.existsSync(templatePath)) {
-      console.log(chalk.red(`创建插件失败：找不到模板${templatePath}`));
-      return;
-    }
-    createPlugin({
-      projectRoot: projectDir,
-      projectName: pluginName,
-      templateRoot: getRootPath(),
-      template,
-      version: this.conf.version,
-      description: this.conf.description,
-      pluginType: this.conf.type,
-    });
-  }
-}

package/src/presets/commands/config.ts

@@ -1,86 +0,0 @@
-import * as path from 'node:path';
-
-import type { IPluginContext } from '@spcsn/taro-service';
-
-export default (ctx: IPluginContext) => {
-  ctx.registerCommand({
-    name: 'config',
-    optionsMap: {
-      '--json': '以 JSON 形式输出',
-    },
-    synopsisList: [
-      'taro config set <key> <value>',
-      'taro config get <key>',
-      'taro config delete <key>',
-      'taro config list [--json]',
-    ],
-    fn({ _, options }) {
-      const [, cmd, key, value] = _;
-      const json = !!options.json;
-      const { fs, getUserHomeDir, TARO_CONFIG_FOLDER, TARO_BASE_CONFIG } = ctx.helper;
-      const homedir = getUserHomeDir();
-      const configPath = path.join(homedir, `${TARO_CONFIG_FOLDER}/${TARO_BASE_CONFIG}`);
-      if (!homedir) return console.log('找不到用户根目录');
-
-      function displayConfigPath(configPath) {
-        console.log(`Config path: ${configPath}`);
-        console.log();
-      }
-
-      switch (cmd) {
-        case 'get':
-          if (!key) return console.log('Usage: taro config get <key>');
-          if (fs.existsSync(configPath)) {
-            displayConfigPath(configPath);
-            const config = fs.readJSONSync(configPath);
-            console.log(`key: ${key}, value: ${config[key]}`);
-          }
-          break;
-        case 'set':
-          if (!key || !value) return console.log('Usage: taro config set <key> <value>');
-
-          if (fs.existsSync(configPath)) {
-            displayConfigPath(configPath);
-            const config = fs.readJSONSync(configPath);
-            config[key] = value;
-            fs.writeJSONSync(configPath, config);
-          } else {
-            fs.ensureFileSync(configPath);
-            fs.writeJSONSync(configPath, {
-              [key]: value,
-            });
-          }
-          console.log(`set key: ${key}, value: ${value}`);
-          break;
-        case 'delete':
-          if (!key) return console.log('Usage: taro config delete <key>');
-
-          if (fs.existsSync(configPath)) {
-            displayConfigPath(configPath);
-            const config = fs.readJSONSync(configPath);
-            delete config[key];
-            fs.writeJSONSync(configPath, config);
-          }
-          console.log(`deleted: ${key}`);
-          break;
-        case 'list':
-        case 'ls':
-          if (fs.existsSync(configPath)) {
-            displayConfigPath(configPath);
-            console.log('Config info:');
-            const config = fs.readJSONSync(configPath);
-            if (json) {
-              console.log(JSON.stringify(config, null, 2));
-            } else {
-              for (const key in config) {
-                console.log(`${key}=${config[key]}`);
-              }
-            }
-          }
-          break;
-        default:
-          break;
-      }
-    },
-  });
-};

package/src/presets/commands/create.ts

@@ -1,104 +0,0 @@
-import * as hooks from '../constant';
-
-import type { IPluginContext } from '@spcsn/taro-service';
-import type { TSetCustomTemplateConfig } from '../../create/page';
-
-declare const enum createTemplateTypeEnum {
-  /**
-   * taro页面，taro使用者使用
-   */
-  PAGE = 'page',
-  /**
-   * taro插件，用于扩展命令行
-   */
-  PLUGIN_COMMAND = 'plugin-command',
-  /**
-   * taro插件，用于扩展编译过程
-   */
-  PLUGIN_BUILD = 'plugin-build',
-  /**
-   * taro插件，用于扩展 taro create 自定义模版
-   */
-  PLUGIN_TEMPLATE = 'plugin-template',
-}
-
-export default (ctx: IPluginContext) => {
-  ctx.registerCommand({
-    name: 'create',
-    optionsMap: {
-      '--name [name]': '名称',
-      '--dir [dir]': '路径',
-      '--subpkg [subpkg]': '分包路径',
-      '--description [description]': '介绍',
-      '--type [type]': '模版类型(page(默认)|plugin-command|plugin-build|plugin-template)',
-    },
-    synopsisList: [
-      'taro create page',
-      'taro create --name=page --description=desc',
-      'taro create my-plugin --type=plugin-command',
-    ],
-    fn({ _, options }) {
-      const type = options.type || createTemplateTypeEnum.PAGE;
-      const name = _[1] || options.name;
-      const description = options.description || '';
-      const afterCreate = options.afterCreate;
-      const templateSource = options.templateSource;
-      const framework = options.framework;
-      const css = options.css;
-      const typescript = options.typescript;
-      const clone = options.clone;
-      const { chalk } = ctx.helper;
-      const { appPath } = ctx.paths;
-
-      switch (type) {
-        case createTemplateTypeEnum.PAGE: {
-          if (typeof name !== 'string') {
-            return console.log(chalk.red('请输入需要创建的页面名称'));
-          }
-
-          const Page = require('../../create/page').default;
-          const page = new Page({
-            clone,
-            subPkg: options.subpkg,
-            framework,
-            css,
-            typescript,
-            pageDir: options.dir,
-            pageName: name,
-            projectDir: appPath,
-            description,
-            templateSource,
-            afterCreate,
-            async modifyCustomTemplateConfig(cb: TSetCustomTemplateConfig) {
-              await ctx.applyPlugins({ name: hooks.MODIFY_CREATE_TEMPLATE, opts: cb });
-            },
-          });
-
-          page.create();
-          break;
-        }
-        case createTemplateTypeEnum.PLUGIN_COMMAND:
-        case createTemplateTypeEnum.PLUGIN_BUILD:
-        case createTemplateTypeEnum.PLUGIN_TEMPLATE: {
-          if (typeof name !== 'string') {
-            return console.log(chalk.red('请输入需要创建的插件名称'));
-          }
-
-          const Plugin = require('../../create/plugin').default;
-          const plugin = new Plugin({
-            pluginName: name,
-            projectDir: appPath,
-            type,
-            description,
-            template: 'plugin-compile',
-          });
-
-          plugin.create();
-          break;
-        }
-        default:
-          break;
-      }
-    },
-  });
-};

package/src/presets/commands/doctor.ts

@@ -1,21 +0,0 @@
-import {
-  validateConfig,
-  validateEnv,
-  validateEslint,
-  validatePackage,
-  validateRecommend,
-} from '../../doctor/validators';
-
-import type { IPluginContext } from '@spcsn/taro-service';
-
-export default (ctx: IPluginContext) => {
-  ctx.registerCommand({
-    name: 'doctor',
-    optionsMap: {},
-    synopsisList: ['taro doctor'],
-    async fn() {
-      await Promise.all([validateEnv(), validateConfig(), validatePackage(), validateRecommend(), validateEslint()]);
-      console.log(ctx.helper.chalk.green('基础环境检查通过。'));
-    },
-  });
-};