CLI 特性介绍

安装

安装 Node.js 12+ 和 npm 6+（通常 node 会自带）。

使用 npm 安装 generator CLI 工具：

npm install -g @cuba-platform/front-generator

使用下面的命令检查安装是否成功：

gen-cuba-front

该命令会显示使用说明。

或者可以使用 npx 直接运行而不需要安装：

npx @cuba-platform/front-generator

项目元数据

Generator CLI 工具需要项目的元数据：即项目中实体、视图等信息。可以通过 CUBA Studio 传递这些信息给 CLI。有两个途径：

自动传递项目元数据

  • 在 CUBA Studio 打开项目。

  • 打开设置 （File > Settings），然后打开 Languages & Frameworks > CUBA。

  • 勾选 Enable integration 复选框：

    开启 Studio 集成功能

现在 generator 可以自动识别 Studio 中打开的 CUBA 项目了。

手动传递项目元数据

也可以手动导出项目模型。在主菜单选择 CUBA > Advanced > Export project model 即可。Studio 会生成 projectModel.json 文件。

当项目模型有变化时（即修改了实体、或者添加了视图等），您需要重新生成项目模型文件并在已经生成的代码中更新项目模型。更新模型可以用一个 npm 脚本执行：npm run update-model