@spcsn/taro-cli 0.1.0

package/src/presets/platforms/rn.ts

@@ -0,0 +1,125 @@
+import * as fs from 'node:fs';
+import * as os from 'node:os';
+import * as path from 'node:path';
+
+import { chalk } from '@spcsn/taro-helper';
+import * as child_process from 'child_process';
+
+import { printDevelopmentTip } from '../../util';
+
+import type { IPluginContext } from '@spcsn/taro-service';
+
+function checkReactNativeDependencies(packageInfo): boolean {
+  const packageNames = ['react', 'react-native', '@spcsn/taro-rn', '@spcsn/taro-rn-runner'];
+  const { dependencies, devDependencies } = packageInfo;
+  for (let i = 0; i < packageNames.length; i++) {
+    if (!dependencies[packageNames[i]] && !devDependencies[packageNames[i]]) {
+      return false;
+    }
+  }
+  return true;
+}
+
+function makeSureReactNativeInstalled(workspaceRoot: string): Promise<void> {
+  return new Promise<void>((resolve, reject) => {
+    const packageInfo = JSON.parse(
+      fs.readFileSync(path.join(workspaceRoot, 'package.json'), {
+        encoding: 'utf8',
+      }),
+    );
+
+    if (checkReactNativeDependencies(packageInfo)) {
+      resolve();
+    } else {
+      // 便于开发时切换版本
+      const devTag = process.env.DEVTAG || '';
+      console.log('Installing React-Native related packages:');
+      let packages = `react@^18.2.0 react-dom@^18.2.0 react-native@^0.73.1 @react-native/metro-config@^0.73.2 expo@~50.0.2 @tarojs/taro-rn${devTag} @tarojs/components-rn${devTag} @tarojs/rn-runner${devTag} @tarojs/rn-supporter${devTag} @tarojs/runtime-rn${devTag}`;
+      console.log(packages);
+      // windows下不加引号的话，package.json中添加的依赖不会自动带上^
+      packages = packages
+        .split(' ')
+        .map((str) => `"${str}"`)
+        .join(' ');
+      let installCmd = `npm install ${packages} --save`;
+      if (fs.existsSync(path.join(workspaceRoot, 'yarn.lock'))) {
+        installCmd = `yarn add ${packages} --force`;
+      }
+      if (fs.existsSync(path.join(workspaceRoot, 'pnpm-lock.yaml'))) {
+        installCmd = `pnpm add ${packages}`;
+      }
+      child_process.exec(installCmd, (error) => {
+        if (error) {
+          reject(error);
+          return;
+        }
+        console.log(chalk.green(`React-Native related packages have been installed successfully.${os.EOL}${os.EOL}`));
+        console.log(
+          `${chalk.yellow('ATTEHNTION')}: Package.json has been modified automatically, please submit it by yourself.${os.EOL}${os.EOL}`,
+        );
+        resolve();
+      });
+    }
+  });
+}
+
+export default (ctx: IPluginContext) => {
+  ctx.registerPlatform({
+    name: 'rn',
+    useConfigName: 'rn',
+    async fn({ config }) {
+      const { appPath, nodeModulesPath } = ctx.paths;
+      const { npm } = ctx.helper;
+      const {
+        deviceType = 'android',
+        port,
+        resetCache,
+        publicPath,
+        bundleOutput,
+        sourcemapOutput,
+        sourceMapUrl,
+        sourcemapSourcesRoot,
+        assetsDest,
+        qr,
+      } = ctx.runOpts.options;
+
+      printDevelopmentTip('rn');
+
+      // 准备 rnRunner 参数
+      const rnRunnerOpts = {
+        ...config,
+        nodeModulesPath,
+        deviceType,
+        port,
+        qr,
+        resetCache,
+        publicPath,
+        bundleOutput,
+        sourcemapOutput,
+        sourceMapUrl,
+        sourcemapSourcesRoot,
+        assetsDest,
+        buildAdapter: config.platform,
+      };
+
+      if (!rnRunnerOpts.entry) {
+        rnRunnerOpts.entry = 'app';
+      }
+
+      makeSureReactNativeInstalled(appPath).then(
+        async () => {
+          // build with metro
+          const rnRunner = await npm.getNpmPkg('@spcsn/taro-rn-runner', appPath);
+          await rnRunner(appPath, rnRunnerOpts);
+        },
+        (error) => {
+          console.log(chalk.red('Error when detecting React-Native packages:'));
+          console.log(error);
+          console.log(
+            `${chalk.greenBright('TIP')}: 1) Try to remove React-Native dependencies in package.json and shoot again; 2) Install the packages above manually.`,
+          );
+        },
+      );
+    },
+  });
+};

