@mingfuyun/star-allinone 0.4.6 → 0.4.7
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/README.md +4 -3
- package/examples/AGENTS.md +2 -2
- package/package.json +1 -1
- package/skills/README.md +22 -10
- package/skills/shared/api-to-service/references/service-conventions.md +1 -1
- package/skills/shared/design-to-page/SKILL.md +1 -1
- package/skills/shared/design-to-page/references/page-conventions.md +1 -1
- package/skills/shared/project-conventions/references/review-checklist.md +1 -1
- package/skills/shared/review-and-submit/SKILL.md +1 -1
- package/skills/shared/review-and-submit/references/ai-review.md +1 -1
- package/skills/shared/review-and-submit/references/commit.md +1 -1
- package/skills/shared/review-and-submit/references/impact-analysis.md +1 -1
- package/skills/shared/review-and-submit/references/verify.md +1 -1
package/README.md
CHANGED
|
@@ -33,7 +33,8 @@ pnpm add @mingfuyun/star-allinone
|
|
|
33
33
|
AGENTS.md ← 常驻约定,不要加 .cursor/rules
|
|
34
34
|
.agents/skills/
|
|
35
35
|
├── shared-* ← npm 包同步,不能在业务项目直接改
|
|
36
|
-
|
|
36
|
+
├── custom-entry/ ← 可选:唯一对话入口 + references/project-rules.md
|
|
37
|
+
└── custom-* ← 其他业务特例(项目自己维护)
|
|
37
38
|
```
|
|
38
39
|
|
|
39
40
|
完整约定见 [skills/README.md](skills/README.md)。
|
|
@@ -91,7 +92,7 @@ StarLink 示例见 `examples/projects/`。
|
|
|
91
92
|
pnpm exec star-allinone skills sync
|
|
92
93
|
```
|
|
93
94
|
|
|
94
|
-
4.
|
|
95
|
+
4. 领域规则放 `.agents/skills/custom-entry/references/`。可用 `custom-entry` 做唯一对话编排入口(内部委托 `shared-*`)。不要再拆第二套审查/提交/发布/单接口/页面入口。全量契约重建(若需要)必须 `disable-model-invocation`,并在 `AGENTS.md` 写清命令。
|
|
95
96
|
|
|
96
97
|
5. 仓库根放 `AGENTS.md`(可从包内 `examples/AGENTS.md` 复制)。`skills sync` 只在该文件缺失时补一份,不会覆盖已有内容。常驻约定只写这一份,不要加 `.cursor/rules`。
|
|
97
98
|
|
|
@@ -128,7 +129,7 @@ git commit -m "chore(skill): 接入公共 skill"
|
|
|
128
129
|
使用 $shared-tracking,为本项目接入埋点并全站补齐按钮埋点。
|
|
129
130
|
```
|
|
130
131
|
|
|
131
|
-
公共流程用 `shared
|
|
132
|
+
公共流程用 `shared-*`;领域规则优先 `custom-entry/references/`。`custom-entry` 只编排、不复制 shared 正文。全量契约重建若需要,写成不可调用的脚本,并在 `AGENTS.md` 写命令。
|
|
132
133
|
|
|
133
134
|
### 业务项目:更新公共 skill
|
|
134
135
|
|
package/examples/AGENTS.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Agent instructions
|
|
2
2
|
|
|
3
|
-
This is a Umi Max + Ant Design 5 PC admin app. Shared skills live in `.agents/skills/shared-*` and are synced from `@mingfuyun/star-allinone`. Do not edit `shared-*`. Put project-only rules in `.agents/skills/custom
|
|
3
|
+
This is a Umi Max + Ant Design 5 PC admin app. Shared skills live in `.agents/skills/shared-*` and are synced from `@mingfuyun/star-allinone`. Do not edit `shared-*`. Put project-only rules in `.agents/skills/custom-entry/references/` (preferred) or legacy `.agents/project/`.
|
|
4
4
|
|
|
5
5
|
Always-on instructions are this file. Do not add `.cursor/rules`.
|
|
6
6
|
|
|
@@ -36,4 +36,4 @@ User-facing shared entries only:
|
|
|
36
36
|
- After TypeScript changes run `pnpm typecheck`.
|
|
37
37
|
- Do not treat `pnpm test` as unit tests unless that script actually runs a test runner.
|
|
38
38
|
- Heavy modules (`xlsx`, editors, charts) must be `import()`. Do not add them to `src/app.ts`.
|
|
39
|
-
-
|
|
39
|
+
- Prefer `.agents/skills/custom-entry/references/{project-rules,conventions}.md`; else legacy `.agents/project/{review-rules,conventions}.md`. Apply as additions only.
|
package/package.json
CHANGED
package/skills/README.md
CHANGED
|
@@ -18,21 +18,31 @@ business-app/
|
|
|
18
18
|
│ ├── shared-publish-test/
|
|
19
19
|
│ ├── shared-project-conventions/ ← 无 SKILL.md,给入口读
|
|
20
20
|
│ ├── shared-i-have-adhd/ ← 无 SKILL.md,给入口读
|
|
21
|
-
│
|
|
22
|
-
└──
|
|
23
|
-
|
|
24
|
-
|
|
21
|
+
│ ├── custom-entry/ ← 可选:唯一对话编排入口 + 领域规则正文
|
|
22
|
+
│ │ └── references/
|
|
23
|
+
│ │ ├── project-rules.md
|
|
24
|
+
│ │ └── conventions.md
|
|
25
|
+
│ └── custom-* ← 其他业务特例(如全量 swagger,勿再拆对外入口)
|
|
26
|
+
└── project/ ← legacy;openapi 等仍可放这里
|
|
25
27
|
└── openapi.json
|
|
26
28
|
```
|
|
27
29
|
|
|
28
30
|
命名约定:
|
|
29
31
|
|
|
30
32
|
```text
|
|
31
|
-
shared-*
|
|
32
|
-
custom
|
|
33
|
+
shared-* 公共内容,由 star-allinone 提供,经 CLI 同步后提交到业务仓库
|
|
34
|
+
custom-entry 可选唯一对话入口;领域规则正文在其 references/
|
|
35
|
+
custom-* 其他业务定制;禁止再做成第二套页面/审查/单接口生成入口
|
|
33
36
|
```
|
|
34
37
|
|
|
35
|
-
|
|
38
|
+
项目 overlay 探测顺序(存在则应用,只补充不削弱硬规则):
|
|
39
|
+
|
|
40
|
+
```text
|
|
41
|
+
review-rules: custom-entry/references/project-rules.md → legacy .agents/project/review-rules.md
|
|
42
|
+
conventions: custom-entry/references/conventions.md → legacy .agents/project/conventions.md
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
Cursor / Codex 的常驻说明只放仓库根 `AGENTS.md`(模板见 `examples/AGENTS.md`)。不要新增 `.cursor/rules`。
|
|
36
46
|
|
|
37
47
|
## npm 包的职责
|
|
38
48
|
|
|
@@ -55,7 +65,7 @@ Cursor / Codex 的常驻说明只放仓库根 `AGENTS.md`(模板见 `examples/
|
|
|
55
65
|
|
|
56
66
|
接入或升级后跑 `pnpm exec star-allinone doctor`。
|
|
57
67
|
|
|
58
|
-
|
|
68
|
+
领域差异优先写 `.agents/skills/custom-entry/references/`。`.agents/project/` 仍可放 OpenAPI 路径等 legacy 文件。项目文件可以补充,但不能削弱公共硬规则。
|
|
59
69
|
|
|
60
70
|
CLI 只做同步:
|
|
61
71
|
|
|
@@ -95,13 +105,15 @@ git commit -m "chore(skill): 更新公共 skill"
|
|
|
95
105
|
|
|
96
106
|
## 新增或修改业务定制
|
|
97
107
|
|
|
98
|
-
`custom
|
|
108
|
+
推荐用 `custom-entry` 做 **唯一对话编排入口**:先读本仓 `references/project-rules.md`(与可选 `conventions.md`),再 **Read 并执行** 对应 `shared-*`,不要复制 shared 正文。
|
|
109
|
+
|
|
110
|
+
其他 `custom-*` 只用于真正的业务特例:领域不变量、全量契约脚本、度量。不要再做成第二套审查/提交/测发/单接口/页面入口。
|
|
99
111
|
|
|
100
112
|
全量契约重建若必须留在 custom:加上 `disable-model-invocation: true`,在 `AGENTS.md` 写清要跑的命令,不要作为用户入口。度量类 custom 不得生成代码。
|
|
101
113
|
|
|
102
114
|
## 公共部分和业务定制组合
|
|
103
115
|
|
|
104
|
-
|
|
116
|
+
`custom-entry`(或其他 `custom-*`)复用公共流程时,**读取** 对应入口的 `SKILL.md` 并原样执行确认门。领域规则示例见 `examples/skills/custom-domain-invariants/`。
|
|
105
117
|
|
|
106
118
|
## 项目配置
|
|
107
119
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Service Conventions
|
|
2
2
|
|
|
3
|
-
Read `.star-allinone.json` first. `serviceDir` defaults to `src/services`.
|
|
3
|
+
Read `.star-allinone.json` first. `serviceDir` defaults to `src/services`. Prefer `.agents/skills/custom-entry/references/conventions.md`; else legacy `.agents/project/conventions.md`. Overlay extra domain paths only when that file exists.
|
|
4
4
|
|
|
5
5
|
## Layout
|
|
6
6
|
|
|
@@ -17,7 +17,7 @@ Before implementation, read:
|
|
|
17
17
|
4. `.agents/skills/shared-project-conventions/references/architecture.md`
|
|
18
18
|
5. [references/tracking.md](references/tracking.md) when `src/utils/tracking/index.ts` exists (or the project tracking path in conventions)
|
|
19
19
|
|
|
20
|
-
|
|
20
|
+
Prefer `.agents/skills/custom-entry/references/conventions.md`; else legacy `.agents/project/conventions.md`. If either exists, use it only for extra paths.
|
|
21
21
|
|
|
22
22
|
Inspect the nearest existing page of the same type before proposing files.
|
|
23
23
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Page Conventions
|
|
2
2
|
|
|
3
|
-
Read `.star-allinone.json` first. Use extra component paths or permission helpers
|
|
3
|
+
Read `.star-allinone.json` first. Prefer `.agents/skills/custom-entry/references/conventions.md`; else legacy `.agents/project/conventions.md`. Use extra component paths or permission helpers only when that file exists.
|
|
4
4
|
|
|
5
5
|
## Stack and locations
|
|
6
6
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Review Checklist
|
|
2
2
|
|
|
3
|
-
This checklist is complete for shared review and commit.
|
|
3
|
+
This checklist is complete for shared review and commit. Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, apply extra domain checks only; do not weaken the rules below.
|
|
4
4
|
|
|
5
5
|
## Permissions
|
|
6
6
|
|
|
@@ -9,7 +9,7 @@ User-facing entry for review, submit, and commit. Read the files under `referenc
|
|
|
9
9
|
|
|
10
10
|
This is the unified pre-submit entry and is fully shared. Do not mutate Git until the user confirms the exact reviewed scope.
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, apply extra domain checks only; do not weaken shared hard rules.
|
|
13
13
|
|
|
14
14
|
## Workflow
|
|
15
15
|
|
|
@@ -8,7 +8,7 @@ Review the current diff plus relevant callers and types. Before reviewing, read:
|
|
|
8
8
|
2. `.agents/skills/shared-project-conventions/references/quality-checklist.md`
|
|
9
9
|
3. `.agents/skills/shared-tracking/SKILL.md` and `.agents/skills/shared-design-to-page/references/tracking.md` when the project has tracking configured
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, apply extra domain checks only; do not weaken shared hard rules.
|
|
12
12
|
|
|
13
13
|
## Required checks
|
|
14
14
|
|
|
@@ -26,7 +26,7 @@ Read:
|
|
|
26
26
|
3. `.agents/skills/shared-project-conventions/references/architecture.md`
|
|
27
27
|
4. [ai-review.md](ai-review.md)
|
|
28
28
|
|
|
29
|
-
|
|
29
|
+
Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, apply extra domain checks only; do not weaken shared hard rules.
|
|
30
30
|
|
|
31
31
|
Classify only concrete security, data-loss, runtime, contract, validation, performance, accessibility, or maintainability risks as P0–P2.
|
|
32
32
|
|
|
@@ -11,7 +11,7 @@ Step 1 of `shared-review-and-submit`. Do not modify files.
|
|
|
11
11
|
5. Classify impact: direct callers, indirect pages, API/permission contracts, build/release risk.
|
|
12
12
|
6. Give a minimal automated and manual regression path for each item. An import is not proof of runtime impact.
|
|
13
13
|
|
|
14
|
-
Read `.agents/skills/shared-project-conventions/references/review-checklist.md` for shared files that must be expanded.
|
|
14
|
+
Read `.agents/skills/shared-project-conventions/references/review-checklist.md` for shared files that must be expanded. Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, also expand any extra domain files it names.
|
|
15
15
|
|
|
16
16
|
## Output
|
|
17
17
|
|
|
@@ -8,7 +8,7 @@ Read the current diff, related callers, and:
|
|
|
8
8
|
2. `.agents/skills/shared-project-conventions/references/architecture.md`
|
|
9
9
|
3. `.agents/skills/shared-tracking/SKILL.md` when the project has `src/utils/tracking/index.ts` (or the tracking path in project conventions)
|
|
10
10
|
|
|
11
|
-
Do not auto-fix.
|
|
11
|
+
Do not auto-fix. Prefer `.agents/skills/custom-entry/references/project-rules.md`; else legacy `.agents/project/review-rules.md`. If either exists, apply extra domain checks only.
|
|
12
12
|
|
|
13
13
|
## Checks
|
|
14
14
|
|