mirror of
https://github.com/addyosmani/agent-skills.git
synced 2026-10-26 15:05:04 +00:00
Merge main: keep both the persona-lint and frontmatter tests
This commit is contained in:
commit
ff335f2184
11 files changed
+237
-6
No files matched your search
@@ -100,7 +100,7 @@ claude --plugin-dir /path/to/agent-skills
|
||||
<details>
|
||||
<summary><b>Cursor</b></summary>
|
||||
|
||||
Put workflow skills under `.cursor/skills/` (sync from `agent-skills/skills/`) and short policies in `.cursor/rules/*.mdc` — do not paste full skills into rules. See [docs/cursor-setup.md](docs/cursor-setup.md).
|
||||
Put workflow skills under `.cursor/skills/` (sync from `agent-skills/skills/`) and short policies in `.cursor/rules/*.mdc` — do not paste full skills into rules. Both directories live in your project; this repo does not ship a `.cursor/` folder. See [docs/cursor-setup.md](docs/cursor-setup.md).
|
||||
|
||||
</details>
|
||||
|
||||
@@ -162,7 +162,7 @@ See [docs/opencode-setup.md](docs/opencode-setup.md).
|
||||
<details>
|
||||
<summary><b>GitHub Copilot</b></summary>
|
||||
|
||||
Use agent definitions from `agents/` as Copilot personas and skill content in `.github/copilot-instructions.md`. See [docs/copilot-setup.md](docs/copilot-setup.md).
|
||||
Use agent definitions from `agents/` as Copilot personas and skill content in `.github/copilot-instructions.md`. The lifecycle slash commands (`/spec`, `/plan`, `/build`, `/test`, `/review`, `/ship`) are Claude Code commands and do not appear in Copilot; invoke the skills by name (`/spec-driven-development`, …) instead. See [docs/copilot-setup.md](docs/copilot-setup.md).
|
||||
|
||||
Using the standalone `copilot` CLI? Install it as a plugin — see [docs/copilot-cli-setup.md](docs/copilot-cli-setup.md).
|
||||
|
||||
|
||||
@@ -4,6 +4,8 @@ This guide covers Copilot in VS Code. For the standalone `copilot` command-line
|
||||
|
||||
**What an install actually gives you:** the skills. Each installed skill becomes a slash command named after its frontmatter `name` — `/spec-driven-development`, `/test-driven-development`, and so on. `npx skills add addyosmani/agent-skills` and the manual copy below both install skills only. Neither of those two routes copies this repo's short lifecycle wrappers (`/spec`, `/plan`, `/build`, `/test`, `/review`, `/ship`) — those are Claude Code commands living in `.claude/commands/`. Use the full skill names, or add your own aliases — see [Lifecycle workflows](#lifecycle-workflows).
|
||||
|
||||
> **`/spec`, `/plan`, `/build`, `/test`, `/review`, `/code-simplify`, `/webperf` and `/ship` never appear in Copilot.** They are Claude Code commands, and Copilot does not read `.claude/commands/`. Not seeing them after an install is expected, not a missing step. Invoke the skill by its own name instead — `/spec-driven-development` for `/spec`, `/planning-and-task-breakdown` for `/plan`, and so on; the full mapping is in [Lifecycle Workflows](#lifecycle-workflows). On VS Code you can add [short aliases](#optional-short-spec-style-aliases) yourself if you want the short forms.
|
||||
|
||||
## Setup
|
||||
|
||||
### Copilot Instructions
|
||||
@@ -145,6 +147,8 @@ Write the body yourself, or take it from this table, rather than copying `.claud
|
||||
|
||||
### If the skill slash commands don't appear
|
||||
|
||||
First rule out the expected case: if the only commands you miss are the short lifecycle wrappers (`/spec`, `/plan`, `/build`, `/test`, `/review`, `/ship`), nothing is wrong — those are Claude Code commands and never surface in Copilot (see the note at the top). The steps below are for when the skills' own names, such as `/spec-driven-development`, are missing too.
|
||||
|
||||
Work through these in order — `/spec-driven-development` missing and `/spec` missing have different causes:
|
||||
|
||||
1. **Check where the skills landed.** Each one needs its own directory containing a `SKILL.md`. The project-level paths this guide uses are `.github/skills/`, `.claude/skills/` and `.agents/skills/` — but an installer run with a global/user flag writes outside the workspace instead (`~/.agents/skills/` and equivalents), so a skill that isn't in any of the three may simply be installed personally. Confirm the actual path against the [VS Code agent skills docs](https://code.visualstudio.com/docs/agent-customization/agent-skills), then re-install into the project if you wanted it project-scoped.
|
||||
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
How to wire [agent-skills](../README.md) into **Cursor** using current, supported project context — not legacy monolith files or Kaizen-specific layouts.
|
||||
|
||||
Every `.cursor/` path in this guide lives in **your** project (or under `~/.cursor/` for user scope). This repository does not ship a `.cursor/` directory: you create it and sync the skills into it, which is what [step 1](#1-install-skills-into-cursorskills) does.
|
||||
|
||||
---
|
||||
|
||||
## What Cursor supports today
|
||||
@@ -205,6 +207,7 @@ Files under `agent-skills/agents/` (e.g. code reviewer persona) are **not** load
|
||||
| Stale workflow | Re-`rsync` from `agent-skills/skills/` |
|
||||
| Duplicate instructions | Remove skill content from rules; keep one source |
|
||||
| Wrong skill picked | Narrow `description` in custom skills; nudge in chat |
|
||||
| "An unexpected error occurred on our servers" right after attaching a skill with `/`, and every later message in that chat fails too | Known Cursor-side issue, tracked in [#494](https://github.com/addyosmani/agent-skills/issues/494): Cursor pulls the attached `SKILL.md` into the request and the failure happens on its side, not in the skill. Start a new chat and reference the skill by name in plain text ("Use the test-driven-development skill to …") instead of attaching it. |
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -4,4 +4,7 @@ These hosts install the pack but are not in the README's install section, becaus
|
||||
|
||||
Skills are plain `SKILL.md` folders, so any agent that reads the Agent Skills layout can load them. See [getting-started.md](getting-started.md).
|
||||
|
||||
- **Dojo Workspace**: `dojo skills add addyosmani/agent-skills`
|
||||
- **fx**: `git clone https://github.com/addyosmani/agent-skills.git /tmp/agent-skills && mkdir -p .fx/skills && cp -R /tmp/agent-skills/skills/* .fx/skills/` (project scope; use `~/.fx/skills/` instead for every workspace; needs fx 0.0.5 or later)
|
||||
- **Oh My Pi**: `omp plugin marketplace add addyosmani/agent-skills`, then `omp plugin install agent-skills@addy-agent-skills`
|
||||
- **Pi**: `pi install git:github.com/addyosmani/agent-skills`
|
||||
@@ -39,6 +39,24 @@
|
||||
"Trade-offs and rejected options are recorded, not just the winning choice",
|
||||
"The ADR records a status from the skill's lifecycle (Proposed, Accepted, Superseded or Deprecated) and a date"
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"kind": "execution",
|
||||
"prompt": "Review README.md for operators onboarding to this batch queue. Make the prose clearer, check it against queue.js, and keep the operational details and caveats accurate. Do not change the implementation.",
|
||||
"expected_output": "A concise operational README grounded in the inspected implementation, with unsupported assurances removed or flagged, limits and caveats preserved, and the unverified command identified",
|
||||
"files": [
|
||||
"documentation-and-adrs/prose-review"
|
||||
],
|
||||
"expectations": [
|
||||
"The final README identifies queuectl submit jobs.json --max-batch-size 50 as an unverified documented example because the fixture contains neither the CLI nor jobs.json; it does not invent, silently certify, or replace that interface",
|
||||
"The final README preserves the 50-job batch limit, 72-hour retention period, and at most three retries, distinguishing those units correctly",
|
||||
"The final README preserves the operational caveat that failed jobs require operator review and queue state is not durable across a process restart",
|
||||
"The unsupported claims of guaranteed zero job loss and no need for monitoring are removed or explicitly marked as unsubstantiated rather than restated as facts",
|
||||
"The promotional opening is replaced with a concrete description of the queue without invented users, benchmarks, certifications, or capabilities",
|
||||
"The execution trace shows the agent inspecting queue.js and comparing the README with its batch, retention, retry, and in-memory-state implementation before editing",
|
||||
"queue.js remains unchanged, and the agent does not install a tool or send the fixture to a hosted service"
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
# Batch Queue
|
||||
|
||||
Batch Queue is an innovative, enterprise-grade solution that seamlessly unlocks
|
||||
the power of batch processing. In today's fast-paced landscape, it is important
|
||||
to note that this robust queue empowers operators to take work to the next level.
|
||||
|
||||
## Submit a batch
|
||||
|
||||
```sh
|
||||
queuectl submit jobs.json --max-batch-size 50
|
||||
```
|
||||
|
||||
A batch contains at most 50 jobs. Queue entries expire after 72 hours. Failed
|
||||
jobs are retried at most three times.
|
||||
|
||||
Operators review jobs that still fail after retries. Queue state is held in
|
||||
memory and is not durable across a process restart.
|
||||
|
||||
This guarantees zero job loss and means operators never need to monitor the queue.
|
||||
@@ -0,0 +1,32 @@
|
||||
'use strict';
|
||||
|
||||
const MAX_BATCH_SIZE = 50;
|
||||
const RETENTION_MS = 72 * 60 * 60 * 1000;
|
||||
const MAX_RETRIES = 3;
|
||||
const jobs = new Map();
|
||||
|
||||
function submit(batch, now = Date.now()) {
|
||||
if (batch.length > MAX_BATCH_SIZE) throw new Error('Batch exceeds limit');
|
||||
for (const job of batch) {
|
||||
jobs.set(job.id, { ...job, createdAt: now, retries: 0, state: 'queued' });
|
||||
}
|
||||
}
|
||||
|
||||
function recordFailure(id) {
|
||||
const job = jobs.get(id);
|
||||
if (!job) throw new Error('Unknown job');
|
||||
if (job.retries < MAX_RETRIES) {
|
||||
job.retries += 1;
|
||||
job.state = 'queued';
|
||||
} else {
|
||||
job.state = 'operator-review';
|
||||
}
|
||||
}
|
||||
|
||||
function expire(now = Date.now()) {
|
||||
for (const [id, job] of jobs) {
|
||||
if (now - job.createdAt >= RETENTION_MS) jobs.delete(id);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = { submit, recordFailure, expire, MAX_BATCH_SIZE, RETENTION_MS, MAX_RETRIES };
|
||||
@@ -9,7 +9,7 @@ const fs = require('node:fs');
|
||||
const os = require('node:os');
|
||||
const path = require('node:path');
|
||||
|
||||
const { lintSkillContent, lintSkillLayout, topLevelFrontmatterKeys, parseFrontmatter, frontmatterYamlErrors } = require('./skill-lint.js');
|
||||
const { lintSkillContent, lintSkillLayout, topLevelFrontmatterKeys, parseFrontmatter, frontmatterYamlErrors, lintPersonaContent } = require('./skill-lint.js');
|
||||
|
||||
const KNOWN = new Set(['alpha', 'beta']);
|
||||
|
||||
@@ -695,3 +695,68 @@ test('a skill with frontmatter comments and nested metadata passes validation',
|
||||
assert.deepEqual(errors, []);
|
||||
});
|
||||
|
||||
// ─── Personas (agents/<name>.md) ─────────────────────────────────────────────
|
||||
//
|
||||
// docs/agents.md: same frontmatter format as a skill, name equal to the file
|
||||
// stem, and the file ends with a Composition block. Nothing more is checked.
|
||||
|
||||
function personaFile({ name = 'code-reviewer', description = 'Reviews changes. Use before merging.', body } = {}) {
|
||||
const fm = ['---', name === null ? null : `name: ${name}`, description === null ? null : `description: ${description}`, '---']
|
||||
.filter(l => l !== null).join('\n');
|
||||
return `${fm}\n\n${body ?? '# Persona\n\n## Rules\n\nBe precise.\n\n## Composition\n\n- **Invoke via:** `/ship`.\n'}`;
|
||||
}
|
||||
|
||||
test('a conforming persona produces no errors', () => {
|
||||
assert.deepEqual(lintPersonaContent('code-reviewer', personaFile()).errors, []);
|
||||
});
|
||||
|
||||
test('persona: frontmatter name must match the file stem', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', personaFile({ name: 'reviewer' }));
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /name 'reviewer' does not match file name 'code-reviewer'/);
|
||||
});
|
||||
|
||||
test('persona: description is required', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', personaFile({ description: null }));
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /missing required field: 'description'/);
|
||||
});
|
||||
|
||||
test('persona: a missing frontmatter block is reported and nothing else is attempted', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', '# Persona\n\n## Composition\n');
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /Missing or malformed YAML frontmatter/);
|
||||
});
|
||||
|
||||
test('persona: frontmatter a host would reject as YAML is reported', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', personaFile({ description: 'Reviews: everything. Use before merging.' }));
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /Frontmatter line/);
|
||||
});
|
||||
|
||||
test('persona: the Composition section is required', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', personaFile({ body: '# Persona\n\n## Rules\n\nBe precise.\n' }));
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /Missing "## Composition" section/);
|
||||
});
|
||||
|
||||
test('persona: Composition must be the last section', () => {
|
||||
const { errors } = lintPersonaContent('code-reviewer', personaFile({
|
||||
body: '# Persona\n\n## Composition\n\n- **Invoke via:** `/ship`.\n\n## Output Format\n\nA report.\n',
|
||||
}));
|
||||
assert.equal(errors.length, 1);
|
||||
assert.match(errors[0], /must be the last section, but "## Output Format" follows it/);
|
||||
});
|
||||
|
||||
test('persona: a heading inside a fenced example after Composition is not a later section', () => {
|
||||
const body = [
|
||||
'# Persona', '', '## Composition', '', '- **Invoke via:** `/ship`. Report in this shape:', '',
|
||||
'```markdown', '## Review: [title]', 'Findings…', '```', '',
|
||||
].join('\n');
|
||||
assert.deepEqual(lintPersonaContent('code-reviewer', personaFile({ body })).errors, []);
|
||||
});
|
||||
|
||||
test('persona: the Composition heading match is case-insensitive and tolerates trailing spaces', () => {
|
||||
const body = '# Persona\n\n## composition \n\n- **Invoke via:** `/ship`.\n';
|
||||
assert.deepEqual(lintPersonaContent('code-reviewer', personaFile({ body })).errors, []);
|
||||
});
|
||||
@@ -544,6 +544,59 @@ function lintSkillLayout(skillDir) {
|
||||
return errors;
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint a persona file (agents/<name>.md) against the three rules docs/agents.md
|
||||
* states for them: frontmatter in the same format as a skill, with `name`
|
||||
* equal to the file stem (the name is the `subagent_type` commands spawn) and
|
||||
* a `description`; and a closing `## Composition` section. Headings inside
|
||||
* fenced blocks are ignored, so an example after Composition does not count as
|
||||
* a later section. Pure: no filesystem access. Returns { errors }.
|
||||
*/
|
||||
function lintPersonaContent(stem, content) {
|
||||
const errors = [];
|
||||
|
||||
const fm = parseFrontmatter(content);
|
||||
if (!fm) {
|
||||
errors.push('Missing or malformed YAML frontmatter (expected --- block at top of file)');
|
||||
return { errors };
|
||||
}
|
||||
errors.push(...frontmatterYamlErrors(content));
|
||||
|
||||
if (!fm.name) {
|
||||
errors.push("Frontmatter missing required field: 'name'");
|
||||
} else if (fm.name !== stem) {
|
||||
errors.push(`Frontmatter name '${fm.name}' does not match file name '${stem}' (the name is the subagent_type commands spawn)`);
|
||||
}
|
||||
if (!fm.description) {
|
||||
errors.push("Frontmatter missing required field: 'description'");
|
||||
}
|
||||
|
||||
const headings = [...stripFencedCodeBlocks(content).matchAll(/^## +(.+?)\s*$/gm)].map(m => m[1]);
|
||||
const compositionAt = headings.findIndex(h => /^Composition$/i.test(h));
|
||||
if (compositionAt === -1) {
|
||||
errors.push('Missing "## Composition" section (docs/agents.md: every persona file ends with a Composition block)');
|
||||
} else if (compositionAt !== headings.length - 1) {
|
||||
errors.push(`"## Composition" must be the last section, but "## ${headings[headings.length - 1]}" follows it`);
|
||||
}
|
||||
|
||||
return { errors };
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint a persona by file name: reads agents/<file>, then delegates to
|
||||
* lintPersonaContent. Returns { errors }.
|
||||
*/
|
||||
function lintPersona(fileName, agentsDir) {
|
||||
const stem = fileName.replace(/\.md$/, '');
|
||||
let content;
|
||||
try {
|
||||
content = fs.readFileSync(path.join(agentsDir, fileName), 'utf8');
|
||||
} catch (err) {
|
||||
return { errors: [`Unreadable persona file: ${err.message}`] };
|
||||
}
|
||||
return lintPersonaContent(stem, content);
|
||||
}
|
||||
|
||||
/**
|
||||
* Lint a skill by directory name: reads its SKILL.md, then delegates to
|
||||
* lintSkillContent. This is the thin filesystem wrapper the CLI uses.
|
||||
@@ -582,4 +635,6 @@ module.exports = {
|
||||
lintSkillContent,
|
||||
lintSkillLayout,
|
||||
lintSkill,
|
||||
lintPersonaContent,
|
||||
lintPersona,
|
||||
};
|
||||
@@ -3,7 +3,8 @@
|
||||
* validate-skills.js
|
||||
*
|
||||
* CLI that validates every skill in skills/ against the rules in
|
||||
* docs/skill-anatomy.md. The rules themselves live in scripts/lib/skill-lint.js
|
||||
* docs/skill-anatomy.md, and every persona in agents/ against the three rules
|
||||
* in docs/agents.md. The rules themselves live in scripts/lib/skill-lint.js
|
||||
* (a single source of truth, importable and unit-testable); this file is a thin
|
||||
* wrapper that walks the skills directory, runs the linter, prints the report,
|
||||
* and sets the exit code.
|
||||
@@ -16,9 +17,10 @@
|
||||
const fs = require('fs');
|
||||
const path = require('path');
|
||||
|
||||
const { lintSkill } = require('./lib/skill-lint');
|
||||
const { lintSkill, lintPersona } = require('./lib/skill-lint');
|
||||
|
||||
const SKILLS_DIR = path.resolve(__dirname, '..', 'skills');
|
||||
const AGENTS_DIR = path.resolve(__dirname, '..', 'agents');
|
||||
|
||||
// ─── Main ────────────────────────────────────────────────────────────────────
|
||||
|
||||
@@ -53,8 +55,29 @@ function main() {
|
||||
}
|
||||
}
|
||||
|
||||
// ── Personas ─────────────────────────────────────────────────────────────
|
||||
// agents/<name>.md files are consumed as subagents and spawned by name from
|
||||
// commands, so they get the same frontmatter contract plus a closing
|
||||
// Composition section (docs/agents.md). An index file such as README.md is
|
||||
// not a persona and is skipped.
|
||||
const personaFiles = fs.existsSync(AGENTS_DIR)
|
||||
? fs.readdirSync(AGENTS_DIR).filter(f => f.endsWith('.md') && !/^readme\.md$/i.test(f)).sort()
|
||||
: [];
|
||||
|
||||
if (personaFiles.length > 0) console.log('');
|
||||
for (const fileName of personaFiles) {
|
||||
const { errors } = lintPersona(fileName, AGENTS_DIR);
|
||||
totalErrors += errors.length;
|
||||
if (errors.length === 0) {
|
||||
console.log(` ✓ agents/${fileName}`);
|
||||
} else {
|
||||
console.log(` ✗ agents/${fileName}`);
|
||||
for (const msg of errors) console.log(` ERROR: ${msg}`);
|
||||
}
|
||||
}
|
||||
|
||||
const status = totalErrors > 0 ? 'FAILED' : totalWarnings > 0 ? 'PASSED WITH WARNINGS' : 'PASSED';
|
||||
console.log(`\n${skillDirs.length} skills checked — ${totalErrors} error(s), ${totalWarnings} warning(s) — ${status}`);
|
||||
console.log(`\n${skillDirs.length} skills and ${personaFiles.length} personas checked — ${totalErrors} error(s), ${totalWarnings} warning(s) — ${status}`);
|
||||
|
||||
if (totalErrors > 0) process.exit(1);
|
||||
}
|
||||
|
||||
@@ -256,6 +256,14 @@ Special consideration for AI agent context:
|
||||
- **ADRs** — Help agents understand why past decisions were made (prevents re-deciding)
|
||||
- **Inline gotchas** — Prevent agents from falling into known traps
|
||||
|
||||
## Prose Review
|
||||
|
||||
After checking the technical content, review the prose for the people who will use it. Clearer wording must not change the decision or its limits.
|
||||
|
||||
1. Mark the details that must survive the edit: names, numbers and units, commands, paths, links, conditions, trade-offs, and uncertainty. Check them against the available code and decision context; flag anything you cannot substantiate.
|
||||
2. Replace stock introductions, promotional adjectives, and repeated summaries with the concrete information the reader needs. Do not replace an unsupported claim with an invented example or a stronger guarantee. Keep necessary technical repetition and the project's established terminology.
|
||||
3. Compare the edited document with the original and its sources. Restore any lost qualifier or caveat, verify command and code examples still work as documented, and explain any unresolved factual question rather than polishing it away.
|
||||
|
||||
## Common Rationalizations
|
||||
|
||||
| Rationalization | Reality |
|
||||
@@ -286,3 +294,4 @@ After documenting:
|
||||
- [ ] Known gotchas are documented inline where they matter
|
||||
- [ ] No commented-out code remains
|
||||
- [ ] Rules files (CLAUDE.md etc.) are current and accurate
|
||||
- [ ] Prose edits preserve source details, decision trade-offs, and qualifiers without adding unsupported guarantees
|
||||
Reference in new issue
Block a user