关于 angular-best-practices-rule-creator
这是一项 Agent 技能,用于按照项目约定新增 Angular 最佳实践规则或可选库技能。它指导文件放置、章节配置、内容结构和构建验证。
主要功能
- 01将规则前缀映射到章节和目录
- 02使用项目模板创建规则
- 03设定内容长度和代码块限制
- 04为可选技能更新配置
- 05构建生成的 AGENTS.md 文件
适用场景
- 01新增一条 Angular 最佳实践规则
- 02创建可选库技能及其初始规则
- 03配置变更后重新生成 AGENTS.md 文件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ alfredoperez/ angular-best-practices --skill angular-best-practices-rule-creator安装后在 Claude Code 中输入/angular-best-practices-rule-creator确认已加载。
详细介绍
规则创建 Agent
按照项目的确切规范创建新的 Angular 最佳实践规则和可选库技能。
能力
1. 创建新规则
收到创建规则的请求时:
- 根据规则文件名确定前缀(例如,
material-imports.md→ 前缀material) - 在
packages/angular-best-practices-build/src/config.ts→sectionMap中查找章节编号 - 根据前缀将文件放入正确的
rules/子目录:test-*→rules/testing/a11y-*、ui-*、loading-*、dialogs-*、theming-*→rules/ui/http-*、mapper-*→rules/data/ts-*→rules/typescript/opt-*、bundle-*、async-*→rules/optimization/arch-*→rules/core/- 其他所有前缀(signals、components、forms、rxjs、ngrx、material、primeng、spartan、transloco 等)→
rules/angular/
- 从
rules/_template.md复制模板 - 按照以下规则填写 frontmatter 和内容:
- 标题: 动词 + 主体(例如,“使用 Signal 输入”)
- 描述: 最多 1 句话
- 代码块: 最多 0-2 个(错误示例 + 正确示例,或仅正确示例)
- 每个代码块的代码: 最多 3-5 行
- 总长度: 少于 50 行(理想长度为 30-40 行)
- 禁止包含安装命令、配置转储或文件夹结构
- 使用
angular-best-practices-rules-reviewer技能进行验证
2. 创建新库技能
收到创建新的可选库技能的请求时:
- 选择下一个可用的章节编号(检查 config.ts 中的
SECTION_TITLES) - 更新
packages/angular-best-practices-build/src/config.ts:- 在
sectionMap中添加前缀 → 章节编号 - 在
SECTION_TITLES中添加章节标题 - 在
SECTION_IMPACTS中添加章节影响 - 在
OPTIONAL_SKILLS数组中添加条目
- 在
- 在
rules/_sections.md中添加章节定义 - 创建带有 frontmatter(name、description、metadata、tags、globs)的
skills/<skill-name>/SKILL.md。阅读.claude/skills/angular-best-practices-rules-reviewer/references/skill-best-practices.md,了解 SKILL.md 的质量标准。 - 在
rules/angular/中创建带有该技能前缀的初始规则文件 - 运行
npm run build以生成 AGENTS.md 文件
前缀 → 章节映射(当前)
| 前缀 | 章节 | 标题 |
|---|---|---|
async, opt-async | 1 | 消除瀑布流 |
bundle | 2 | 优化 Bundle |
opt, performance | 3 | JavaScript 性能 |
ts | 4 | TypeScript 最佳实践 |
signal | 5 | Signals 与响应性 |
component | 6 | 组件模式 |
rxjs | 7 | RxJS 模式 |
cd | 8 | 变更检测 |
template | 9 | 模板优化 |
ssr | 10 | SSR 与水合 |
form | 11 | 表单 |
ngrx | 12 | NgRx 状态管理 |
signalstore | 13 | SignalStore |
tanstack | 14 | TanStack Query |
arch | 15 | 架构 |
test | 16 | 测试 |
core, di, error-handling, observability, pattern, routing, security | 17 | 基础设施 |
ui, a11y, loading, dialogs, theming | 18 | UI 与无障碍 |
http, mapper | 19 | 数据处理 |
material | 20 | Angular Material |
primeng | 21 | PrimeNG |
spartan | 22 | Spartan UI |
transloco | 23 | 国际化 |
文件放置位置
| 子目录 | 前缀 |
|---|---|
rules/angular/ | signal、component、rxjs、cd、template、ssr、form、ngrx、signalstore、tanstack、material、primeng、spartan、transloco |
rules/testing/ | test |
rules/ui/ | ui、a11y、loading、dialogs、theming |
rules/typescript/ | ts |
rules/optimization/ | opt、bundle、async、performance |
rules/core/ | arch、core、di、error-handling、observability、pattern、routing、security |
rules/data/ | http、mapper |
模板参考
---
title: Verb + Subject
impact: MEDIUM
impactDescription: Brief metric (e.g., "2-10x faster", "O(n) to O(1)")
tags: tag1, tag2
---
## Verb + Subject
One sentence explaining the rule.
**Incorrect:**
\`\`\`typescript
// 3-5 lines max
\`\`\`
**Correct:**
\`\`\`typescript
// 3-5 lines max
\`\`\`
构建命令
npm run build # Regenerate all AGENTS.md files
npm run build:skip-validation # Skip validation during development
评论
支持 Markdown