paas-build-package 0.0.1

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

@@ -0,0 +1,50 @@
+import { IObject } from '../../../interface';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 格式化导入
+ *
+ * @description 针对后台的 swagger 生成的 js 类型，进行对 js 的类型转换
+ * @export
+ * @class HelperFormatJsType
+ * @extends {HelperBase}
+ */
+export class HelperFormatJsType extends HelperBase {
+  constructor() {
+    super('formatJsType');
+  }
+
+  onExecute(config: IObject): string {
+    if (!config) {
+      return 'unknown';
+    }
+    const { type, items: cfg, originalRef } = config;
+    const fieldType = type || originalRef;
+    if (!fieldType) {
+      return 'unknown';
+    }
+    if (fieldType === 'array') {
+      if (cfg) {
+        let type: string = cfg.type || cfg.originalRef;
+        if (type) {
+          if (type === 'integer') {
+            type = 'number';
+          } else if (type.startsWith('Triple«')) {
+            type = type.replace('Triple«', 'ITripleObject<').replace('»', '>');
+          }
+        } else {
+          type = 'unknown';
+        }
+        return type + '[]';
+      }
+      return 'unknown[]';
+    }
+    if (fieldType === 'integer') {
+      return 'number';
+    }
+    if (fieldType === 'object') {
+      return 'IObject';
+    }
+    return fieldType;
+  }
+}

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

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

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

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

package/packages/cli/src/core/handlebars/helpers/helper-base.ts

@@ -0,0 +1,27 @@
+import Handlebars from 'handlebars';
+
+/**
+ * helper 基类
+ *
+ * @export
+ * @class HelperBase
+ */
+export abstract class HelperBase {
+  /**
+   * Creates an instance of HelperBase.
+   *
+   * @param {string} tag 助手标识
+   */
+  constructor(tag: string) {
+    Handlebars.registerHelper(tag, this.onExecute);
+  }
+
+  /**
+   * 助手执行
+   *
+   * @abstract
+   * @param {...unknown[]} args
+   * @return {*}  {(string | boolean)}
+   */
+  abstract onExecute(...args: unknown[]): string | boolean;
+}

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