package/src/util/appConfig.ts

@@ -0,0 +1,32 @@
+import { IPluginContext } from '@spcsn/taro-service';
+import { isString } from '@spcsn/taro-shared';
+import { AppConfig } from '@spcsn/taro';
+
+/**
+ * 按需编译功能，只编译指定的页面或组件
+ * @param appConfig
+ * @param args
+ */
+export function extractCompileEntry(
+  appConfig: AppConfig,
+  args: { _: string[]; [key: string]: any },
+  ctx: IPluginContext,
+): void {
+  const { chalk } = ctx.helper;
+
+  const extractType = isString(args.pages) ? 'pages' : isString(args.components) ? 'components' : '';
+  if (!extractType) return;
+
+  const entries = args[extractType]
+    .split(',')
+    .map((item) => item.trim())
+    .filter(Boolean);
+  if (!entries.length) {
+    console.log(chalk.yellow(`按需编译开启失败，请指定要编译的${extractType}`));
+    return;
+  }
+
+  appConfig[extractType] = entries;
+  appConfig.subPackages = [];
+  console.log(chalk.green(`已开启按需编译，仅编译以下${extractType}: ${appConfig[extractType]}`));
+}

package/src/util/createPage.ts

@@ -0,0 +1,139 @@
+import { babelKit } from '@spcsn/taro-helper';
+
+import { ConfigModificationState, ModifyCallback } from '../create/page';
+
+import type { ArrayExpression, ExportDefaultDeclaration, ObjectExpression, ObjectProperty } from '@babel/types';
+import type { NodePath } from 'babel__traverse';
+
+const t = babelKit.types;
+
+const generateNewSubPackageItem = (subPackage: string) => {
+  const pageObject = t.objectProperty(t.identifier('pages'), t.arrayExpression([]));
+  const subPkgRootObject = t.objectProperty(t.identifier('root'), t.stringLiteral(subPackage));
+  const subPkgItemObject = t.objectExpression([subPkgRootObject, pageObject]);
+  return subPkgItemObject;
+};
+
+const isValidSubPkgObject = (subPkgObject: ObjectExpression) => {
+  const properties = subPkgObject?.properties || {};
+  const rootProperty = properties.find(
+    (property) => (property as ObjectProperty).key && ((property as ObjectProperty).key as any)?.name === 'root',
+  ) as ObjectProperty;
+  const pagesProperty = properties.find(
+    (property) => (property as ObjectProperty).key && ((property as ObjectProperty).key as any)?.name === 'pages',
+  ) as ObjectProperty;
+  const rootPropertyValueType = rootProperty?.value?.type;
+  const pagesPropertyValueType = pagesProperty?.value?.type;
+  return rootPropertyValueType === 'StringLiteral' && pagesPropertyValueType === 'ArrayExpression';
+};
+
+const addNewSubPackage = (node: ObjectExpression, page: string, subPackage: string): ConfigModificationState => {
+  let subPackages = node?.properties.find((node) => (node as any).key.name === 'subPackages') as ObjectProperty;
+  if (!subPackages) {
+    // config 文件不存在 subPackages 字段的情况，给该字段赋予默认值
+    const subPkgObject = t.objectProperty(t.identifier('subPackages'), t.arrayExpression([]));
+    subPackages = subPkgObject;
+    node?.properties.push(subPkgObject);
+  }
+  const value = subPackages?.value;
+
+  // 文件格式不对的情况
+  if (!value || value?.type !== 'ArrayExpression') return ConfigModificationState.Fail;
+  let targetSubPkgObject: ObjectExpression = value.elements.find((node) =>
+    (node as any)?.properties?.find((property) => (property as any)?.value?.value === subPackage),
+  ) as ObjectExpression;
+
+  if (!targetSubPkgObject) {
+    // 不存在 当前分包配置对象的情况
+    const subPkgItemObject = generateNewSubPackageItem(subPackage);
+    targetSubPkgObject = subPkgItemObject;
+    value.elements.push(subPkgItemObject);
+  }
+
+  if (targetSubPkgObject.type !== 'ObjectExpression' || !isValidSubPkgObject(targetSubPkgObject))
+    return ConfigModificationState.Fail;
+  const pagesProperty: ObjectProperty = targetSubPkgObject.properties.find(
+    (property) => (property as ObjectProperty).key && ((property as ObjectProperty).key as any)?.name === 'pages',
+  ) as ObjectProperty;
+  const currentPages = (pagesProperty.value as ArrayExpression).elements;
+  const isPageExists = Boolean(currentPages.find((node) => (node as any).value === page));
+
+  if (isPageExists) return ConfigModificationState.NeedLess;
+
+  currentPages.push(t.stringLiteral(page));
+  return ConfigModificationState.Success;
+};
+
+const addNewPage = (node: ObjectExpression, page: string): ConfigModificationState => {
+  const pages = node?.properties.find((node) => (node as any).key.name === 'pages') as ObjectProperty;
+  if (!pages) return ConfigModificationState.Fail;
+
+  const value = pages?.value;
+  // 仅处理 pages 为数组字面量的情形
+  if (!value || value?.type !== 'ArrayExpression') return ConfigModificationState.Fail;
+
+  const isPageExists = Boolean(value.elements.find((node) => (node as any).value === page));
+  if (isPageExists) return ConfigModificationState.NeedLess;
+
+  const newArrayElement = t.stringLiteral(page);
+  value.elements.push(newArrayElement);
+
+  return ConfigModificationState.Success;
+};
+
+const modifyPages = (path: NodePath<ExportDefaultDeclaration>, newPageConfig, callback: ModifyCallback) => {
+  let state = ConfigModificationState.Fail;
+  const node = path.node.declaration as any;
+  // Case 1. `export default defineAppConfig({})` 这种情况
+  if (node.type === 'CallExpression' && node.callee.name === 'defineAppConfig') {
+    const configNode = node.arguments[0];
+    state = addNewPage(configNode, newPageConfig.page);
+  }
+  // Case 2. `export default {}` 这种情况
+  if (node.type === 'ObjectExpression') {
+    state = addNewPage(node, newPageConfig.page);
+  }
+  callback(state);
+};
+
+const modifySubPackages = (path: NodePath<ExportDefaultDeclaration>, newPageConfig, callback: ModifyCallback) => {
+  let state = ConfigModificationState.Fail;
+  const node = path.node.declaration as any;
+  // `export default defineAppConfig({})` 这种情况
+  if (node.type === 'CallExpression' && node.callee.name === 'defineAppConfig') {
+    const configNode = node.arguments[0];
+    state = addNewSubPackage(configNode, newPageConfig.page, newPageConfig.pkg);
+  }
+  // `export default {}` 这种情况
+  if (node.type === 'ObjectExpression') {
+    state = addNewSubPackage(node, newPageConfig.page, newPageConfig.pkg);
+  }
+  callback(state);
+};
+
+const generateNewPageConfig = (fullPagePath: string, subPkgRootPath = '') => {
+  const newPageConfig = {
+    pkg: '',
+    page: '',
+  };
+  if (subPkgRootPath) {
+    const processedSubPkg = `${subPkgRootPath}/`;
+    newPageConfig.pkg = processedSubPkg;
+    newPageConfig.page = fullPagePath.split(processedSubPkg)[1];
+  } else {
+    newPageConfig.page = fullPagePath;
+  }
+
+  return newPageConfig;
+};
+
+export const modifyPagesOrSubPackages = (params: {
+  path: NodePath<ExportDefaultDeclaration>;
+  fullPagePath: string;
+  subPkgRootPath?: string;
+  callback: ModifyCallback;
+}) => {
+  const { fullPagePath, subPkgRootPath, callback, path } = params;
+  const newPageConfig = generateNewPageConfig(fullPagePath, subPkgRootPath);
+  subPkgRootPath ? modifySubPackages(path, newPageConfig, callback) : modifyPages(path, newPageConfig, callback);
+};

