@yottameta/yotta-code-quality 0.3.3 → 0.3.4

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.
Files changed (5) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/README.md +27 -38
  3. package/README.zh-CN.md +29 -41
  4. package/SKILL.md +1 -1
  5. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # 更新日志
2
2
 
3
+ ## v0.3.4 (2026-08-29)
4
+
5
+ - 安装方式统一为四方式（对齐发布规范 §3.3.1）：方式一 `npx -y @yottameta/yotta-code-quality --agent <name>` / `--dir <dir>`（推荐，走 npm 源）；方式二 `git clone https://github.com/YottaMeta/yotta-code-quality.git`；方式三 GitHub Download ZIP；方式四 `bash install.sh --agent/--dir/--list`。移除 `npx skills` 与 `-g` 推荐；中英双 README 安装节同步。
6
+ - 版本对齐：package.json / SKILL.md / CHANGELOG / 引擎 VERSION / 测试断言 / README 锚点 = 0.3.4。
7
+ - 无功能变更（仅文档与版本同步）。
8
+
3
9
  ## v0.3.3 (2026-08-28)
4
10
 
5
11
  中英双语 README 对齐（老张拍板「英文门面 + 中文全档」）：
package/README.md CHANGED
@@ -144,50 +144,39 @@ yotta-code-quality/
144
144
 
145
145
  ## Install
146
146
 
147
- Pick any one of the three methods; skill files are fetched from **npm** (GitHub is slower without a proxy; npm can use a domestic mirror).
147
+ Pick any of the four methods below; the order is the recommended priority. Skill files always come from **npm** (GitHub can be slow without a proxy; npm supports mirrors).
148
148
 
149
- ### Method 1: npm (recommended, one-liner)
150
- ```bash
151
- # domestic mirror (optional): npm config set registry https://registry.npmmirror.com
152
- npx -y @yottameta/yotta-code-quality -g
153
- npx -y @yottameta/yotta-code-quality --dir <your-skills-dir> # any agent: install to a specific directory
149
+ ### Method 1: npm one-liner (recommended)
150
+
151
+ ```text
152
+ # Optional China mirror: npm config set registry https://registry.npmmirror.com
153
+ npx -y @yottameta/yotta-code-quality --agent <agent-name> # install to the agent's default user-level skills dir
154
+ npx -y @yottameta/yotta-code-quality --dir <your-skills-dir> # point to the skills dir itself (e.g. ~/.codex/skills)
154
155
  ```
155
- > Not in the preset list? Use --dir to point at the agent's skills directory, or manual copy (method 3). --list shows each agent's default directory. You can also npm pack @yottameta/yotta-code-quality and unpack it to install via method 2 / 3.
156
156
 
157
- ### Method 2: install.sh one-shot
158
- ```bash
159
- bash install.sh -g # user level; bash install.sh --list shows all directories
160
- bash install.sh --agent codex # specific agent (--list shows available ones)
161
- bash install.sh # project level: auto-detect existing .claude/.cursor/.codex skills dirs
162
- bash install.sh --dir /path/to/skills
157
+ - `--agent <name>` installs to that agent's default user-level directory; `--list` shows each agent's default directory.
158
+ - `--dir <path>` installs to the given directory; for agents not in the preset list, point `--dir` at their skills directory.
159
+ - If the mirror has not synced the new package (404): add `--registry=https://registry.npmjs.org/` (a proxy may be needed in China), or wait for the mirror cache.
160
+
161
+ ### Method 2: git clone (developers / git available)
162
+
163
+ ```text
164
+ git clone https://github.com/YottaMeta/yotta-code-quality.git <your-skills-dir>/yotta-code-quality
163
165
  ```
164
- > Covers 17 agent families including Trae / Qwen / Comate / CodeBuddy / Kimi. Windows users: works with Git Bash; otherwise use method 3.
165
166
 
166
- ### Method 3: manual copy
167
- Copy the whole `yotta-code-quality` folder into the target agent's skills directory. Common locations (user level; Windows uses %USERPROFILE%, Linux/macOS uses ~):
167
+ ### Method 3: GitHub Download ZIP (manual / no git)
168
168
 