@@ -0,0 +1,25 @@
+import { HelperUtil } from '../../utils';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 字符串包含内容
+ *
+ * @description 判断: 'test'.includes('t'), 用法: {{#includes word word2}}xxx{{else}}yyy{{/includes}}、{{includes word word2}} 返回值为 boolean 类型
+ * @export
+ * @class HelperIncludes
+ * @extends {HelperBase}
+ */
+export class HelperIncludes extends HelperBase {
+  constructor() {
+    super('includes');
+  }
+
+  onExecute(
+    param: string,
+    param2: string,
+    options: Handlebars.HelperOptions,
+  ): string | boolean {
+    const bol = param.includes(param2);
+    return HelperUtil.handleJudgmentExecute(this, bol, options);
+  }
+}

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

@@ -0,0 +1,52 @@
+import { HelperAnd } from './and/and';
+import { HelperCamelCase } from './camel-case/camel-case';
+import { HelperConcat } from './concat/concat';
+import { HelperEq } from './eq/eq';
+import { HelperFormatImport } from './format-import/format-import';
+import { HelperFormatImportItem } from './format-import-item/format-import-item';
+import { HelperFormatJsType } from './format-js-type/format-js-type';
+import { HelperGt } from './gt/gt';
+import { HelperGte } from './gte/gte';
+import { HelperIncludes } from './includes/includes';
+import { HelperJson } from './json/json';
+import { HelperLowerCase } from './lower-case/lower-case';
+import { HelperLt } from './lt/lt';
+import { HelperLte } from './lte/lte';
+import { HelperNeq } from './neq/neq';
+import { HelperNotIncludes } from './not-includes/not-includes';
+import { HelperNot } from './not/not';
+import { HelperOr } from './or/or';
+import { HelperPascalCase } from './pascal-case/pascal-case';
+import { HelperSnakeCase } from './snake-case/snake-case';
+import { HelperSpinalCase } from './spinal-case/spinal-case';
+import { HelperUpperCase } from './upper-case/upper-case';
+
+/**
+ * 安装自定义助手
+ *
+ * @export
+ */
+export function installHelpers(): void {
+  new HelperAnd();
+  new HelperCamelCase();
+  new HelperConcat();
+  new HelperEq();
+  new HelperFormatImport();
+  new HelperFormatImportItem();
+  new HelperFormatJsType();
+  new HelperGt();
+  new HelperGte();
+  new HelperIncludes();
+  new HelperJson();
+  new HelperLowerCase();
+  new HelperLt();
+  new HelperLte();
+  new HelperNeq();
+  new HelperNot();
+  new HelperNotIncludes();
+  new HelperOr();
+  new HelperPascalCase();
+  new HelperSnakeCase();
+  new HelperSpinalCase();
+  new HelperUpperCase();
+}

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

@@ -0,0 +1,23 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * json 转 string
+ *
+ * @description 用法 {{json xxx 2}}，支持第二个参数传递格式化。效果: 将 json 对象转为 json 字符串
+ * @export
+ * @class HelperJson
+ * @extends {HelperBase}
+ */
+export class HelperJson extends HelperBase {
+  constructor() {
+    super('jsonStringify');
+  }
+
+  onExecute(obj: Record<string, unknown> | unknown[], space: number): string {
+    return JSON.stringify(
+      obj,
+      null,
+      typeof space === 'number' ? space : undefined,
+    );
+  }
+}

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

@@ -0,0 +1,22 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 字符串转换小写
+ *
+ * @description 用法 {{lowerCase word}}, 效果: MyName => myname
+ * @export
+ * @class HelperLowerCase
+ * @extends {HelperBase}
+ */
+export class HelperLowerCase extends HelperBase {
+  constructor() {
+    super('lowerCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return param.toLowerCase();
+  }
+}

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

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

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

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

package/packages/cli/src/core/handlebars/helpers/neq/neq.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, 用法 {{#neq word 'xxx'}}xxx{{else}}yyy{{/neq}}、{{neq word 'xxx'}} 返回值为 boolean 类型
+ * @export
+ * @class HelperNeq
+ * @extends {HelperBase}
+ */
+export class HelperNeq extends HelperBase {
+  constructor() {
+    super('neq');
+  }
+
+  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/not/not.ts

@@ -0,0 +1,25 @@
+import * as Handlebars from 'handlebars';
+import { HelperUtil } from '../../utils';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 参数不存在或者为空时返回 true
+ *
+ * @description 判断: 参数为 null、undefined、空字符串、空数组、空对象时返回 true, 用法: {{#not value}}xxx{{else}}yyy{{/not}}、{{not value}} 返回值为 boolean 类型
+ * @export
+ * @class HelperNot
+ * @extends {HelperBase}
+ */
+export class HelperNot extends HelperBase {
+  constructor() {
+    super('not');
+  }
+
+  onExecute(
+    param: unknown,
+    options: Handlebars.HelperOptions,
+  ): string | boolean {
+    const bol = Handlebars.Utils.isEmpty(param);
+    return HelperUtil.handleJudgmentExecute(this, bol, options);
+  }
+}

package/packages/cli/src/core/handlebars/helpers/not-includes/not-includes.ts

@@ -0,0 +1,25 @@
+import { HelperUtil } from '../../utils';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 字符串不包含内容
+ *
+ * @description 判断: !'test'.notIncludes('t'), 用法: {{#notIncludes word word2}}xxx{{else}}yyy{{/notIncludes}}、{{notIncludes word word2}} 返回值为 boolean 类型
+ * @export
+ * @class HelperNotIncludes
+ * @extends {HelperBase}
+ */
+export class HelperNotIncludes extends HelperBase {
+  constructor() {
+    super('notIncludes');
+  }
+
+  onExecute(
+    param: string,
+    param2: string,
+    options: Handlebars.HelperOptions,
+  ): string | boolean {
+    const bol = !param.includes(param2);
+    return HelperUtil.handleJudgmentExecute(this, bol, options);
+  }
+}

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

@@ -0,0 +1,26 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 或者条件
+ *
+ * @description 判断: word word2 word3 其中任意一个值在判断中为 true, 用法 {{#or word word2 word3}}xxx{{else}}yyy{{/or}}、{{or word word2 word3}} 返回值为 boolean 类型
+ * @export
+ * @class HelperOr
+ * @extends {HelperBase}
+ */
+export class HelperOr extends HelperBase {
+  constructor() {
+    super('or');
+  }
+
+  onExecute(...args: unknown[] | Handlebars.HelperOptions[]): string {
+    const options = args[args.length - 1] as Handlebars.HelperOptions;
+    args.pop();
+    const item = (args as unknown[]).find(itemArg => !!itemArg);
+    if (options.fn) {
+      const data = options.data?.root || {};
+      return item ? options.fn(data) : options.inverse(data);
+    }
+    return (item as string) || '';
+  }
+}

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

@@ -0,0 +1,23 @@
+import { upperFirst } from 'lodash-es';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 首字母转大写
+ *
+ * @description 用法 {{pascalCase word}}，效果: myName => MyName
+ * @export
+ * @class HelperPascalCase
+ * @extends {HelperBase}
+ */
+export class HelperPascalCase extends HelperBase {
+  constructor() {
+    super('pascalCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return upperFirst(param);
+  }
+}

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

@@ -0,0 +1,23 @@
+import { snakeCase } from 'lodash-es';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 驼峰转蛇形命名法
+ *
+ * @description 用法 {{snakeCase word}}，效果: myName => my_name
+ * @export
+ * @class HelperSnakeCase
+ * @extends {HelperBase}
+ */
+export class HelperSnakeCase extends HelperBase {
+  constructor() {
+    super('snakeCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return snakeCase(param);
+  }
+}

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

@@ -0,0 +1,23 @@
+import { kebabCase } from 'lodash-es';
+import { HelperBase } from '../helper-base';
+
+/**
+ * 驼峰命名法转为横线命名法
+ *
+ * @description 用法 {{spinalCase word}}，效果: myName => my-name
+ * @export
+ * @class HelperSpinalCase
+ * @extends {HelperBase}
+ */
+export class HelperSpinalCase extends HelperBase {
+  constructor() {
+    super('spinalCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return kebabCase(param);
+  }
+}

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

@@ -0,0 +1,22 @@
+import { HelperBase } from '../helper-base';
+
+/**
+ * 字符串转大写
+ *
+ * @description 用法 {{upperCase word}}，效果: myName => MYNAME
+ * @export
+ * @class HelperUpCase
+ * @extends {HelperBase}
+ */
+export class HelperUpperCase extends HelperBase {
+  constructor() {
+    super('upperCase');
+  }
+
+  onExecute(param: string): string {
+    if (!param) {
+      return '';
+    }
+    return param.toUpperCase();
+  }
+}

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

@@ -0,0 +1,2 @@
+export { HandlebarsEngine } from './handlebars-engine';
+export * from './constant';

package/packages/cli/src/core/handlebars/utils/helper/helper.ts

@@ -0,0 +1,67 @@
+/**
+ * 助手工具类
+ *
+ * @export
+ * @class HelperUtil
+ */
+export class HelperUtil {
+  /**
+   * 当前所有助手 tag 名称
+   *
+   * @protected
+   * @type {string[]}
+   */
+  protected static helperNames: string[] = [
+    'lookup',
+    'log',
+    'and',
+    'camelCase',
+    'concat',
+    'eq',
+    'gt',
+    'get',
+    'lowerCase',
+    'lt',
+    'lte',
+    'neq',
+    'not',
+    'or',
+    'pascalCase',
+    'pluralize',
+    'snakeCase',
+    'spinalCase',
+    'upperCase',
+  ];
+
+  /**
+   * 判断字符串是否为助手
+   *
+   * @static
+   * @param {string} name
+   * @return {*}  {boolean}
+   */
+  static isHelperName(name: string): boolean {
+    return this.helperNames.includes(name);
+  }
+
+  /**
+   * 判断类助手统一结果调用处理
+   *
+   * @static
+   * @param {unknown} context 执行上下文
+   * @param {boolean} bol 判断结果
+   * @param {Handlebars.HelperOptions} options
+   * @return {*}  {(string | boolean)}
+   */
+  static handleJudgmentExecute(
+    context: unknown,
+    bol: boolean,
+    options: Handlebars.HelperOptions,
+  ): string | boolean {
+    if (options.fn) {
+      return bol ? options.fn(context) : options.inverse(context);
+    }
+
+    return bol ? (options.hash.yes = true) : (options.hash.no = false);
+  }
+}

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

@@ -0,0 +1,23 @@
+export { HelperUtil } from './helper/helper';
+
+/**
+ * win 路径 \\ 转 linux 路径 /
+ *
+ * @export
+ * @param {string} path
+ * @return {*}  {string}
+ */
+export function winToUnixPath(path: string): string {
+  return path.replace(/\\/g, '/');
+}
+
+/**
+ * linux 路径 / 转 win 路径 \\
+ *
+ * @export
+ * @param {string} path
+ * @return {*}  {string}
+ */
+export function unixToWinPath(path: string): string {
+  return path.replace(/\//g, '\\');
+}

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

@@ -0,0 +1,2 @@
+export * from './handlebars';
+export * from './interface';

package/packages/cli/src/core/interface/index.ts

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+// 全局对象类型
+export type IObject = Record<string | symbol, any>;

package/packages/cli/src/index.ts

@@ -0,0 +1,36 @@
+import { program } from 'commander';
+import { CommandLoader } from './commands';
+import { loadLocalBinCommandLoader, localBinExists } from './utils';
+import pkg from '../package.json' with { type: 'json' };
+
+export async function bootstrap(): Promise<void> {
+  // 监控 ctrl + c 停止进程，触发 exit 事件
+  process.on('SIGINT', () => {
+    process.exit();
+  });
+  // 初始化命令行
+  program
+    .version(pkg.version, '-v, --version', '查看当前版本')
+    .usage('<command> [options]')
+    .helpOption('-h, --help', '获取帮助信息')
+    .configureOutput({
+      // Visibly override write routines as example!
+      writeErr: str => process.stdout.write(`[ERR] ${str}`),
+      // Highlight errors in color.
+      outputError: (str, write) => write(`\x1b[31m${str}\x1b[0m`),
+    });
+
+  if (localBinExists()) {
+    const localCommandLoader = loadLocalBinCommandLoader();
+    localCommandLoader.load(program);
+  } else {
+    CommandLoader.load(program);
+  }
+  program.parse(process.argv);
+
+  if (!process.argv.slice(2).length) {
+    program.outputHelp();
+  }
+}
+
+export * from './core';