diff --git a/README.md b/README.md index 2867acfe4..76abb3381 100644 --- a/README.md +++ b/README.md @@ -1,55 +1,44 @@ -Ali Lowcode Engine(阿里低代码引擎) ---- +## Ali Lowcode Engine(阿里低代码引擎) [Lerna](https://github.com/lerna/lerna) + [TS](https://www.typescriptlang.org/) -## 准备 - -```bash -npm login --registry http://registry.npm.alibaba-inc.com --scope @ali -``` - -```bash -tnpm i -g git-cz -``` - ## 开发 #### 创建新包: - - `./create.sh ` +- `./create.sh ` #### 跑起来: - - `tnpm i` - - `npm run boot` - - `npm run build` +- `tnpm i` +- `npm run boot` +- `npm run build` #### Link & unlink - - `cd packages/ && tnpm link -g` - - `tnpm link @ali/` +- `cd packages/ && tnpm link -g` +- `tnpm link @ali/` - - `tnpm unlink @ali/` +- `tnpm unlink @ali/` #### 开发过程中: - - `git add ` - - `git cz` +- `git add ` +- `npm run commit` ## 发布 - - `npm run pub` +- `npm run pub` ## 注意 - - Commit 动作尽量使用 `git cz`,方便按语义化版本自动递增,以及自动生成 `CHANGELOG.md` - - `packages` 工程里一些开发时公共依赖(比如:`typescript`、`ava` 等)会放到工程顶层 - - 工程里的 `.md`、`test/` 等文件修改不会产生新的发布 - - 当工程里存在多个 ts 文件的目录时,最终产生的文件会按文件夹形式放到 `lib` 下 +- Commit 动作尽量使用 `npm run commit`,其内部调用了 `git cz`,方便按语义化版本自动递增,以及自动生成 `CHANGELOG.md` +- `packages` 工程里一些开发时公共依赖(比如:`typescript`、`ava` 等)会放到工程顶层 +- 工程里的 `.md`、`test/` 等文件修改不会产生新的发布 +- 当工程里存在多个 ts 文件的目录时,最终产生的文件会按文件夹形式放到 `lib` 下 ## 包权限管理 - - `npm owner ls @ali/ --registry http://registry.npm.alibaba-inc.com` - - `npm owner add @ali/ --registry http://registry.npm.alibaba-inc.com` - - `npm owner rm @ali/ --registry http://registry.npm.alibaba-inc.com ` +- `npm owner ls @ali/ --registry http://registry.npm.alibaba-inc.com` +- `npm owner add @ali/ --registry http://registry.npm.alibaba-inc.com` +- `npm owner rm @ali/ --registry http://registry.npm.alibaba-inc.com`