paas-build-package 0.0.1

package/packages/cli/src/actions/gen-cdn-lib/gen-cdn-lib.ts

@@ -0,0 +1,149 @@
+import pacote from 'pacote';
+import path from 'path';
+import fse from 'fs-extra';
+import log from 'consola';
+import { Listr } from 'listr2';
+import { IGenCdnLibOptions } from '../../interface';
+
+/**
+ * 使用 pacote 从 npm 上下载制定包，至本地 cdn 项目目录，然后修改 import-map.json 文件，适配新包的版本号
+ *
+ * @export
+ * @class GenCdnLibAction
+ */
+export class GenCdnLibAction {
+  private packages: string[] = [
+    '@gct-paas/api',
+    '@gct-paas/core',
+    '@gct-paas/core-mobile',
+    '@gct-paas/core-pad',
+    '@gct-paas/core-web',
+    '@gct-paas/design',
+    '@gct-paas/design-mobile',
+    '@gct-paas/design-pad',
+    '@gct-paas/design-web',
+    '@gct-paas/native',
+    '@gct-paas/render',
+    '@gct-paas/render-mobile',
+    '@gct-paas/render-pad',
+    '@gct-paas/render-web',
+    '@gct-paas/schema',
+    '@gct-paas/v-ben',
+  ];
+
+  /**
+   * 下载指定包并复制到外部依赖目录，返回入口文件名；若找不到入口文件则返回空字符串
+   */
+  private async downloadPkg(
+    pkg: string,
+    pkgInfo: Awaited<ReturnType<typeof pacote.manifest>>,
+    opts: IGenCdnLibOptions,
+    extraDir: string,
+    extractCacheDir: string,
+    cacheDir: string,
+  ): Promise<string> {
+    const _dlCacheDir = path.join(extractCacheDir, pkgInfo.name, pkgInfo.version);
+    // 下载并解压包到指定目录
+    await pacote.extract(pkgInfo.dist.tarball, _dlCacheDir, {
+      registry: opts.registry,
+      cache: cacheDir,
+    });
+    // 从解压出的 package.json 读取完整字段（包含自定义 loader 字段）
+    const localPkgJson = fse.readJSONSync(path.join(_dlCacheDir, 'package.json'));
+    const loaderField = localPkgJson.loader as string | undefined;
+    if (!loaderField) return '';
+    // noFiles 模式：仅读取 loader 字段，不拷贝文件至目标目录
+    if (!opts.noFiles) {
+      const sourceDistPath = path.join(_dlCacheDir, 'dist');
+      if (opts.clean) {
+        const extractPkgPath = path.join(extraDir, pkgInfo.name);
+        if (fse.existsSync(extractPkgPath)) {
+          fse.removeSync(extractPkgPath);
+        }
+      }
+      const extractPath = path.join(extraDir, pkgInfo.name);
+      fse.copySync(sourceDistPath, extractPath, { overwrite: true });
+    }
+    return path.basename(loaderField);
+  }
+
+  async run(opts: IGenCdnLibOptions) {
+    const cwd = process.cwd();
+    // 外部依赖目录
+    const extraDir = opts.dir ? path.resolve(cwd, opts.dir) : cwd;
+    // 外部依赖目录名称
+    const extraDirName = path.basename(extraDir);
+    // 检查外部依赖目录是否存在，不存在则创建
+    if (!fse.existsSync(extraDir)) {
+      fse.mkdirSync(extraDir, { recursive: true });
+    }
+    // 缓存目录
+    const cacheDir = opts.cache
+      ? path.resolve(cwd, opts.cache)
+      : path.join(extraDir, '.cache');
+    // 下载包的缓存解压缓存目录
+    const extractCacheDir = path.join(cacheDir, 'tmp');
+    // import-map.json 文件路径
+    const importMapJsonPath = opts.jsonPath
+      ? path.resolve(cwd, opts.jsonPath)
+      : path.join(extraDir, 'import-map.json');
+    // 判断 importMapJsonPath 是否存在
+    if (!fse.existsSync(importMapJsonPath)) {
+      log.warn(
+        `import-map.json 文件不存在于 ${importMapJsonPath}，请确保路径正确或使用 --jsonPath 参数指定正确路径`,
+      );
+      return;
+    }
+    // import-map.json 文件内容
+    log.info('正在读取 import-map.json...');
+    const importMap = fse.readJSONSync(importMapJsonPath);
+
+    const tasks = new Listr(
+      this.packages.map((pkg) => ({
+        title: `${pkg}@${opts.tag}`,
+        task: async (_, task) => {
+          // 获取包的指定版本的 manifest 信息
+          task.title = `${pkg}@${opts.tag}  获取包信息...`;
+          const pkgInfo = await pacote.manifest(`${pkg}@${opts.tag}`, {
+            registry: opts.registry,
+            cache: cacheDir,
+          });
+
+          task.title = `${pkg}@${pkgInfo.version}  下载中...`;
+          const entryName = await this.downloadPkg(pkg, pkgInfo, opts, extraDir, extractCacheDir, cacheDir);
+
+          if (!entryName) {
+            task.skip('package.json 中没有 loader 字段，已跳过');
+            return;
+          }
+
+          // 修改 import-map.json，输出时使用相对路径，根从 extra 目录开始
+          importMap.imports[pkg] = `/${extraDirName}/${pkgInfo.name}/${entryName}`;
+          task.title = `${pkg}@${pkgInfo.version}`;
+        },
+      })),
+      { concurrent: true },
+    );
+
+    await tasks.run();
+
+    // 遍历所有 importMap.imports 给路径添加时间戳，每次编译后强制浏览器重新加载
+    const timestamp = Date.now();
+    for (const key in importMap.imports) {
+      // 如果有 t 参数，则替换为新的时间戳，否则添加 t 参数
+      if (importMap.imports[key].includes('?t=')) {
+        importMap.imports[key] = importMap.imports[key].replace(/\?t=\d+/, `?t=${timestamp}`);
+      } else {
+        importMap.imports[key] = `${importMap.imports[key]}?t=${timestamp}`;
+      }
+    }
+    // 写回 import-map.json 文件
+    fse.writeJSONSync(importMapJsonPath, importMap, { spaces: 2 });
+    // 删除缓存目录
+    if (opts.cleanCache && fse.existsSync(cacheDir)) {
+      log.info(`正在删除缓存目录: ${cacheDir}`);
+      fse.removeSync(cacheDir);
+    }
+    log.success('CDN 库文件生成成功！');
+  }
+}