169
- | Agent | User-level directory | Project-level directory |
170
- |---|---|---|
171
- | Codex | %USERPROFILE%\.codex\skills\yotta-code-quality\ | .codex\skills\ |
172
- | Claude Code | %USERPROFILE%\.claude\skills\yotta-code-quality\ | .claude\skills\ |
173
- | Cursor | %USERPROFILE%\.cursor\skills\yotta-code-quality\ | .cursor\skills\ |
174
- | Windsurf | %USERPROFILE%\.codeium\windsurf\skills\yotta-code-quality\ | .windsurf\skills\ |
175
- | opencode | %USERPROFILE%\.config\opencode\skills\yotta-code-quality\ | .opencode\skills\ |
176
- | Gemini | %USERPROFILE%\.gemini\skills\yotta-code-quality\ | .gemini\skills\ |
177
- | Goose | %USERPROFILE%\.config\goose\skills\yotta-code-quality\ | .goose\skills\ |
178
- | Amp | %USERPROFILE%\.config\agents\skills\yotta-code-quality\ | .agents\skills\ |
179
- | Kiro | %USERPROFILE%\.kiro\skills\yotta-code-quality\ | .kiro\skills\ |
180
- | WorkBuddy | %USERPROFILE%\.workbuddy\skills\yotta-code-quality\ | .workbuddy\skills\ |
181
- | Trae Code CLI | %USERPROFILE%\.traecli\skills\yotta-code-quality\ | .traecli\skills\ |
182
- | Trae IDE (CN) | %USERPROFILE%\.trae-cn\skills\yotta-code-quality\ | .trae\skills\ |
183
- | Qwen Code | %USERPROFILE%\.qwen\skills\yotta-code-quality\ | .qwen\skills\ |
184
- | Comate | %USERPROFILE%\.comate\skills\yotta-code-quality\ | .comate\skills\ |
185
- | CodeBuddy | %USERPROFILE%\.codebuddy\skills\yotta-code-quality\ | .codebuddy\skills\ |
186
- | Kimi | %USERPROFILE%\.kimi\skills\yotta-code-quality\ | .kimi\skills\ |
187
- | Generic AGENTS.md | %USERPROFILE%\.agents\skills\yotta-code-quality\ | .agents\skills\ |
188
-
189
- > If Codex's CODEX_HOME is set, it overrides the default; the same applies to opencode's XDG_CONFIG_HOME. .agents\skills is not a universal directory — only OpenCode / Cursor / Cline / Amp / Kimi / Gemini CLI / GitHub Copilot etc. read it; **Claude Code and Codex do not read it by default**. When unsure, use --dir or let the agent install it.
169
+ On the GitHub repository `YottaMeta/yotta-code-quality`, click **Code → Download ZIP**, unzip it and put the `yotta-code-quality` folder into the agent's skills directory.
170
+
171
+ ### Method 4: install.sh (multi-agent one-liner script)
172
+
173
+ ```text
174
+ bash install.sh --agent <name> # install to the agent's default user-level directory
175
+ bash install.sh --dir <path> # install to the given directory
176
+ bash install.sh --list # list agents -> default directories
177
+ ```
190
178
 
179
+ > Method 1 uses the npm registry (npmmirror / npmjs) and does not depend on GitHub; Methods 2/3 use GitHub and may fail without a proxy in China.
191
180
  ## Usage
192
181
 
193
182
  Say "review this PR", "结对评审" or "发版前扫一眼" in conversation, or call `/yotta-code-quality` directly. Optional flags are listed above.
@@ -216,7 +205,7 @@ Agent: PR mode → .code-quality.yaml config → auto scope → 7 steps in pr-re
216
205
 
217
206
  ## Upgrade / uninstall
218
207
 
219
- - **Upgrade**: rerun the install command to overwrite with the latest (npm: `npx -y @yottameta/yotta-code-quality -g`; install.sh: rerun inside the skill folder). Version is on npm.
208
+ - **Upgrade**: reinstall the latest version to overwrite — rerun the install command you used (e.g. `npx -y @yottameta/yotta-code-quality --agent <name>` or `bash install.sh --agent <name>`). Old files in the skill directory are replaced; other project files are untouched.
220
209
  - **Uninstall**: delete the `yotta-code-quality/` folder under the target agent's skills directory.
221
210
  - **No side effects**: the skill writes nothing outside the project; the optional trend file (`.code-quality-history.json`) is only generated when you enable `history: true`, at the repo root.
222
211
 
package/README.zh-CN.md CHANGED
@@ -157,51 +157,39 @@ yotta-code-quality/
157
157
 
