@cowave-front/ai

@cowave-front/ai 负责安装和同步脚手架内置 AI 开发规范，使 Codex、Claude Code、Gemini、Cursor、Windsurf、GitHub Copilot 等工具都能读取同一套项目规则。

普通业务开发者一般不需要直接使用本包，推荐使用 cowave-front create --ai-skills 或 cowave-front ai sync。

当前能力

• 把内置 .ai 规则模板安装到生成项目。
• 根据选择的 UI 风格注入对应的 AI UI 规则。
• 从 .ai/rules/*.md 生成不同 AI 编程工具能识别的入口文件。
• 保留 .ai/manifest.json 作为规则索引。

支持的 AI 工具

| 工具 | 输出文件 | | --- | --- | | Codex | AGENTS.md | | Claude Code | CLAUDE.md | | Gemini CLI | GEMINI.md | | Cursor | .cursor/rules/*.mdc | | Windsurf | .windsurf/rules/*.md | | GitHub Copilot | .github/copilot-instructions.md 和 .github/instructions/*.instructions.md |

安装

npm install @cowave-front/ai

使用示例

import { installAiSkillPreset, syncAiRules } from '@cowave-front/ai'

await installAiSkillPreset({
  cwd: 'D:/project/demo-front',
  sourceDir: 'D:/project/cowave-front-cli/templates/ai-skills/default',
  projectName: 'demo-front',
  packageName: 'demo-front',
  stylePreset: 'deep-blue-tech',
  stylePresetLabel: '深蓝科技风',
  stylePresetDescription: '深蓝底色搭配蓝青色高亮',
  force: true
})

await syncAiRules({
  cwd: 'D:/project/demo-front',
  targets: ['codex', 'claude', 'cursor']
})

主要 API

installAiSkillPreset(options)

把脚手架内置 AI 规则安装到项目的 .ai 目录。

常用参数：

• cwd：目标项目根目录。
• sourceDir：AI 规则模板目录。
• projectName：项目目录名。
• packageName：项目 package name。
• stylePreset：当前 UI 风格。
• stylePresetLabel：UI 风格中文名称。
• stylePresetDescription：UI 风格说明。
• force：如果 .ai 已存在，是否覆盖。

syncAiRules(options)

从 .ai/rules/*.md 生成各 AI 工具入口文件。

常用参数：

• cwd：目标项目根目录。
• targets：要同步的 AI 工具列表。
• logger：可选日志输出器。

aiToolDefinitions

AI 工具定义列表，供 CLI 交互选择使用。

开发命令

corepack pnpm --filter @cowave-front/ai build
corepack pnpm --filter @cowave-front/ai test
corepack pnpm --filter @cowave-front/ai typecheck