From 202ade47a2c135f4c34b97931ee4f71036cdef77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=89=A7=E6=AF=85?= Date: Fri, 14 Aug 2020 10:31:47 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20=E6=B7=BB=E5=8A=A0?= =?UTF-8?q?=E5=BC=80=E5=8F=91=E6=B5=81=E7=A8=8B=E8=AF=B4=E6=98=8E,?= =?UTF-8?q?=E4=BB=A5=E5=A4=87=E5=90=8E=E7=BB=AD=E5=BC=80=E5=8F=91=E8=80=85?= =?UTF-8?q?=E5=8F=82=E8=80=83?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/code-generator/README.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/packages/code-generator/README.md b/packages/code-generator/README.md index fe71e6c6a..35b2d9aba 100644 --- a/packages/code-generator/README.md +++ b/packages/code-generator/README.md @@ -1,9 +1,31 @@ # 出码模块 +详细介绍看这里： + ## 安装接入 - ## 自定义导出 - ## 开始开发 + +本项目隶属于 [ali-lowcode-engine](http://gitlab.alibaba-inc.com/ali-lowcode/ali-lowcode-engine), 需要和整个 [ali-lowcode-engine](http://gitlab.alibaba-inc.com/ali-lowcode/ali-lowcode-engine) 一起开发。 + +所以先要初始化整个 [ali-lowcode-engine](http://gitlab.alibaba-inc.com/ali-lowcode/ali-lowcode-engine) 的环境： + +1. 克隆 [ali-lowcode-engine](http://gitlab.alibaba-inc.com/ali-lowcode/ali-lowcode-engine): `git clone git@gitlab.alibaba-inc.com:ali-lowcode/ali-lowcode-engine.git` +2. 运行 `setup` 脚本，初始化环境： `npm run setup` + +然后，因为本项目依赖 `@ali/lowcode-types` 所以需要先构建下 `type`，即执行: `lerna run build --scope @ali/lowcode-types` + +最后，可以运行 `npm start` 命令启动本地调试（本项目通过 `ava` 进行单元测试，故 `start` 脚本其实就是 `watch` 模式的 `ava`): + +```sh +# 到本项目目录下执行：（推荐） +npm start + +# 或直接执行 ava： +npx ava --watch + +# 或在 ali-lowcode-engine 工程根目录下执行: (不推荐，因为命令太长而且没法响应输入) +lerna run start --stream --scope @ali/lowcode-code-generator +```