zero-ai 0.3.26 → 0.3.30

package/src/epic/index.js

@@ -32,185 +32,78 @@ const exported = {
  *
  * # Zero Ai研发文档
  *
- * 该文档提供给研发人员直接研发下列工具专用，最新版本`0.3.2`。
+ * 该文档提供给研发人员直接研发下列工具专用，最新版本`0.3.30`。
  *
  * ## 1. 命令清单
  *
- * * `ai xxx`：基础命令工具。
- * * `aj xxx`：界面工具集。
+ * * `ai xxx`：通用自动化工具集。
+ * * `aj xxx`：后端自动化工具集（ai for java）。
+ * * `art xxx`：前端自动化工具集（ai for react）。
  *
  * ## 2. Epic使用方法
  *
+ * > Epic是内部研发专用工具，位于API文档中有相关说明，记录了当前环境下用于内部研发的所有工具集，命令教程中的顺序按开发配置中的顺序进行，开发配置目录位于：`src/commander` 中。
+ *
  * ```js
  * const Ec = require('./epic');
  * // Ec.xxx 调用全程Api
  * ```
  *
- * ## 3. 命令表
- *
- * ### 3.1. 标准命令
- *
- * |命令执行|含义|
- * |---|:---|
- * |ai csv|读取数据文件中的Array数组数据转换成csv的文件格式并输出。|
- * |ai data|专用数据生成器，可生成`Object/Array`两种数据格式。|
- * |ai key|为输入数据中的Array或Object追加`UUID`格式的字段，字段可配置，默认为`field = key`属性。|
- * |ai uk|检查输入数据中是否包含了`field1,field2,field3`属性中的重复数据，直接输出结果。|
- * |ai uuid|随机生成一定数量的UUID字符串，并且拷贝到剪切板中（MacOs）。|
- * |ai init|「前端」生成项目的初始化代码骨架。|
- *
- * ### 3.2. Zero命令
- *
- * |命令执行|含义|
- * |---|:---|
- * |aj icomplex|「模块」生成`ExListComplex`专用模块。|
- * |aj iform|「组件」生成`ExForm`专用组件。|
- * |aj jperm|「后端」生成权限专用的Excel数据文件。|
- * |aj jplugin|「后端」针对新建的Maven项目执行Ox中集成项目的初始化代码骨架。|
- * |aj jinit|「后端」生成项目的初始化代码骨架。|
- *
- */
-/**
- * ## ai命令
- *
- * ### 1. 基本使用
- *
- * ai命令的专用语法如下：
- *
- * ```shell
- * ai <command> [options1|options2|options3...]
- * ```
- *
- * ### 2. 命令列表
- *
- * |命令执行|含义|
- * |---|:---|
- * |ai csv|读取数据文件中的Array数组数据转换成csv的文件格式并输出。|
- * |ai data|专用数据生成器，可生成`Object/Array`两种数据格式。|
- * |ai key|为输入数据中的Array或Object追加`UUID`格式的字段，字段可配置，默认为`field = key`属性。|
- * |ai uk|检查输入数据中是否包含了`field1,field2,field3`属性中的重复数据，直接输出结果。|
- * |ai uuid|随机生成一定数量的UUID字符串，并且拷贝到剪切板中（MacOs）。|
- *
- * ### 3. 数据通用格式
- *
- * **带data节点**
- *
- * ```json
- * {
- *     "data": [
- *          {
- *              "name": "Lang1",
- *              "email": "lang.yu1@hpe.com"
- *          },
- *          {
- *              "name": "Lang2",
- *              "email": "lang.yu2@hpe.com"
- *          }
- *     ]
- * }
- * ```
- *
- * **直接格式**
- *
- * ```json
- * [
- *      {
- *          "name": "Lang1",
- *          "email": "lang.yu1@hpe.com"
- *      },
- *      {
- *          "name": "Lang2",
- *          "email": "lang.yu2@hpe.com"
- *      }
- * ]
- * ```
+ * ## 3. 文档结构
  *
- * @module ai
- */
-/**
- * ## aj命令
+ * 1. 所有API文档结构分为四个部分：
+ *      - `__epic`：研发专用工具集，属于内部工具集（改造命令时专用）
+ *      - `ai`：通用工具命令
+ *      - `aj`：后端自动化工具集
+ *      - `art`：前端自动化工具集
+ * 2. 和执行命令相关的错误信息全部位类 `E` 中有所定义。
  *
- * ### 1. 基本使用
+ * ## 4. 工具研发
  *
- * aj命令的专用语法如下：
+ * ### 4.1. 源码
  *
- * ```shell
- * aj <command> [options1|options2|options3...]
- * ```
+ * 工具研发源代码位于 `src` 目录中，子目录详细信息如下：
  *
- * ### 2. 命令列表
- *
- * |命令执行|含义|
+ * |目录|含义|
  * |---|:---|
- * |aj icomplex|「模块」生成`ExListComplex`专用模块。|
- * |aj iform|「组件」生成`ExForm`专用组件。|
- * |aj jperm|「后端」生成权限专用的Excel数据文件。|
- *
- * ### 3. 标准化配置
- *
- * ```js
- * {
- *      module: 'ZT环境变量设置的模块',
- *      language: 'Z_LANGUAGE语言环境变量设置，默认「cn」',
- *      pathRoot: '系统根据执行目录计算的当前项目根目录',
- *      pathResource: '资源目录',
- *      pathUi: '生成代码目录',
- *      namespace: 'Cab.json中所需的名空间值',
- *      input: {
- *          params: {
- *              MODULE: '当前模块的文字描述名称',
- *              API: '构造标准接口`/api/xxx`的RESTful接口专用路径替换部分。',
- *              IDENTIFIER: '模型的统一标识符，最终会绑定到identifier中。'
- *          },
- *          tpl: {
- *              type: '使用的模板tpl文件目录，cab/下的目录名',
- *              source: '「单文件」单文件的拷贝源',
- *              target: '「单文件」单文件的目标拷贝文件'
- *          }
- *      },
- *      runtime: {
- *          namespaceFile: 'Cab.json文件生成路径',
- *          resource: '资源文件的根目录',
- *          resourceFiles: {
- *              'fileName1': '资源文件地址，json后缀，模板则是fileName1.tpl文件',
- *              'fileName2': '......'
- *          },
- *          ui: '代码文件根目录',
- *          uiFiles: {
- *              'fileName1': '代码文件地址，js后缀，模板则是fileName1.tpl文件',
- *              'fileName2': '......'
- *          }
- *      }
- * }
- * ```
- *
- *
- * ### 4. 标准化模板参数
- *
- * > `tpl`文件中替换的部分会使用配置文件中的参数来替换。
- *
- * |参数|替换部分|含义|
- * |:---|---|:---|
- * |MODULE|`#MODULE#`|当前模块的文字描述名称。|
- * |API|`#API#`|构造标准接口`/api/xxx`的RESTful接口专用路径替换部分。|
- * |IDENTIFIER|`#IDENTIFIER#`|模型的统一标识符，最终会绑定到identifier中。|
- * |NAME|`#NAME#`|绑定文件设定，直接赋值`input.params.NAME = tpl.target`生成单文件专用。|
- * |SIGMA|`#SIGMA`|SIGMA统一标识符，用于标识租户、应用。|
- * |ROLE_ID|`#ROLE_ID#`|操作的角色ID。|
- * |PREFIX|无|生成文件专用参数，不在模板中。|
- * |SHEET|无|工作专用的Sheet名，不在模板中。|
- *
- *
- * @module aj
- */
-/**
- * ## 调试专用
+ * |`cab`|代码模板、文档模板、资源文件模板。|
+ * |`commander`|命令定义文件，包括`ai/aj/art`三个命令的定义。|
+ * |`commander-ai`|开发 `ai xxx` 命令专用目录。|
+ * |`commander-aj`|开发 `aj xxx` 命令专用目录。|
+ * |`commander-ar`|开发 `art xxx` 命令专用目录。|
+ * |`epic`|内部研发专用工具集。|
+ *
+ * ### 4.2. 参数表
+ *
+ * 参数表定义位于 `src/commander/option.zero` 文件中，只有此文件中的参数是可用参数，形成统一的 __参数规范__。命令执行时并非支持所有命令，参数表中会有命令中所使用的参数列表，只是所有命令中这些参数的 __缩写和全称__ 维持一致，在不同命令中表示相同或相近的含义。
+ *
+ * |简写|全称|含义|
+ * |:---|:---|:---|
+ * |`-f`|`--field`|一般表示字段名称，用于描述模型字段、文件列等各种字段信息。|
+ * |`-d`|`--data`|用于表示数据文件位置，或数据内容指向。|
+ * |`-p`|`--path`|指定文件路径专用参数，用来描述输入文件路径。|
+ * |`-c`|`--config`|用于表示配置文件位置，或配置内容指向。|
+ * |`-j`|`--json`|用于表示JSON的格式或基于 Json Schema 的数据格式描述。|
+ * |`-n`|`--number`|用于指定数量信息，通常在生成数据时表示生成数据条数。|
+ * |`-o`|`--out`|用于指定输出文件位置，通常是生成代码输出目录、输出文件描述。|
+ * |`-k`|`--key`|表示键名，用于描述模型键、文件列唯一键、数据表主键等信息。|
+ * |`-u`|`--ui`|前端界面专用生成参数，可以是目录也可以是内容等各种用来描述前端配置路径的专用参数。|
+ * |`-t`|`--target`|用于描述目标对象，此参数不局限于输出模式，通常可以表示目标信息描述。|
+ * |`-s`|`--separator`|用于表示分隔符信息，如果是处理文件，此属性默认会提取操作系统分隔符。|
+ * |`-m`|`--module`|用于描述模块，通常表示模块名称、模块元数据定义。|
+ * |`-a`|`--all`|开启全格式、全逻辑、全流程的专用选项。|
+ * |`-y`|`--yes`|确认选项专用参数，通常用于指定布尔开关时会使用此参数。|
+ * |`-v`|`--value`|用于描述值相关信息，如字符串值、数值、布尔值等相关值信息，某些场合用来描述值字段。|
+ * |`-r`|`--role`|在权限管理模型中，用于描述角色信息，通常在权限执行时专用。|
+ * |`-i`|`--input`|用于指定输入文件位置，或输入目录、输入内容描述。|
+ * |`-l`|`--length`|用于指定长度信息，通常在密码处理时用于描述生成字符串的长度。|
+ * |`-e`|`--extension`|用于指定扩展名、扩展等相关信息。|
+ * |`-w`|`--write`|用于写入操作的专用描述，通常生成文件时会使用此参数。|
  *
- * @module _debug
  */
 /**
- * ## 研发专用
+ * ## 「内部」改造命令专用
  *
- * @module _epic
+ * @module __epic
  */
 module.exports = exported;