package/packages/cli/src/actions/index.ts

@@ -0,0 +1,3 @@
+export { GenApiAction } from './gen-api/gen-api';
+export { GenCdnLibAction } from './gen-cdn-lib/gen-cdn-lib';
+export { InitGitAction } from './init-git/init-git';

package/packages/cli/src/actions/init-git/init-git.ts

@@ -0,0 +1,28 @@
+import { execSync } from 'child_process';
+import { consola } from 'consola';
+import simpleGit from 'simple-git';
+
+const GIT_CONFIGS: Record<string, string> = {
+  'merge.ours.driver': 'true',
+  'pull.ff': 'only',
+  'core.autocrlf': 'false',
+  'core.safecrlf': 'true',
+  'core.eol': 'lf',
+};
+
+export class InitGitAction {
+  async run(): Promise<void> {
+    consola.start('初始化 Husky...');
+    execSync('npx husky', { stdio: 'inherit' });
+
+    const git = simpleGit(process.cwd());
+    consola.start('配置 Git 本地设置...');
+
+    for (const [key, value] of Object.entries(GIT_CONFIGS)) {
+      await git.addConfig(key, value, false, 'local');
+      consola.info(`  git config --local ${key} "${value}"`);
+    }
+
+    consola.success('Git 配置初始化完成');
+  }
+}

package/packages/cli/src/bin.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { bootstrap } from './index';
+
+bootstrap();

package/packages/cli/src/commands/gen-api/gen-api.ts

@@ -0,0 +1,65 @@
+import { Command } from 'commander';
+import { ICommand } from '../../interface';
+import { GenApiAction } from '../../actions';
+
+export interface GenApiOptions {
+  /**
+   * 模板目录
+   *
+   * @author chitanda
+   * @date 2021-12-19 20:12:32
+   * @type {string}
+   */
+  template: string;
+  /**
+   * 模板输出目录
+   *
+   * @author chitanda
+   * @date 2021-12-19 20:12:37
+   * @type {string}
+   */
+  output: string;
+  /**
+   * 清理输出目录
+   *
+   * @author chitanda
+   * @date 2021-12-21 10:12:47
+   * @type {boolean}
+   */
+  clean: boolean;
+  /**
+   * swagger 地址
+   *
+   * @type {string}
+   */
+  url: string;
+  /**
+   * api标识
+   *
+   * @type {string}
+   */
+  tag: string;
+}
+
+export class GenApiCommand implements ICommand {
+  load(program: Command): void {
+    program
+      .command('gen-api')
+      .description('生成 api 文件')
+      .option('--url <base-url>', '指定api获取的swagger地址')
+      .option('-t --template <template>', '指定模板目录')
+      .option('-o --output <output>', '指定输出目录')
+      .option('--tag <tag>', '指定当前发布的分支')
+      .option('--clean', '清理输出目录')
+      .action(this.action.bind(this));
+  }
+  async action(args: GenApiOptions): Promise<void> {
+    await new GenApiAction().run(
+      args.url,
+      args.tag,
+      args.template,
+      args.output,
+      args.clean,
+    );
+  }
+}