package/src/util/defineConfig.ts

@@ -0,0 +1,28 @@
+import type { IProjectConfig } from '@spcsn/taro/types/compile';
+import type { CompilerTypes, CompilerWebpackTypes } from '@spcsn/taro/types/compile/compiler';
+
+type WebpackMerge = (...configs: Array<object | null | undefined>) => object;
+
+export interface ConfigEnv {
+  /** taro 当前执行的命令 */
+  command: string;
+  /** 当前模式 (mode) */
+  mode: string;
+}
+
+export type UserConfigFn<T extends CompilerTypes = CompilerWebpackTypes> = (
+  merge: WebpackMerge,
+  env: ConfigEnv,
+) => IProjectConfig<T> | Promise<IProjectConfig<T>>;
+export type UserConfigExport<T extends CompilerTypes = CompilerWebpackTypes> =
+  | IProjectConfig<T>
+  | Promise<IProjectConfig<T>>
+  | UserConfigFn;
+
+/**
+ * @since v3.6.9
+ * @warning 暂不支持 react native
+ */
+export function defineConfig<T extends CompilerTypes = CompilerWebpackTypes>(config: UserConfigExport<T>) {
+  return config;
+}

package/src/util/index.ts

@@ -0,0 +1,126 @@
+import * as path from 'node:path';
+
+import { chalk, fs, isWindows } from '@spcsn/taro-helper';
+import { exec } from 'child_process';
+
+export function getRootPath(): string {
+  return path.resolve(__dirname, '../../');
+}
+
+export function getPkgVersion(): string {
+  return require(path.join(getRootPath(), 'package.json')).version;
+}
+
+export function getPkgItemByKey(key: string) {
+  const packageMap = require(path.join(getRootPath(), 'package.json'));
+  if (Object.keys(packageMap).indexOf(key) === -1) {
+    return {};
+  } else {
+    return packageMap[key];
+  }
+}
+
+export function printPkgVersion() {
+  const taroVersion = getPkgVersion();
+  console.log(`👽 Taro v${taroVersion}`);
+  console.log();
+}
+
+export const getAllFilesInFolder = async (folder: string, filter: string[] = []): Promise<string[]> => {
+  let files: string[] = [];
+  const list = readDirWithFileTypes(folder);
+
+  await Promise.all(
+    list.map(async (item) => {
+      const itemPath = path.join(folder, item.name);
+      if (item.isDirectory) {
+        const _files = await getAllFilesInFolder(itemPath, filter);
+        files = [...files, ..._files];
+      } else if (item.isFile) {
+        if (!filter.find((rule) => rule === item.name)) files.push(itemPath);
+      }
+    }),
+  );
+
+  return files;
+};
+
+export type TemplateSourceType = 'git' | 'url';
+
+export function getTemplateSourceType(url: string): TemplateSourceType {
+  if (/^github:/.test(url) || /^gitlab:/.test(url) || /^direct:/.test(url)) {
+    return 'git';
+  } else {
+    return 'url';
+  }
+}
+
+interface FileStat {
+  name: string;
+  isDirectory: boolean;
+  isFile: boolean;
+}
+
+export function readDirWithFileTypes(folder: string): FileStat[] {
+  const list = fs.readdirSync(folder);
+  const res = list.map((name) => {
+    const stat = fs.statSync(path.join(folder, name));
+    return {
+      name,
+      isDirectory: stat.isDirectory(),
+      isFile: stat.isFile(),
+    };
+  });
+  return res;
+}
+
+export function printDevelopmentTip(platform: string) {
+  if (process.env.NODE_ENV !== 'production' && process.env.NODE_ENV !== 'test') {
+    let exampleCommand;
+    if (isWindows) {
+      exampleCommand = `$ set NODE_ENV=production && taro build --type ${platform} --watch`;
+    } else {
+      exampleCommand = `$ NODE_ENV=production taro build --type ${platform} --watch`;
+    }
+    console.log(
+      chalk.yellowBright(`Tips: 预览模式生成的文件较大，设置 NODE_ENV 为 production 可以开启压缩。
+Example:
+${exampleCommand}
+`),
+    );
+  }
+}
+
+export function clearConsole() {
+  const readline = require('readline');
+  if (process.stdout.isTTY) {
+    const blank = '\n'.repeat(process.stdout.rows);
+    console.log(blank);
+    readline.cursorTo(process.stdout, 0, 0);
+    readline.clearScreenDown(process.stdout);
+  }
+}
+
+export function execCommand(params: {
+  command: string;
+  successCallback?: (data: string) => void;
+  failCallback?: (data: string) => void;
+}) {
+  const { command, successCallback, failCallback } = params;
+  const child = exec(command);
+  child.stdout!.on('data', function (data) {
+    successCallback?.(data);
+  });
+  child.stderr!.on('data', function (data) {
+    failCallback?.(data);
+  });
+}
+
+export function getPkgNameByFilterVersion(pkgString: string) {
+  const versionFlagIndex = pkgString.lastIndexOf('@');
+  return versionFlagIndex === 0 ? pkgString : pkgString.slice(0, versionFlagIndex);
+}
+
+export function isNil(value: any): value is null | undefined {
+  return value === null || value === undefined;
+}

