@ultime/cli 0.1.2 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +5 -0
- package/CONTRIBUTING.md +20 -5
- package/README.md +2 -0
- package/SKILLS.md +42 -0
- package/dist/index.js +6 -5
- package/llms.txt +16 -0
- package/package.json +4 -2
- package/src/args.ts +6 -5
package/CHANGELOG.md
CHANGED
package/CONTRIBUTING.md
CHANGED
|
@@ -2,18 +2,33 @@
|
|
|
2
2
|
|
|
3
3
|
> 给贡献者与 AI 的最短协作规则。命令见 [README](./README.md)。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## Git 流程
|
|
6
6
|
|
|
7
|
-
1. 从 `main` 切 `feat/<主题>` / `fix
|
|
8
|
-
2.
|
|
9
|
-
3.
|
|
7
|
+
1. 从 `main` 切 `feat/<主题>` / `fix/<主题>` / `docs-<主题>`。
|
|
8
|
+
2. 开发完成后 `git rebase main`;一次提交一件事,提交信息用 `type(scope): subject`。
|
|
9
|
+
3. push 分支并开 PR;CI 必须通过,评论必须解决。
|
|
10
|
+
4. 用 rebase / squash 合并,删除分支;`main` 不保留中间提交。
|
|
11
|
+
5. 不直接 push `main`,不 force push、不删除 `main`;`main` 受保护,管理员也一样。
|
|
12
|
+
6. 发布按包版本打 tag,由 CI 执行;tag 规则见仓库保护设置。
|
|
10
13
|
|
|
11
14
|
## 改动规则
|
|
12
15
|
|
|
13
16
|
- CLI 只做参数 / 路径 / IO / 退出码;配置合法性与产物内容归调用方包。
|
|
14
17
|
- 不 import 任何调用方包的源码,只通过公开包名与 exports 依赖。
|
|
15
18
|
- 不自维护具体项目的字段清单;`schema` 之类由调用方投影。
|
|
16
|
-
- 新增命令或退出码:同步 README、`
|
|
19
|
+
- 新增命令或退出码:同步 README、`SKILLS.md`、测试与版本戳。
|
|
20
|
+
|
|
21
|
+
## Review
|
|
22
|
+
|
|
23
|
+
提交 PR 前自查五件事:
|
|
24
|
+
|
|
25
|
+
- **文档**:README / 用法 / 示例是否仍准确;链接、版本、CHANGELOG 是否同步。
|
|
26
|
+
- **注释**:只写为什么、约束、反直觉处;不复述代码。
|
|
27
|
+
- **冗余**:同一事实只有一份正文;新增说明先改真源,其他位置只留指针。
|
|
28
|
+
- **缺漏**:新增能力是否有入口、示例与验证命令。
|
|
29
|
+
- **漂移**:`package.json` / README / `CHANGELOG` / VERSION(及适用的 AI 文档)版本是否一致。
|
|
30
|
+
|
|
31
|
+
机械检查交给 CI;人审看架构、边界、语义与取舍。
|
|
17
32
|
|
|
18
33
|
## 验证
|
|
19
34
|
|
package/README.md
CHANGED
|
@@ -44,6 +44,8 @@ process.exitCode = runCli(spec, process.argv.slice(2), processContext())
|
|
|
44
44
|
|
|
45
45
|
`parseArgs` 只认 `command`、`--flag`、`--key value` / `--key=value`;`-h/--help` 与 `-v/--version` 是保留 flag。
|
|
46
46
|
|
|
47
|
+
AI 入口:[`llms.txt`](./llms.txt)(路由)与 [`SKILLS.md`](./SKILLS.md)(能力表)随包发布。
|
|
48
|
+
|
|
47
49
|
## 边界
|
|
48
50
|
|
|
49
51
|
- **零领域依赖**:不 import 任何领域包,也不认识具体业务对象。
|
package/SKILLS.md
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# @ultime/cli · 可调用能力
|
|
2
|
+
|
|
3
|
+
> 定位:AI 可调用的通用命令设施。领域命令不在这里。
|
|
4
|
+
> 适用版本:0.1.x
|
|
5
|
+
> 同步基线:0.1.x(手写;API 变化时同批更新)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## 入口
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
import { parseArgs, runCli, processContext } from '@ultime/cli'
|
|
13
|
+
import type { ParsedArgs, CliContext, CliSpec, CommandSpec } from '@ultime/cli'
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
| 能力 | 输入 | 输出 |
|
|
17
|
+
|---|---|---|
|
|
18
|
+
| `parseArgs(argv)` | 字符串数组 | `{ command, flags, positional }` |
|
|
19
|
+
| `runCli(spec, argv, ctx?)` | `CliSpec` + 参数 | 退出码;版本 / 帮助 / 未知命令 / 异常由它处理 |
|
|
20
|
+
| `processContext()` | — | `{ cwd, out, err }` |
|
|
21
|
+
|
|
22
|
+
## `CliSpec`
|
|
23
|
+
|
|
24
|
+
```ts
|
|
25
|
+
{
|
|
26
|
+
name: string
|
|
27
|
+
version: string
|
|
28
|
+
usage: string
|
|
29
|
+
commands: Record<string, { help?: string; run(args, ctx): number }>
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## 错误语义
|
|
34
|
+
|
|
35
|
+
- 未知命令:`err` 写错误,`out` 写 usage,返回 1;
|
|
36
|
+
- 命令抛异常:`err` 写 message,返回 1;
|
|
37
|
+
- 版本 / 帮助:返回 0,不执行命令。
|
|
38
|
+
|
|
39
|
+
## 反例
|
|
40
|
+
|
|
41
|
+
- 把 `--check` 当成 cli 内置 flag:它属于调用方的命令。
|
|
42
|
+
- 在 cli 里读具体项目配置:IO 与配置语义属于调用方命令。
|
package/dist/index.js
CHANGED
|
@@ -14,16 +14,17 @@ function parseArgs(argv) {
|
|
|
14
14
|
continue;
|
|
15
15
|
}
|
|
16
16
|
if (token.startsWith("--")) {
|
|
17
|
-
const
|
|
18
|
-
|
|
19
|
-
|
|
17
|
+
const body = token.slice(2);
|
|
18
|
+
const equal = body.indexOf("=");
|
|
19
|
+
if (equal !== -1) {
|
|
20
|
+
flags[body.slice(0, equal)] = body.slice(equal + 1);
|
|
20
21
|
continue;
|
|
21
22
|
}
|
|
22
23
|
const next = argv[i + 1];
|
|
23
24
|
if (next && !next.startsWith("-")) {
|
|
24
|
-
flags[
|
|
25
|
+
flags[body] = next;
|
|
25
26
|
i += 1;
|
|
26
|
-
} else flags[
|
|
27
|
+
} else flags[body] = true;
|
|
27
28
|
continue;
|
|
28
29
|
}
|
|
29
30
|
if (!command) command = token;
|
package/llms.txt
ADDED
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# @ultime/cli · AI 索引
|
|
2
|
+
|
|
3
|
+
适用版本:0.1.x
|
|
4
|
+
|
|
5
|
+
## 去哪找
|
|
6
|
+
|
|
7
|
+
- 怎么用:[README.md](./README.md)
|
|
8
|
+
- 可调用能力:[SKILLS.md](./SKILLS.md)
|
|
9
|
+
|
|
10
|
+
## 机器入口
|
|
11
|
+
|
|
12
|
+
- 公共出口:`@ultime/cli` 的 `parseArgs` / `runCli` / `processContext` 与类型。
|
|
13
|
+
|
|
14
|
+
## 边界
|
|
15
|
+
|
|
16
|
+
- 通用设施,不含任何领域命令;读盘写盘归调用方。
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ultime/cli",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "Ultime · cli:通用命令行设施(参数 / 命令注册 / 上下文 / 退出码),零领域依赖",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"argument-parser",
|
|
@@ -24,6 +24,8 @@
|
|
|
24
24
|
"dist",
|
|
25
25
|
"src",
|
|
26
26
|
"README.md",
|
|
27
|
+
"llms.txt",
|
|
28
|
+
"SKILLS.md",
|
|
27
29
|
"CHANGELOG.md",
|
|
28
30
|
"CONTRIBUTING.md",
|
|
29
31
|
"SECURITY.md"
|
|
@@ -49,7 +51,7 @@
|
|
|
49
51
|
"@types/node": "^22.20.5",
|
|
50
52
|
"tsx": "^4.23.15",
|
|
51
53
|
"typescript": "^5.9.3",
|
|
52
|
-
"vite-plus": "1.
|
|
54
|
+
"vite-plus": "1.5.1"
|
|
53
55
|
},
|
|
54
56
|
"engines": {
|
|
55
57
|
"node": ">=22.18"
|
package/src/args.ts
CHANGED
|
@@ -27,17 +27,18 @@ export function parseArgs(argv: string[]): ParsedArgs {
|
|
|
27
27
|
continue
|
|
28
28
|
}
|
|
29
29
|
if (token.startsWith('--')) {
|
|
30
|
-
const
|
|
31
|
-
|
|
32
|
-
|
|
30
|
+
const body = token.slice(2)
|
|
31
|
+
const equal = body.indexOf('=')
|
|
32
|
+
if (equal !== -1) {
|
|
33
|
+
flags[body.slice(0, equal)] = body.slice(equal + 1)
|
|
33
34
|
continue
|
|
34
35
|
}
|
|
35
36
|
const next = argv[i + 1]
|
|
36
37
|
if (next && !next.startsWith('-')) {
|
|
37
|
-
flags[
|
|
38
|
+
flags[body] = next
|
|
38
39
|
i += 1
|
|
39
40
|
} else {
|
|
40
|
-
flags[
|
|
41
|
+
flags[body] = true
|
|
41
42
|
}
|
|
42
43
|
continue
|
|
43
44
|
}
|