package/packages/cli/src/commands/gen-cdn-lib/gen-cdn-lib.ts

@@ -0,0 +1,25 @@
+import { Command } from 'commander';
+import { ICommand, IGenCdnLibOptions } from '../../interface';
+import { GenCdnLibAction } from '../../actions';
+
+export class GenCdnLibCommand implements ICommand {
+  load(program: Command): void {
+    program
+      .command('gen-cdn-lib')
+      .description('生成 cdn 库文件')
+      .option('--tag <tag>', '指定下载的版本标签(latest | dev | beta | alpha)，默认为 latest', 'latest')
+      .option('--dir <dir>', '指定输出目录，未指定时默认为当前执行目录')
+      .option('--jsonPath <jsonPath>', '指定 import-map.json 文件路径，未制定默认使用指定的 dir 目录下的 import-map.json 文件')
+      .option('--clean', '是否清理输出目录后再生成')
+      .option('--registry <registry>', '指定 npm registry 地址，未指定时使用默认 registry')
+      .option('--cache <cache>', '指定 pacote 缓存目录，未指定时使用默认缓存目录')
+      .option('--cleanCache', '清理缓存目录，默认为 false', false)
+      .option('--noFiles', '是否只生成 import-map.json 文件而不下载包文件，默认为 false', false)
+      .action(this.action.bind(this));
+  }
+  async action(args: IGenCdnLibOptions): Promise<void> {
+    await new GenCdnLibAction().run(
+      args,
+    );
+  }
+}

package/packages/cli/src/commands/index.ts

@@ -0,0 +1,22 @@
+import { consola } from 'consola';
+import { Command } from 'commander';
+import { GenApiCommand } from './gen-api/gen-api';
+import { GenCdnLibCommand } from './gen-cdn-lib/gen-cdn-lib';
+import { InitGitCommand } from './init-git/init-git';
+
+export class CommandLoader {
+  public static load(program: Command): void {
+    new GenApiCommand().load(program);
+    new GenCdnLibCommand().load(program);
+    new InitGitCommand().load(program);
+    this.handleInvalidCommand(program);
+  }
+
+  private static handleInvalidCommand(program: Command) {
+    program.on('command:*', () => {
+      consola.error(`未支持的命令: `, program.args.join(' '));
+      consola.log(`请使用 --help 查看已支持的命令.\n`);
+      process.exit(1);
+    });
+  }
+}

package/packages/cli/src/commands/init-git/init-git.ts

@@ -0,0 +1,16 @@
+import { Command } from 'commander';
+import { ICommand } from '../../interface';
+import { InitGitAction } from '../../actions';
+
+export class InitGitCommand implements ICommand {
+  load(program: Command): void {
+    program
+      .command('init-git')
+      .description('初始化项目通用 Git 配置')
+      .action(this.action.bind(this));
+  }
+
+  async action(): Promise<void> {
+    await new InitGitAction().run();
+  }
+}

package/packages/cli/src/core/handlebars/constant/index.ts

@@ -0,0 +1,4 @@
+// 模板文件后缀
+export const TEMP_EXTENSION = '.hbs';
+// 宏模板文件夹
+export const MACRO_FOLDER = '@macro';

package/packages/cli/src/core/handlebars/handlebars-engine.ts