158
158
  ## 安装
159
159
 
160
- 三种方式任选其一，技能文件统一从 **npm** 获取（GitHub 无代理时较慢，npm 可配国内镜像加速）。
160
+ 以下四种方式任选，顺序即推荐优先级；技能文件一律从 **npm** 获取（GitHub 无代理较慢，npm 支持镜像）。
161
161
 
162
- ### 方式一：npm（推荐，一行安装）
163
- ```bash
164
- # 国内加速（可选）：npm config set registry https://registry.npmmirror.com
165
- npx -y @yottameta/yotta-code-quality -g
166
- npx -y @yottameta/yotta-code-quality --dir <你的技能目录> # 任意智能体：指定目录安装
162
+ ### 方式一：npm 一行装（推荐）
163
+
164
+ ```text
165
+ # 可选国内加速：npm config set registry https://registry.npmmirror.com
166
+ npx -y @yottameta/yotta-code-quality --agent <智能体名称> # 装到指定智能体默认用户级技能目录
167
+ npx -y @yottameta/yotta-code-quality --dir <智能体的技能目录> # 指到技能目录本身（如 ~/.codex/skills）
167
168
  ```
168
- > 智能体不在预置列表？用 `--dir` 指定它的 skills 目录，或手动复制（方式三）。`--list` 可查看各智能体对应的默认目录。想手动拿文件也可 `npm pack @yottameta/yotta-code-quality` 解包后按方式二/三安装。
169
169
 
170
- ### 方式二：install.sh 一键安装
171
- 获取技能文件夹后（`npm pack` 解包或 `git clone`），进入技能文件夹：
172
- ```bash
173
- bash install.sh -g # 用户级；bash install.sh --list 查看全部目录
174
- bash install.sh --agent codex # 指定智能体（--list 可查看可用项）
175
- bash install.sh # 项目级：自动检测已存在的 .claude/.cursor/.codex 等 skills 目录
176
- bash install.sh --dir /path/to/skills
170
+ - `--agent <name>` 自动装到该智能体默认用户级目录；`--list` 可查看各智能体默认目录。
171
+ - `--dir <路径>` 装到指定的技能目录；未收录的智能体用 `--dir` 指到它的技能目录。
172
+ - npmmirror 未同步新包（404）：加 `--registry=https://registry.npmjs.org/`（国内需代理），或稍等镜像缓存。
173
+
174
+ ### 方式二：git clone（开发者 / 有 git 环境）
175
+
176
+ ```text
177
+ git clone https://github.com/YottaMeta/yotta-code-quality.git <智能体的技能目录>/yotta-code-quality
178
+ ```
179
+
180
+ ### 方式三：GitHub 下载压缩包（手动 / 无 git 环境）
181
+
182
+ 在 GitHub 仓库 `YottaMeta/yotta-code-quality` 点 **Code → Download ZIP**，解压后把 `yotta-code-quality` 文件夹放进智能体技能目录。
183
+
184
+ ### 方式四：install.sh（多智能体一键脚本）
185
+
186
+ ```text
187
+ bash install.sh --agent <name> # 装到指定智能体默认用户级目录
188
+ bash install.sh --dir <path> # 装到指定目录
189
+ bash install.sh --list # 列出智能体 -> 默认目录
177
190
  ```
