@czxingyu/xycomponents 0.1.3 → 0.1.5

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@czxingyu/xycomponents",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "bin": {
     "xycomponents": "dist/cli.js"
   },
@@ -9,7 +9,8 @@
     "components/style/*.css",
     "docs/maintenance/migrations/*.md",
     "global.d.ts",
-    "skills"
+    "skills",
+    "scripts/postinstall-skills.mjs"
   ],
   "type": "module",
   "sideEffects": [
@@ -161,6 +162,7 @@
     "fmt:check": "oxfmt --check",
     "generate:component": "node scripts/generate-component.mjs",
     "lint": "oxlint .",
+    "postinstall": "node scripts/postinstall-skills.mjs",
     "check": "pnpm run fmt:check && pnpm run lint && pnpm run type-check",
     "ci": "pnpm run check && pnpm test && pnpm run audit:components && pnpm run test:e2e && pnpm run build && pnpm run check:esm-import && pnpm run check:umd-contract && pnpm run check:bundle && pnpm run check:package && pnpm run check:packed-consumer",
     "release": "pnpm run ci && changeset publish",

package/scripts/postinstall-skills.mjs

@@ -0,0 +1,30 @@
+import { spawnSync } from "node:child_process";
+import { existsSync } from "node:fs";
+import { dirname, join } from "node:path";
+import { fileURLToPath } from "node:url";
+
+const packageRoot = join(dirname(fileURLToPath(import.meta.url)), "..");
+const cliEntry = join(packageRoot, "dist", "cli.js");
+const projectRoot = process.env.INIT_CWD || process.cwd();
+
+if (process.env.XYCOMPONENTS_SKIP_SKILLS_INSTALL === "1") {
+  process.exit(0);
+}
+
+if (!existsSync(cliEntry)) {
+  process.exit(0);
+}
+
+const result = spawnSync(
+  process.execPath,
+  [cliEntry, "skills", "install", "--consumer", "--json"],
+  {
+    cwd: projectRoot,
+    encoding: "utf8",
+    env: process.env,
+  },
+);
+
+if (result.status !== 0) {
+  process.exit(0);
+}

package/skills/README.md

@@ -1,6 +1,6 @@
 # xycomponents AI Skills
 
-面向 Cursor 等 AI Agent 的 Skill，配合项目内安装的 `@czxingyu/xycomponents` 使用。
+面向 Cursor、Claude Code、Codex 与其他读取 `AGENTS.md` 的 Agent。配合项目内安装的 `@czxingyu/xycomponents` 使用。
 
 ## 原则
 
@@ -8,12 +8,58 @@
 - **不要全局安装** CLI，避免 AI 查到与项目不一致的 API。
 - **Bug / 新组件**：业务项目 AI 用 `xycomponents-contribute` 提交 GitHub Issue；组件库维护者用 `xycomponents-maintainer` 集中分诊与修复。
 
+## 自动安装（推荐）
+
+安装组件库后，Skill 会**自动**写入当前项目（可用环境变量跳过）：
+
+```bash
+pnpm add @czxingyu/xycomponents
+# postinstall 会自动执行：pnpm exec xycomponents skills install --consumer --json
+```
+
+跳过自动安装：
+
+```bash
+XYCOMPONENTS_SKIP_SKILLS_INSTALL=1 pnpm add @czxingyu/xycomponents
+```
+
+手动重装 / 升级后同步 Skill：
+
+```bash
+pnpm exec xycomponents skills install --consumer --json
+```
+
+维护者额外安装 maintainer skill：
+
+```bash
+pnpm exec xycomponents skills install --maintainer --json
+```
+
+## 支持的 Agent 目录
+
+| 目标        | 目录              | 典型工具                            |
+| ----------- | ----------------- | ----------------------------------- |
+| `cursor`    | `.cursor/skills/` | Cursor                              |
+| `claude`    | `.claude/skills/` | Claude Code                         |
+| `codex`     | `.codex/skills/`  | Codex                               |
+| `agents`    | `.agents/skills/` | 通用 Agent 技能目录                 |
+| `AGENTS.md` | 项目根目录        | ChatGPT / 其他读取 AGENTS.md 的工具 |
+
+默认 `--target all` 会写入以上全部目录，并更新 `AGENTS.md` 引导块。
+
+只装 Cursor：
+
+```bash
+pnpm exec xycomponents skills install --consumer --target cursor
+```
+
 ## 完整闭环
 
 ```text
 业务项目                         组件库仓库 (vue3components)
 ────────                         ──────────────────────────
 pnpm add @czxingyu/xycomponents
+  └─ postinstall / skills install
 pnpm exec xycomponents ...  ──►   查用法 / API
        │
        ▼ Bug 或 Feature
@@ -24,21 +70,6 @@ gh issue create (contribute) ──►  needs-triage 队列
 pnpm add @新版本 ◄───────────────  关闭 Issue，注明版本
 ```
 
-## 安装 Skill 到业务项目
-
-复制 **`xycomponents-shared`**、**`xycomponents-cli`**、**`xycomponents-contribute`** 到 `.cursor/skills/`。
-
-```bash
-pnpm add @czxingyu/xycomponents
-cp -r node_modules/@czxingyu/xycomponents/skills/xycomponents-shared .cursor/skills/
-cp -r node_modules/@czxingyu/xycomponents/skills/xycomponents-cli .cursor/skills/
-cp -r node_modules/@czxingyu/xycomponents/skills/xycomponents-contribute .cursor/skills/
-```
-
-本仓库维护者额外启用 **`xycomponents-maintainer`**（已在 `.cursor/skills/`）。
-
-提交 Issue 需本机安装 [GitHub CLI](https://cli.github.com/) 并 `gh auth login`。
-
 ## Skill 列表
 
 | Skill                                                         | 谁用         | 用途                         |
@@ -48,6 +79,8 @@ cp -r node_modules/@czxingyu/xycomponents/skills/xycomponents-contribute .cursor
 | [xycomponents-contribute](./xycomponents-contribute/SKILL.md) | 业务项目     | 提交 Bug / Feature Issue     |
 | [xycomponents-maintainer](./xycomponents-maintainer/SKILL.md) | 组件库维护者 | 拉取 Issue、分诊、修复、发版 |
 
+提交 Issue 需本机安装 [GitHub CLI](https://cli.github.com/) 并 `gh auth login`。
+
 ## GitHub Issue 模板
 
 | 模板                                                 | 标签                          | 场景              |
@@ -57,8 +90,9 @@ cp -r node_modules/@czxingyu/xycomponents/skills/xycomponents-contribute .cursor
 
 用法问题优先 [Discussions](https://github.com/czhang31795/vue3components/discussions)。
 
-## 验证 CLI
+## 验证
 
 ```bash
 pnpm exec xycomponents doctor --json
+pnpm exec xycomponents skills install --consumer --dry-run --json
 ```

package/skills/xycomponents-shared/SKILL.md

@@ -15,6 +15,8 @@ metadata:
 ## 版本与 CLI 策略（必须遵守）
 
 - **只在当前项目内**安装 `@czxingyu/xycomponents`；**不要**全局安装 CLI，也不要用与项目 `package.json` 版本不一致的全局命令。
+- 安装组件库时会**自动**写入 Agent Skill（Cursor / Claude Code / Codex / `.agents/skills/` + `AGENTS.md`）。跳过：`XYCOMPONENTS_SKIP_SKILLS_INSTALL=1 pnpm add ...`
+- 手动重装或升级后同步：`pnpm exec xycomponents skills install --consumer --json`
 - CLI 元数据随 npm 包一起发布；**CLI 版本 = 已安装的包版本**。
 - 升级组件库时重新安装，CLI 会同步更新：