@@ -0,0 +1,143 @@
+import Handlebars from 'handlebars';
+import { installHelpers } from './helpers';
+import { HelperUtil, winToUnixPath } from './utils';
+import { IObject } from '../interface';
+import { TEMP_EXTENSION } from './constant';
+
+/**
+ * 生成器
+ *
+ * @export
+ * @class HandlebarsEngine
+ */
+export class HandlebarsEngine {
+  /**
+   * 编译参数
+   *
+   * @protected
+   * @type {CompileOptions}
+   */
+  protected compileOpt: CompileOptions = { compat: true, noEscape: true };
+
+  /**
+   * Handlebars 运行时参数
+   *
+   * @protected
+   * @type {Handlebars.RuntimeOptions}
+   */
+  protected runtimeOpt: Handlebars.RuntimeOptions = {
+    allowProtoPropertiesByDefault: true,
+  };
+
+  /**
+   * 忽略编译的上下文标签规则
+   *
+   * @protected
+   */
+  protected tagReg = /^[a-zA-Z0-9:_-]+$/;
+
+  /**
+   * 模板映射内容
+   *
+   * @type {Map<string, string>} Map<模板路径, 模板内容>
+   */
+  readonly temps: Map<string, string> = new Map<string, string>();
+
+  constructor() {
+    installHelpers();
+  }
+
+  /**
+   * 注册宏
+   *
+   * @param {string} key 宏标识
+   * @param {string} template 宏模板内容
+   */
+  registerMacro(key: string, template: string): void {
+    key = winToUnixPath(key);
+    if (key.endsWith(TEMP_EXTENSION)) {
+      key = key.replace(TEMP_EXTENSION, '');
+      Handlebars.registerPartial(key, template);
+    } else {
+      Handlebars.registerPartial(key, template);
+    }
+  }
+
+  /**
+   * 注册模板
+   *
+   * @param {string} key
+   * @param {string} template
+   */
+  registerTemp(key: string, template: string): void {
+    key = winToUnixPath(key);
+    if (key.endsWith(TEMP_EXTENSION)) {
+      key = key.replace(TEMP_EXTENSION, '');
+      this.temps.set(key, template);
+    } else {
+      this.temps.set(key, template);
+    }
+  }
+
+  /**
+   * 编译模板获取所有使用到的上下文级参数标识
+   *
+   * @param {string} template
+   * @return {*}  {string[]}
+   */
+  parseContextTags(template: string): string[] {
+    const program = Handlebars.parse(template);
+    const set = new Set<string>();
+    this.calcTemplateTags(set, program.body);
+    return Array.from(set);
+  }
+
+  /**
+   * 计算编译模板中的参数标签
+   *
+   * @protected
+   * @param {Set<string>} set
+   * @param {Record<string, any>[]} tags
+   */
+  protected calcTemplateTags(
+    set: Set<string>,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    tags: Record<string, any>[],
+  ): void {
+    tags.forEach(item => {
+      switch (item.type) {
+        case 'SubExpression':
+          if (item.params?.length > 0) {
+            this.calcTemplateTags(set, item.params);
+          }
+          return;
+        case 'MustacheStatement':
+        case 'PathExpression': {
+          const tag = item.path ? item.path.original : item.original;
+          if (HelperUtil.isHelperName(tag)) {
+            if (item.params?.length > 0) {
+              this.calcTemplateTags(set, item.params);
+            }
+            return;
+          }
+          if (this.tagReg.test(tag)) {
+            set.add(tag);
+          }
+          break;
+        }
+        default:
+      }
+    });
+  }
+
+  /**
+   * 直接工具模板和数据编译
+   *
+   * @param {string} template
+   * @param {IObject} data
+   * @return {*}  {string}
+   */
+  render(template: string, data: IObject): string {
+    return Handlebars.compile(template, this.compileOpt)(data, this.runtimeOpt);
+  }
+}

package/packages/cli/src/core/handlebars/helpers/and/and.ts

