@dckj-npm/lowcode-code-generator 1.2.23 → 1.2.24

package/CONTRIBUTING.md

@@ -1,40 +1,40 @@
-# 如何共建
-
-1. 拉取最新代码，切换到 develop 分支，基于 develop 分支切出一个 feature 或 hotfix 分支
-2. 到 `lowcode-engine` 项目根目录下，执行 `lerna bootstrap && lerna run build --scope "@alilc/lowcode-types"` 来安装依赖并构建
-3. 到 `lowcode-engine/modules/code-generator`下，安装依赖(`npm i`)，然后先跑一遍 `npm test` 看看是否所有用例都能通过 (如果网络条件不太好，建议使用 [cnpm - 淘宝提供的中国 NPM 镜像](https://npmmirror.com/))
-4. 在 tests 目录下编写您的需求/问题的测试用例
-5. 修改 src 下的一些代码，然后运行 `npm test` 或 `npm start` 启动 jest 进行调测
-6. 确保所有的测试用例都能通过时，提 MR 给 @牧毅 -- MR 将在 1 个工作日内给您回复意见。
-
-当然，欢迎提前私聊沟通 @牧毅，或加入 低代码渲染/出码服务金牌用户群 讨论沟通。
-
-# FAQ
-
-## 如何查看单测覆盖率？
-
-执行 `npm test:cov` 命令，这样会自动生成单测覆盖率的报告到 `coverage` 目录下。
-
-## 如何只执行一个测试用例？
-
-```sh
-npm test -t 'demo2-utils-name-alias'
-```
-
-## 更新特定测试用例的 expected:
-
-```sh
-npm test:update-snapshots -t 'demo2-utils-name-alias'
-```
-
-## 如何只执行某个测试用例文件？
-
-执行 `npx jest 测试用例的文件路径` 即可，如:
-
-```sh
-npx jest tests/plugins/common/requireUtils.test.ts
-```
-
-## 如何调试某个测试用例？
-
-建议需要打断点的地方通过 VSCode 打上断点，然后打开 VSCode 的 JavaScript Debug Terminal，在其中执行 `npx jest tests/path/to/your/test/file.ts` 或 `npx jest -t your-test-case-title` 来执行你的测试用例 -- 这样执行到打了断点的语句时会自动断住，以便调试。
+# 如何共建
+
+1. 拉取最新代码，切换到 develop 分支，基于 develop 分支切出一个 feature 或 hotfix 分支
+2. 到 `lowcode-engine` 项目根目录下，执行 `lerna bootstrap && lerna run build --scope "@alilc/lowcode-types"` 来安装依赖并构建
+3. 到 `lowcode-engine/modules/code-generator`下，安装依赖(`npm i`)，然后先跑一遍 `npm test` 看看是否所有用例都能通过 (如果网络条件不太好，建议使用 [cnpm - 淘宝提供的中国 NPM 镜像](https://npmmirror.com/))
+4. 在 tests 目录下编写您的需求/问题的测试用例
+5. 修改 src 下的一些代码，然后运行 `npm test` 或 `npm start` 启动 jest 进行调测
+6. 确保所有的测试用例都能通过时，提 MR 给 @牧毅 -- MR 将在 1 个工作日内给您回复意见。
+
+当然，欢迎提前私聊沟通 @牧毅，或加入 低代码渲染/出码服务金牌用户群 讨论沟通。
+
+# FAQ
+
+## 如何查看单测覆盖率？
+
+执行 `npm test:cov` 命令，这样会自动生成单测覆盖率的报告到 `coverage` 目录下。
+
+## 如何只执行一个测试用例？
+
+```sh
+npm test -t 'demo2-utils-name-alias'
+```
+
+## 更新特定测试用例的 expected:
+
+```sh
+npm test:update-snapshots -t 'demo2-utils-name-alias'
+```
+
+## 如何只执行某个测试用例文件？
+
+执行 `npx jest 测试用例的文件路径` 即可，如:
+
+```sh
+npx jest tests/plugins/common/requireUtils.test.ts
+```
+
+## 如何调试某个测试用例？
+
+建议需要打断点的地方通过 VSCode 打上断点，然后打开 VSCode 的 JavaScript Debug Terminal，在其中执行 `npx jest tests/path/to/your/test/file.ts` 或 `npx jest -t your-test-case-title` 来执行你的测试用例 -- 这样执行到打了断点的语句时会自动断住，以便调试。

package/README.md

@@ -1,123 +1,123 @@
-# 出码
-
-所谓出码，即将低代码编排出的 schema 进行解析并转换成最终可执行的代码的过程。本模块提供有 Icejs 和 Rax 两套框架的出码方案，并提供了强大而灵活的扩展机制。
-
-## 使用方法
-
-### 1) 通过命令行快速体验
-
-欢迎使用命令行工具快速体验：`npx @alilc/lowcode-code-generator -i example-schema.json -o generated -s icejs`
-
---其中 example-schema.json 可以从[这里下载](https://unpkg.com/@alilc/lowcode-code-generator@beta/example-schema.json)
-
-### 2) 通过设计器插件快速体验
-
-1. 安装依赖: `npm install --save @alilc/lowcode-plugin-code-generator`
-2. 注册插件:
-
-```ts
-import { plugins } from '@alilc/lowcode-engine';
-import CodeGenPlugin from '@alilc/lowcode-plugin-code-generator';
-
-// 在你的初始化函数中：
-await plugins.register(CodeGenPlugin);
-
-// 如果您不希望自动加上出码按钮，则可以这样注册
-await plugins.register(CodeGenPlugin, { disableCodeGenActionBtn: true });
-```
-
-然后运行你的低代码编辑器项目即可 -- 在设计器的右上角会出现一个“出码”按钮，点击即可在浏览器中出码并预览。
-
-### 3）服务端出码接入
-
-此代码生成器一开始就是为服务端出码设计的，你可以直接这样来在 node.js 环境中使用：
-
-1. 安装依赖: `npm install --save @alilc/lowcode-code-generator`
-2. 引入代码生成器:
-
-```js
-import CodeGenerator from '@alilc/lowcode-code-generator';
-```
-
-3. 创建项目构建器:
-
-```js
-const projectBuilder = CodeGenerator.solutions.icejs();
-```
-
-4. 生成代码
-
-```js
-const project = await projectBuilder.generateProject(
-  schema, // 编排搭建出来的 schema
-);
-```
-
-5. 将生成的代码写入到磁盘中(也可以生成一个 zip 包)
-
-```js
-// 写入磁盘
-await CodeGenerator.publishers.disk().publish({
-  project, // 上一步生成的 project
-  outputPath: '/path/to/your/output/dir', // 输出目录
-  projectSlug: 'your-project-slug', // 项目标识
-});
-
-// 写入到 zip 包
-await CodeGenerator.publishers.zip().publish({
-  project, // 上一步生成的 project
-  outputPath: '/path/to/your/output/dir', // 输出目录
-  projectSlug: 'your-project-slug', // 项目标识 -- 对应生成 your-project-slug.zip 文件
-});
-```
-
-注：一般来说在服务端出码可以跟 github/gitlab, CI 和 CD 流程等一起串起来使用，通常用于优化性能。
-
-### 4）浏览器中出码接入
-
-随着现在电脑性能和浏览器技术的发展，出码其实已经不必非得在服务端做了，借助于 Web Worker 特性，可以在浏览器中进行出码：
-
-1. 安装依赖: `npm install --save @alilc/lowcode-code-generator`
-2. 引入代码生成器:
-
-```js
-import * as CodeGenerator from '@alilc/lowcode-code-generator/standalone-loader';
-```
-
-3. 【可选】提前初始化代码生成器:
-
-```js
-// 提前初始化下，这样后面用的时候更快(这个 init 内部会提前准备好创建 worker 的一些资源)
-await CodeGenerator.init();
-```
-
-4. 出码
-
-```js
-const project = await CodeGenerator.generateCode({
-  solution: 'icejs', // 出码方案 (目前内置有 icejs 和 rax )
-  schema, // 编排搭建出来的 schema
-});
-
-console.log(project); // 出码结果(默认是递归结构描述的，可以传 flattenResult: true 以生成扁平结构的结果)
-```
-
-注：一般来说在浏览器中出码适合做即时预览功能。
-
-5. 下载 zip 包
-
-```js
-// 写入到 zip 包
-await CodeGenerator.publishers.zip().publish({
-  project, // 上一步生成的 project
-  projectSlug: 'your-project-slug', // 项目标识 -- 对应下载 your-project-slug.zip 文件
-});
-```
-
-### 5）自定义出码
-
-前端框架灵活多变，默认内置的出码方案很难满足所有人的需求，好在此代码生成器支持非常灵活的插件机制 -- 欢迎参考 ./src/plugins/xxx 来编写您自己的出码插件，然后参考 ./src/solutions/xxx 将各种插件组合成一套适合您的业务场景的出码方案。
-
-## 参与共建
-
-欢迎参与共建，如何共建请参阅：[./CONTRIBUTING.md](https://github.com/alibaba/lowcode-engine/blob/main/modules/code-generator/CONTRIBUTING.md)
+# 出码
+
+所谓出码，即将低代码编排出的 schema 进行解析并转换成最终可执行的代码的过程。本模块提供有 Icejs 和 Rax 两套框架的出码方案，并提供了强大而灵活的扩展机制。
+
+## 使用方法
+
+### 1) 通过命令行快速体验
+
+欢迎使用命令行工具快速体验：`npx @alilc/lowcode-code-generator -i example-schema.json -o generated -s icejs`
+
+--其中 example-schema.json 可以从[这里下载](https://unpkg.com/@alilc/lowcode-code-generator@beta/example-schema.json)
+
+### 2) 通过设计器插件快速体验
+
+1. 安装依赖: `npm install --save @alilc/lowcode-plugin-code-generator`
+2. 注册插件:
+
+```ts
+import { plugins } from '@alilc/lowcode-engine';
+import CodeGenPlugin from '@alilc/lowcode-plugin-code-generator';
+
+// 在你的初始化函数中：
+await plugins.register(CodeGenPlugin);
+
+// 如果您不希望自动加上出码按钮，则可以这样注册
+await plugins.register(CodeGenPlugin, { disableCodeGenActionBtn: true });
+```
+
+然后运行你的低代码编辑器项目即可 -- 在设计器的右上角会出现一个“出码”按钮，点击即可在浏览器中出码并预览。
+
+### 3）服务端出码接入
+
+此代码生成器一开始就是为服务端出码设计的，你可以直接这样来在 node.js 环境中使用：
+
+1. 安装依赖: `npm install --save @alilc/lowcode-code-generator`
+2. 引入代码生成器:
+
+```js
+import CodeGenerator from '@alilc/lowcode-code-generator';
+```
+
+3. 创建项目构建器:
+
+```js
+const projectBuilder = CodeGenerator.solutions.icejs();
+```
+
+4. 生成代码
+
+```js
+const project = await projectBuilder.generateProject(
+  schema, // 编排搭建出来的 schema
+);
+```
+
+5. 将生成的代码写入到磁盘中(也可以生成一个 zip 包)
+
+```js
+// 写入磁盘
+await CodeGenerator.publishers.disk().publish({
+  project, // 上一步生成的 project
+  outputPath: '/path/to/your/output/dir', // 输出目录
+  projectSlug: 'your-project-slug', // 项目标识
+});
+
+// 写入到 zip 包
+await CodeGenerator.publishers.zip().publish({
+  project, // 上一步生成的 project
+  outputPath: '/path/to/your/output/dir', // 输出目录
+  projectSlug: 'your-project-slug', // 项目标识 -- 对应生成 your-project-slug.zip 文件
+});
+```
+
+注：一般来说在服务端出码可以跟 github/gitlab, CI 和 CD 流程等一起串起来使用，通常用于优化性能。
+
+### 4）浏览器中出码接入
+
+随着现在电脑性能和浏览器技术的发展，出码其实已经不必非得在服务端做了，借助于 Web Worker 特性，可以在浏览器中进行出码：
+
+1. 安装依赖: `npm install --save @alilc/lowcode-code-generator`
+2. 引入代码生成器:
+
+```js
+import * as CodeGenerator from '@alilc/lowcode-code-generator/standalone-loader';
+```
+
+3. 【可选】提前初始化代码生成器:
+
+```js
+// 提前初始化下，这样后面用的时候更快(这个 init 内部会提前准备好创建 worker 的一些资源)
+await CodeGenerator.init();
+```
+
+4. 出码
+
+```js
+const project = await CodeGenerator.generateCode({
+  solution: 'icejs', // 出码方案 (目前内置有 icejs 和 rax )
+  schema, // 编排搭建出来的 schema
+});
+
+console.log(project); // 出码结果(默认是递归结构描述的，可以传 flattenResult: true 以生成扁平结构的结果)
+```
+
+注：一般来说在浏览器中出码适合做即时预览功能。
+
+5. 下载 zip 包
+
+```js
+// 写入到 zip 包
+await CodeGenerator.publishers.zip().publish({
+  project, // 上一步生成的 project
+  projectSlug: 'your-project-slug', // 项目标识 -- 对应下载 your-project-slug.zip 文件
+});
+```
+
+### 5）自定义出码
+
+前端框架灵活多变，默认内置的出码方案很难满足所有人的需求，好在此代码生成器支持非常灵活的插件机制 -- 欢迎参考 ./src/plugins/xxx 来编写您自己的出码插件，然后参考 ./src/solutions/xxx 将各种插件组合成一套适合您的业务场景的出码方案。
+
+## 参与共建
+
+欢迎参与共建，如何共建请参阅：[./CONTRIBUTING.md](https://github.com/alibaba/lowcode-engine/blob/main/modules/code-generator/CONTRIBUTING.md)

package/bin/lowcode-code-generator.js

@@ -1,53 +1,53 @@
-#!/usr/bin/env node
-/* eslint-disable no-var */
-/* eslint-disable prefer-arrow-callback */
-/* eslint-disable @typescript-eslint/no-require-imports */
-
-var program = require('commander');
-
-program
-  .command('generate', { isDefault: true })
-  .description('Generate code from ali lowcode schema')
-  .requiredOption('-s, --solution <solution>', 'specify the solution to use (icejs/rax/recore)')
-  .option('-i, --input <input>', 'specify the input schema file')
-  .option('-r, --resourceList <resourceList>', 'specify the input resourceList file')
-  .option('-o, --output <output>', 'specify the output directory', 'generated')
-  .option('-c, --cwd <cwd>', 'specify the working directory', '.')
-  .option('-q, --quiet', 'be quiet, do not output anything unless get error', false)
-  .option('-v, --verbose', 'be verbose, output more information', false)
-  .option('--solution-options <options>', 'specify the solution options', '{}')
-  .arguments('[input-schema] ali lowcode schema JSON file')
-  .action(function doGenerate(inputSchema, command) {
-    var options = command.opts();
-    if (options.cwd) {
-      process.chdir(options.cwd);
-    }
-
-    require('../dist/cli')
-      .run(inputSchema ? [inputSchema] : [], options)
-      .then((retCode) => {
-        process.exit(retCode);
-      });
-  });
-
-program
-  .command('init-solution')
-  .option('-c, --cwd <cwd>', 'specify the working directory', '.')
-  .option('-q, --quiet', 'be quiet, do not output anything unless get error', false)
-  .option('-v, --verbose', 'be verbose, output more information', false)
-  .arguments('<your-solution-name>')
-  .action(function initSolution(solutionName, command) {
-    var options = command.opts();
-    if (options.cwd) {
-      process.chdir(options.cwd);
-    }
-
-    require('../dist/cli')
-      .initSolution([solutionName], options)
-      .then((retCode) => {
-        process.exit(retCode);
-      });
-  });
-
-program.parse(process.argv);
-
+#!/usr/bin/env node
+/* eslint-disable no-var */
+/* eslint-disable prefer-arrow-callback */
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+var program = require('commander');
+
+program
+  .command('generate', { isDefault: true })
+  .description('Generate code from ali lowcode schema')
+  .requiredOption('-s, --solution <solution>', 'specify the solution to use (icejs/rax/recore)')
+  .option('-i, --input <input>', 'specify the input schema file')
+  .option('-r, --resourceList <resourceList>', 'specify the input resourceList file')
+  .option('-o, --output <output>', 'specify the output directory', 'generated')
+  .option('-c, --cwd <cwd>', 'specify the working directory', '.')
+  .option('-q, --quiet', 'be quiet, do not output anything unless get error', false)
+  .option('-v, --verbose', 'be verbose, output more information', false)
+  .option('--solution-options <options>', 'specify the solution options', '{}')
+  .arguments('[input-schema] ali lowcode schema JSON file')
+  .action(function doGenerate(inputSchema, command) {
+    var options = command.opts();
+    if (options.cwd) {
+      process.chdir(options.cwd);
+    }
+
+    require('../dist/cli')
+      .run(inputSchema ? [inputSchema] : [], options)
+      .then((retCode) => {
+        process.exit(retCode);
+      });
+  });
+
+program
+  .command('init-solution')
+  .option('-c, --cwd <cwd>', 'specify the working directory', '.')
+  .option('-q, --quiet', 'be quiet, do not output anything unless get error', false)
+  .option('-v, --verbose', 'be verbose, output more information', false)
+  .arguments('<your-solution-name>')
+  .action(function initSolution(solutionName, command) {
+    var options = command.opts();
+    if (options.cwd) {
+      process.chdir(options.cwd);
+    }
+
+    require('../dist/cli')
+      .initSolution([solutionName], options)
+      .then((retCode) => {
+        process.exit(retCode);
+      });
+  });
+
+program.parse(process.argv);
+