package/src/util/types.ts

@@ -0,0 +1,81 @@
+export interface IInstallOptions {
+  dev: boolean;
+  peerDependencies?: boolean;
+}
+
+export interface INpmConfig {
+  dir: string;
+  name: string;
+}
+
+export interface IResolvedCache {
+  [key: string]: {
+    main: string;
+    files: string[];
+  };
+}
+
+export interface IPrettierConfig {
+  printWidth?: number;
+  tabWidth?: number;
+  useTabs?: boolean;
+  semi?: boolean;
+  singleQuote?: boolean;
+  jsxSingleQuote?: boolean;
+  trailingComma?: 'none' | 'es5' | 'all';
+  bracketSpacing?: boolean;
+  jsxBracketSameLine?: boolean;
+  arrowParens?: 'avoid' | 'always';
+  rangeStart?: number;
+  rangeEnd?: number;
+  parser?:
+    | 'babel'
+    | 'babylon'
+    | 'flow'
+    | 'typescript'
+    | 'css'
+    | 'scss'
+    | 'less'
+    | 'json'
+    | 'json5'
+    | 'json-stringify'
+    | 'graphql'
+    | 'markdown'
+    | 'mdx'
+    | 'html'
+    | 'vue'
+    | 'angular'
+    | 'yaml';
+  filepath?: string;
+  requirePragma?: boolean;
+  insertPragma?: boolean;
+  proseWrap?: 'always' | 'never' | 'preserve';
+  htmlWhitespaceSensitivity?: 'css' | 'strict' | 'ignore';
+  endOfLine?: 'auto' | 'lf' | 'crlf' | 'cr';
+}
+
+export interface IBuildOptions {
+  type?: string;
+  watch?: boolean;
+  platform?: string;
+  port?: number;
+  release?: boolean;
+  envHasBeenSet?: boolean;
+  page?: string;
+  component?: string;
+  uiIndex?: string;
+}
+
+export interface IMiniAppBuildConfig {
+  adapter: string;
+  watch?: boolean;
+  envHasBeenSet?: boolean;
+  port?: number;
+  release?: boolean;
+  page?: string;
+  component?: string;
+}
+
+export interface IOption {
+  [key: string]: any;
+}