@@ -0,0 +1,24 @@
+import { HelperUtil } from '../../utils';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 并且条件模式
+ *
+ * @description 判断: word wor2 word3 必须在判断中必须全部为 true, 用法: {{#and word word2 word3}}xxx{{else}}yyy{{/and}}、{{and word word2 word3}} 返回值为 boolean 类型
+ * @export
+ * @class HelperAnd
+ * @extends {HelperBase}
+ */
+export class HelperAnd extends HelperBase {
+  constructor() {
+    super('and');
+  }
+
+  onExecute(...args: unknown[] | Handlebars.HelperOptions[]): string | boolean {
+    const options = args[args.length - 1] as Handlebars.HelperOptions;
+    args.pop();
+    const arr = (args as unknown[]).filter(item => !!item);
+    const bol = arr.length === args.length;
+    return HelperUtil.handleJudgmentExecute(this, bol, options);
+  }
+}

package/packages/cli/src/core/handlebars/helpers/camel-case/camel-case.ts

@@ -0,0 +1,23 @@
+import { camelCase } from 'lodash-es';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 转驼峰
+ *
+ * @description 用法 {{camelCase xxx}}，效果: this-is-my-name => thisIsMyName
+ * @export
+ * @class HelperCamelCase
+ * @extends {HelperBase}
+ */
+export class HelperCamelCase extends HelperBase {
+  constructor() {
+    super('camelCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return camelCase(param);
+  }
+}

package/packages/cli/src/core/handlebars/helpers/concat/concat.ts

@@ -0,0 +1,20 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 字符串拼接
+ *
+ * @description 用法：{{concat string1 string2 string3}} 返回值为 string 类型
+ * @export
+ * @class HelperConcat
+ * @extends {HelperBase}
+ */
+export class HelperConcat extends HelperBase {
+  constructor() {
+    super('concat');
+  }
+
+  onExecute(...args: string[]): string {
+    args.pop();
+    return args.join('');
+  }
+}

package/packages/cli/src/core/handlebars/helpers/eq/eq.ts

@@ -0,0 +1,27 @@
+import * as Handlebars from 'handlebars';
+import { eq } from 'lodash-es';
+import { HelperUtil } from '../../utils';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 等于
+ *
+ * @description 判断: word === word2, 用法: {{#eq word word2}}xxx{{else}}yyy{{/eq}}、{{eq word 'xxx'}} 返回值为 boolean 类型
+ * @export
+ * @class HelperEq
+ * @extends {HelperBase}
+ */
+export class HelperEq extends HelperBase {
+  constructor() {
+    super('eq');
+  }
+
+  onExecute(
+    param: unknown,
+    param2: unknown,
+    options: Handlebars.HelperOptions,
+  ): string | boolean {
+    const bol = eq(param, param2);
+    return HelperUtil.handleJudgmentExecute(this, bol, options);
+  }
+}

package/packages/cli/src/core/handlebars/helpers/format-import/format-import.ts

@@ -0,0 +1,46 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 格式化导入
+ *
+ * @description 专门格式化导入的 response 对象，效果: ResponseEntity«List«TraceSettingResponse»» => TraceSettingResponse
+ * @export
+ * @class HelperFormatImport
+ * @extends {HelperBase}
+ */
+export class HelperFormatImport extends HelperBase {
+  constructor() {
+    super('formatImport');
+  }
+
+  onExecute(param: string[]): string {
+    if (!param || param.length === 0) {
+      return '';
+    }
+    const items = param
+      .map(item => {
+        if (item.indexOf('«') > -1) {
+          const arr = item.split('«');
+          return arr[arr.length - 1].split('»')[0];
+        }
+        return item;
+      })
+      .filter(item => {
+        const keys = item.split(',');
+        const tag = keys[0];
+        switch (tag) {
+          case 'string':
+          case 'object':
+          case 'void':
+          case 'integer':
+          case 'int':
+          case 'long':
+          case 'Map':
+            return false;
+          default:
+            return true;
+        }
+      });
+    return Array.from(new Set(items)).join(',');
+  }
+}

package/packages/cli/src/core/handlebars/helpers/format-import-item/format-import-item.ts

@@ -0,0 +1,67 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 格式化导入
+ *
+ * @description 专门格式化导入的 response 对象，效果: ResponseEntity«List«TraceSettingResponse»» => TraceSettingResponse
+ * @export
+ * @class HelperFormatImportItem
+ * @extends {HelperBase}
+ */
+export class HelperFormatImportItem extends HelperBase {
+  constructor() {
+    super('formatImportItem');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    if (param.indexOf('«') > -1) {
+      // 先截出泛型区
+      const start = param.indexOf('«');
+      const end = param.indexOf('»');
+      param = param.substring(start + 1, end);
+      // 再根据泛型区
+      param = param.replace(/«/g, '___');
+      param = param.replace(/»/g, '___');
+      const arr = param.split('___');
+      const isType = arr.length > 1;
+      const type = isType ? arr[0] : '';
+      const text = isType ? arr[1] : arr[0];
+      let keys = text.split(',');
+      if (keys.length > 1) {
+        return 'IObject';
+      }
+      keys = keys.map(key => {
+        if (key === 'Void') {
+          return 'void';
+        }
+        if (key === 'int' || key === 'long') {
+          return 'number';
+        }
+        if (key === 'Map') {
+          return 'IObject';
+        }
+        return key;
+      });
+      const val = keys.join(',');
+      if (isType) {
+        if (type === 'List') {
+          if (val === 'Tree') {
+            return 'IObject[]';
+          }
+          return val + '[]';
+        }
+        if (type === 'PageBase') {
+          return `IPage<${val}>`;
+        }
+        if (type === 'Tree') {
+          return 'IObject';
+        }
+      }
+      return val;
+    }
+    return param;
+  }
+}