Skip to content

Commit ab9d05d

Browse files
committed
feat(generator): add command aliases, refine document
1 parent 5e61b16 commit ab9d05d

3 files changed

Lines changed: 21 additions & 7 deletions

File tree

‎generator/README.md‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,10 @@ milkygen
1616

1717
## 命令
1818

19-
### 查看可用 generator
20-
21-
```
22-
milkygen list
23-
```
24-
2519
### 生成内容
2620

21+
> 别名:`g`, `gen`
22+
2723
```
2824
milkygen generate <generator> [--output <file>] [--version <version>]
2925
```
@@ -44,6 +40,21 @@ milkygen generate rust/serde --version 1.2.1
4440
- `latest`: 默认值,使用 npm `latest` 标签对应版本的协议定义。
4541
- 具体版本号: **只能使用 `1.2.1` 及以上版本**,因为协议定义在 `1.2.1` 版本中才正式发布。
4642
- `local`: 使用当前包依赖中的本地协议定义。不建议使用,因为可能与发布版本不一致。
43+
- `--cdn`: 指定从哪个 CDN 获取协议定义,默认为 `unpkg`。可用值请使用 `milkygen list-cdns` 命令查看。
44+
45+
### 查看可用 generator
46+
47+
> 别名:`l`
48+
49+
```
50+
milkygen list
51+
```
52+
53+
### 查看可用 CDN
54+
55+
```
56+
milkygen list-cdns
57+
```
4758

4859
### 查看 CLI 版本
4960

‎generator/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@saltify/milky-generator",
33
"type": "module",
4-
"version": "0.3.0",
4+
"version": "0.3.1",
55
"description": "Milky codegen CLI",
66
"bin": {
77
"milkygen": "dist/cli.mjs"

‎generator/src/cli.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ const cmd = subcommands({
9191
cmds: {
9292
generate: command({
9393
name: 'generate',
94+
aliases: ['g', 'gen'],
9495
description: 'Generate a spec from Milky IR.',
9596
args: {
9697
generator: positional({
@@ -149,6 +150,7 @@ const cmd = subcommands({
149150
}),
150151
list: command({
151152
name: 'list',
153+
aliases: ['l'],
152154
description: 'List all available generators.',
153155
args: {},
154156
handler: () => {
@@ -171,6 +173,7 @@ const cmd = subcommands({
171173
}),
172174
version: command({
173175
name: 'version',
176+
aliases: ['v'],
174177
description: 'Print the version of milkygen.',
175178
args: {},
176179
handler: () => {

0 commit comments

Comments
 (0)