package/templates/default/_editorconfig

@@ -0,0 +1,12 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

package/templates/default/_env.development

@@ -0,0 +1,2 @@
+# 配置文档参考 https://taro-docs.jd.com/docs/next/env-mode-config
+# TARO_APP_ID="开发环境下的小程序 AppID"

package/templates/default/_env.production

@@ -0,0 +1 @@
+# TARO_APP_ID="生产环境下的小程序 AppID"

package/templates/default/_env.test

@@ -0,0 +1 @@
+# TARO_APP_ID="测试环境下的小程序 AppID"

package/templates/default/_gitignore

@@ -0,0 +1,8 @@
+dist/
+deploy_versions/
+.temp/
+.rn_temp/
+node_modules/
+.DS_Store
+.swc
+*.local

package/templates/default/babel.config.js

@@ -0,0 +1,14 @@
+// babel-preset-taro 更多选项和默认值：
+// https://docs.taro.zone/docs/next/babel-config
+module.exports = {
+  presets: [
+    ['taro', {
+      framework: '{{ to_lower_case framework }}',
+      ts: {{ typescript }},
+      compiler: '{{ to_lower_case compiler }}',
+      {{#if buildEs5 }}
+      useBuiltIns: process.env.TARO_ENV === 'h5' ? 'usage' : false
+      {{/if}}
+    }]
+  ]
+}

package/templates/default/config/dev.js

@@ -0,0 +1,5 @@
+{{#if typescript }}import type { UserConfigExport } from "@spcsn/taro-cli"{{/if}}
+
+export default {
+  mini: {}
+}{{#if typescript }} satisfies UserConfigExport<'vite'>{{/if}}

package/templates/default/config/index.js

@@ -0,0 +1,61 @@
+import { defineConfig{{#if typescript }}, type UserConfigExport{{/if}} } from '@spcsn/taro-cli'
+import devConfig from './dev'
+import prodConfig from './prod'
+
+// https://taro-docs.jd.com/docs/next/config#defineconfig-辅助函数
+export default defineConfig{{#if typescript }}<'vite'>{{/if}}(async (merge, { command, mode }) => {
+  const baseConfig{{#if typescript }}: UserConfigExport<'vite'>{{/if}} = {
+    projectName: '{{ projectName }}',
+    date: '{{ date }}',
+    designWidth: 750,
+    deviceRatio: {
+      640: 2.34 / 2,
+      750: 1,
+      375: 2,
+      828: 1.81 / 2
+    },
+    sourceRoot: 'src',
+    outputRoot: 'dist',
+    plugins: [
+      "@spcsn/taro-plugin-generator"
+    ],
+    defineConstants: {
+    },
+    copy: {
+      patterns: [
+      ],
+      options: {
+      }
+    },
+    framework: 'react',
+    compiler: 'vite',
+    mini: {
+      postcss: {
+        pxtransform: {
+          enable: true,
+          config: {
+
+          }
+        },
+        cssModules: {
+          enable: false, // 默认为 false，如需使用 css modules 功能，则设为 true
+          config: {
+            namingPattern: 'module', // 转换模式，取值为 global/module
+            generateScopedName: '[name]__[local]___[hash:base64:5]'
+          }
+        }
+      }
+    }
+  }
+
+  {{#if buildEs5 }}
+  process.env.BROWSERSLIST_ENV = process.env.NODE_ENV
+  {{/if}}
+
+  if (process.env.NODE_ENV === 'development') {
+    // 本地开发构建配置（不混淆压缩）
+    return merge({}, baseConfig, devConfig)
+  }
+  // 生产构建配置（默认开启压缩混淆等）
+  return merge({}, baseConfig, prodConfig)
+})

package/templates/default/config/prod.js

@@ -0,0 +1,5 @@
+{{#if typescript }}import type { UserConfigExport } from "@spcsn/taro-cli"{{/if}}
+
+export default {
+  mini: {}
+}{{#if typescript }} satisfies UserConfigExport<'vite'>{{/if}}