178
- > Windows 用户：装有 Git Bash 即可用；否则用方式三手动复制。
179
-
180
- ### 方式三：手动复制
181
- 把整个 `yotta-code-quality` 文件夹复制到目标智能体的 skills 目录。常见位置（用户级；Windows 用 `%USERPROFILE%`，Linux/macOS 用 `~`）：
182
-
183
- | 智能体 | 用户级目录 | 项目级目录 |
184
- |---|---|---|
185
- | Codex | `%USERPROFILE%\.codex\skills\yotta-code-quality\` | `.codex\skills\` |
186
- | Claude Code | `%USERPROFILE%\.claude\skills\yotta-code-quality\` | `.claude\skills\` |
187
- | Cursor | `%USERPROFILE%\.cursor\skills\yotta-code-quality\` | `.cursor\skills\` |
188
- | Windsurf | `%USERPROFILE%\.codeium\windsurf\skills\yotta-code-quality\` | `.windsurf\skills\` |
189
- | opencode | `%USERPROFILE%\.config\opencode\skills\yotta-code-quality\` | `.opencode\skills\` |
190
- | Gemini | `%USERPROFILE%\.gemini\skills\yotta-code-quality\` | `.gemini\skills\` |
191
- | Goose | `%USERPROFILE%\.config\goose\skills\yotta-code-quality\` | `.goose\skills\` |
192
- | Amp | `%USERPROFILE%\.config\agents\skills\yotta-code-quality\` | `.agents\skills\` |
193
- | Kiro | `%USERPROFILE%\.kiro\skills\yotta-code-quality\` | `.kiro\skills\` |
194
- | WorkBuddy | `%USERPROFILE%\.workbuddy\skills\yotta-code-quality\` | `.workbuddy\skills\` |
195
- | Trae Code CLI | `%USERPROFILE%\.traecli\skills\yotta-code-quality\` | `.traecli\skills\` |
196
- | Trae IDE（国内） | `%USERPROFILE%\.trae-cn\skills\yotta-code-quality\` | `.trae\skills\` |
197
- | Qwen Code | `%USERPROFILE%\.qwen\skills\yotta-code-quality\` | `.qwen\skills\` |
198
- | Comate | `%USERPROFILE%\.comate\skills\yotta-code-quality\` | `.comate\skills\` |
199
- | CodeBuddy | `%USERPROFILE%\.codebuddy\skills\yotta-code-quality\` | `.codebuddy\skills\` |
200
- | Kimi | `%USERPROFILE%\.kimi\skills\yotta-code-quality\` | `.kimi\skills\` |
201
- | 通用 AGENTS.md | `%USERPROFILE%\.agents\skills\yotta-code-quality\` | `.agents\skills\` |
202
-
203
- > Codex 默认目录若设置了环境变量 `CODEX_HOME`，以该变量为准；opencode 若设置 `XDG_CONFIG_HOME` 同理。`.agents\skills` 并非通用目录，仅 OpenCode / Cursor / Cline / Amp / Kimi / Gemini CLI / GitHub Copilot 等会读取，**Claude Code 与 Codex 默认不读**。不确定时用 `--dir` 指定，或让该智能体自行安装。
204
191
 
192
+ > 方式一走 npm 源（npmmirror / npmjs），不依赖 GitHub；方式二 / 三走 GitHub，国内无代理可能失败。
205
193
  ## 使用
206
194
 
207
195
  对话中说「review this PR」「结对评审」「发版前扫一眼」，或直接调用 `/yotta-code-quality`。可选参数见上文「可选参数」。
@@ -230,7 +218,7 @@ bash install.sh --dir /path/to/skills
230
218
 
231
219
  ## 升级与卸载
232
220
 
233
- - **升级**：重新执行一次安装命令即可覆盖为最新版（npm 方式：`npx -y @yottameta/yotta-code-quality -g`；install.sh 方式：重新在技能文件夹运行）。版本号见 npm。
221
+ - **升级**：重新安装最新版覆盖即可——重跑你用的安装命令（如 `npx -y @yottameta/yotta-code-quality --agent <name>` 或 `bash install.sh --agent <name>`）。技能目录内旧文件会被替换；不影响项目中其他文件。
234
222
  - **卸载**：删除目标智能体 skills 目录下的 `yotta-code-quality/` 文件夹即可。
235
223
  - **无副作用**：技能不写项目外文件；可选的历史/趋势文件（`.code-quality-history.json`）只在你开启 `history: true` 时生成，位于仓库根。
236
224
 
package/SKILL.md CHANGED
@@ -9,7 +9,7 @@ description: >-
9
9
  「结对评审」/「发版前扫一眼」/ yotta-code-quality.
10
10
  Do NOT trigger for: greenfield "how do I write X" with no code, pure syntax questions,
11
11
  or tool/framework questions with no shared code.
12
- version: 0.3.3
12
+ version: 0.3.4
13
13
  license: MIT
14
14
  ---
15
15
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@yottameta/yotta-code-quality",
3
- "version": "0.3.3",
3
+ "version": "0.3.4",
4
4
  "description": "Pair-style code quality reviewer: twelve book-grounded decay risks (R1-R6, T1-T6) plus release-safety and first-paint UX checks; Iron Law findings (Symptom -> Source -> Consequence -> Remedy) and 0-100 Health Score.",
5
5
  "license": "MIT",
6
6
  "keywords": [