mirror of
https://github.com/addyosmani/agent-skills.git
synced 2026-10-26 15:05:04 +00:00
Merge remote-tracking branch 'upstream/main' into fix/simplify-ignore-git-revert
# Conflicts: # hooks/simplify-ignore-test.sh # hooks/simplify-ignore.sh
This commit is contained in:
commit
5beffaeb17
21 files changed
+520
-29
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 };
|
||||
@@ -77,13 +77,14 @@ echo '{}' | bash hooks/simplify-ignore.sh
|
||||
```
|
||||
|
||||
Backups are stored in `.claude/.simplify-ignore-cache/` within your project directory.
|
||||
If a change is reverted while the hook is active, the superseded session backup is retained there as `<id>.superseded.<pid>`; review it and remove it when it is no longer needed.
|
||||
|
||||
## Known limitations
|
||||
|
||||
- **Single-line blocks hide the entire line.** If `simplify-ignore-start` and `simplify-ignore-end` appear on the same line as other code, the whole line is hidden from the model, not just the annotated portion. Use dedicated lines for annotations.
|
||||
- **Comment suffix detection covers `*/` and `-->` only.** Template engines with non-standard comment closers (ERB `%>`, Blade `--}}`) may produce unbalanced placeholders. Use `#` or `//` style comments instead.
|
||||
- **Fallback expansion is progressive, not exact.** If the model alters a placeholder's formatting (e.g. changes the reason text), the hook tries progressively simpler matches: full placeholder → prefix+hash+suffix → hash-only. The hash-only fallback may leave cosmetic debris (e.g. stray `:` or reason text). A warning is printed to stderr when this happens.
|
||||
- **A wholesale rewrite falls back to the backup.** If something replaces a filtered file's entire contents and removes every `BLOCK_<hash>` placeholder, the hook can no longer tell where the protected block belongs. At `Stop` it restores the backup and prints a warning; the rewrite is not lost but is kept in the cache as `.claude/.simplify-ignore-cache/<id>.recovered`, whose path the warning prints, and you merge it back by hand. Changes that leave the placeholders in place — a `Bash` edit, a formatter, an external editor — are kept in the file itself.
|
||||
- **A removed placeholder falls back to the backup.** If an edit deletes a `BLOCK_<hash>` line, or something replaces the whole file, the hook can no longer tell where that protected block belongs. An `Edit` or `Write` that does this is reported back to the model (exit 2) with the placeholder to restore, and the backup is not updated. If the placeholder is still missing at `Stop`, the hook restores the backup and prints a warning; the changed file is not lost but is kept in the cache as `.claude/.simplify-ignore-cache/<id>.recovered`, whose path the warning prints, and you merge it back by hand. Changes that leave the placeholders in place — a `Bash` edit, a formatter, an external editor — are kept in the file itself.
|
||||
- **File renaming leaves placeholders.** If the model renames or moves a file via a shell command, the new file will retain `BLOCK_<hash>` placeholders. The original code is saved as `<old-filename>.recovered` when the session stops. You must manually restore the recovered code into the new file.
|
||||
|
||||
## Requirements
|
||||
|
||||
@@ -466,11 +466,61 @@ else
|
||||
assert_eq "Stop restores original + edit byte-identically" "identical" "differs"
|
||||
fi
|
||||
|
||||
# -- Test 17: a change reverted with git stays reverted and the block hidden --
|
||||
printf '\nTest 17: Reverting a change with git during the session\n'
|
||||
# ── Test 17: a removed placeholder never takes its protected block with it ─
|
||||
printf '\nTest 17: Removing a placeholder line does not lose the protected block\n'
|
||||
PROJ="$TMPDIR/rt17"; mkdir -p "$PROJ"
|
||||
RT="$PROJ/dropped.js"
|
||||
cat > "$RT" <<'EOF'
|
||||
const a = 1;
|
||||
// simplify-ignore-start: first
|
||||
const keepOne = 42;
|
||||
// simplify-ignore-end
|
||||
const b = 2;
|
||||
// simplify-ignore-start: second
|
||||
const keepTwo = 43;
|
||||
// simplify-ignore-end
|
||||
EOF
|
||||
cp "$RT" "$PROJ/dropped.orig"
|
||||
|
||||
rt_hook_event "$PROJ" "Read" "$RT"
|
||||
# The model deletes the first placeholder line (it looks like a stray comment)
|
||||
# and edits another line in the same Edit.
|
||||
awk 'f||!/BLOCK_/{print;next}{f=1}' "$RT" | sed 's/const a = 1;/const a = 9;/' > "$PROJ/t"
|
||||
cat "$PROJ/t" > "$RT"
|
||||
edit_rc=0
|
||||
edit_out=$(rt_hook_event "$PROJ" "Edit" "$RT" 2>&1) || edit_rc=$?
|
||||
BAK=$(ls "$PROJ/.claude/.simplify-ignore-cache"/*.bak 2>/dev/null | head -1) || true
|
||||
assert_eq "Edit that drops a placeholder exits 2 (stderr goes to the model)" "2" "$edit_rc"
|
||||
assert_eq "message names the dropped placeholder" "1" "$(printf '%s' "$edit_out" | grep -c 'BLOCK_.*: first' || true)"
|
||||
assert_eq "backup still holds the protected block" "1" "$(grep -c 'const keepOne = 42' "${BAK:-/dev/null}" || true)"
|
||||
|
||||
stop_out=$(rt_hook_event "$PROJ" "" "" 2>&1) || true
|
||||
RECOVERED=$(ls "$PROJ/.claude/.simplify-ignore-cache"/*.recovered 2>/dev/null | head -1) || true
|
||||
assert_eq "Stop puts the protected block back" "1" "$(grep -c 'const keepOne = 42' "$RT" || true)"
|
||||
if cmp -s "$RT" "$PROJ/dropped.orig"; then
|
||||
assert_eq "Stop restores the last good backup" "identical" "identical"
|
||||
else
|
||||
assert_eq "Stop restores the last good backup" "identical" "differs"
|
||||
fi
|
||||
assert_eq "the edit is kept as .recovered" "1" "$(grep -c 'const a = 9;' "${RECOVERED:-/dev/null}" || true)"
|
||||
assert_eq ".recovered has the surviving block expanded" "1" "$(grep -c 'const keepTwo = 43' "${RECOVERED:-/dev/null}" || true)"
|
||||
assert_eq "Stop warns about the missing placeholder" "1" "$(printf '%s' "$stop_out" | grep -c 'placeholder is missing' || true)"
|
||||
|
||||
# Same loss through a route that fires no Edit event (Bash, a formatter).
|
||||
PROJ="$TMPDIR/rt17b"; mkdir -p "$PROJ"
|
||||
RT="$PROJ/dropped.js"
|
||||
cp "$TMPDIR/rt17/dropped.orig" "$RT"
|
||||
rt_hook_event "$PROJ" "Read" "$RT"
|
||||
awk 'f||!/BLOCK_/{print;next}{f=1}' "$RT" > "$PROJ/t"
|
||||
cat "$PROJ/t" > "$RT"
|
||||
rt_hook_event "$PROJ" "" "" 2>/dev/null || true
|
||||
assert_eq "no-event removal: Stop puts the protected block back" "1" "$(grep -c 'const keepOne = 42' "$RT" || true)"
|
||||
|
||||
# ── Test 18: a change reverted with git stays reverted and the block hidden ──
|
||||
printf '\nTest 18: Reverting a change with git during the session\n'
|
||||
if command -v git >/dev/null 2>&1; then
|
||||
for variant in read-then-stop stop; do
|
||||
PROJ="$TMPDIR/rt17-$variant"; mkdir -p "$PROJ"
|
||||
PROJ="$TMPDIR/rt18-$variant"; mkdir -p "$PROJ"
|
||||
RT="$PROJ/reverted.js"
|
||||
cat > "$RT" <<'EOF'
|
||||
const a = 1;
|
||||
@@ -488,7 +538,6 @@ EOF
|
||||
rt_hook_event "$PROJ" "Read" "$RT"
|
||||
printf '%s\n' "const broken = true;" >> "$RT"
|
||||
rt_hook_event "$PROJ" "Edit" "$RT"
|
||||
# The skill's "if tests fail, revert that change", done with git
|
||||
git -C "$PROJ" checkout -q -- reverted.js
|
||||
if [ "$variant" = read-then-stop ]; then
|
||||
rt_hook_event "$PROJ" "Read" "$RT" 2>/dev/null
|
||||
@@ -510,7 +559,7 @@ else
|
||||
fi
|
||||
|
||||
else
|
||||
printf '\nTests 14-17 skipped: jq not available (hook no-ops without it)\n'
|
||||
printf '\nTests 14-18 skipped: jq not available (hook no-ops without it)\n'
|
||||
fi
|
||||
|
||||
# ── Summary ──────────────────────────────────────────────────────────────
|
||||
|
||||
@@ -221,6 +221,27 @@ expand_file() {
|
||||
return 0
|
||||
}
|
||||
|
||||
# -- missing_placeholders: which cached BLOCK_<hash> of $2 are gone from $1? --
|
||||
# Prints the missing placeholders, one per line, and returns 0 if any is gone.
|
||||
# A placeholder stands for code the model never saw, so it cannot have removed
|
||||
# it on purpose; whichever route removed it, the block must not be lost with it.
|
||||
missing_placeholders() {
|
||||
local f="$1" fid="$2" bf h bp bs br out=""
|
||||
for bf in "$CACHE/${fid}".block.*; do
|
||||
[ -f "$bf" ] || continue
|
||||
h="${bf##*.}"
|
||||
grep -qF "BLOCK_${h}" "$f" 2>/dev/null && continue
|
||||
bp=""; bs=""; br=""
|
||||
[ -f "$CACHE/${fid}.prefix.${h}" ] && bp=$(cat "$CACHE/${fid}.prefix.${h}")
|
||||
[ -f "$CACHE/${fid}.suffix.${h}" ] && bs=$(cat "$CACHE/${fid}.suffix.${h}")
|
||||
[ -f "$CACHE/${fid}.reason.${h}" ] && br=": $(cat "$CACHE/${fid}.reason.${h}")"
|
||||
out="${out} ${bp}BLOCK_${h}${br}${bs}
|
||||
"
|
||||
done
|
||||
[ -n "$out" ] || return 1
|
||||
printf '%s' "$out"
|
||||
}
|
||||
|
||||
# ── has_placeholders: is a cached BLOCK_<hash> for $2 still present in file $1? ─
|
||||
has_placeholders() {
|
||||
local f="$1" fid="$2" bf h
|
||||
@@ -280,20 +301,25 @@ if [ -z "$TOOL_NAME" ]; then
|
||||
# It is newer than the backup, which would bring the reverted change
|
||||
# back, so keep the file and move the backup aside.
|
||||
set_aside_backup "$orig" "$fid"
|
||||
elif has_placeholders "$orig" "$fid"; then
|
||||
elif has_placeholders "$orig" "$fid" && ! missing_placeholders "$orig" "$fid" >/dev/null; then
|
||||
EXPANDED="$CACHE/${fid}.$$.expanded"
|
||||
expand_file "$orig" "$EXPANDED" "$fid"
|
||||
cat "$EXPANDED" > "$orig"
|
||||
rm -f "$EXPANDED"
|
||||
else
|
||||
# Nothing left to expand — the file was rewritten wholesale, so the
|
||||
# backup is the only remaining copy of the protected blocks. Keep the
|
||||
# rewrite in the cache before the backup overwrites it, so the work is
|
||||
# recoverable rather than lost.
|
||||
# A placeholder is gone — the file was rewritten wholesale, or one
|
||||
# block's line was deleted — so the backup is the only remaining copy
|
||||
# of that protected block. Keep the rewrite in the cache (with any
|
||||
# surviving placeholders expanded) before the backup overwrites it, so
|
||||
# the work is recoverable rather than lost.
|
||||
rewritten="$CACHE/${fid}.recovered"
|
||||
cat "$orig" > "$rewritten"
|
||||
if has_placeholders "$orig" "$fid"; then
|
||||
expand_file "$orig" "$rewritten" "$fid" 2>/dev/null
|
||||
else
|
||||
cat "$orig" > "$rewritten"
|
||||
fi
|
||||
cat "$bak" > "$orig"
|
||||
printf 'Warning: no BLOCK_ placeholder left in %s, restored from backup. Rewrite kept at %s\n' \
|
||||
printf 'Warning: a BLOCK_ placeholder is missing from %s, restored from backup. Rewrite kept at %s\n' \
|
||||
"$orig" "$rewritten" >&2
|
||||
fi
|
||||
rm -f "$bak" "$pathfile" "$CACHE/${fid}".block.* "$CACHE/${fid}".reason.* "$CACHE/${fid}".prefix.* "$CACHE/${fid}".suffix.*
|
||||
@@ -374,6 +400,19 @@ if [ "$TOOL_NAME" = "Edit" ] || [ "$TOOL_NAME" = "Write" ]; then
|
||||
[ -f "$CACHE/${ID}.bak" ] || exit 0
|
||||
ls "$CACHE/${ID}".block.* >/dev/null 2>&1 || exit 0
|
||||
|
||||
# The edit removed a placeholder. Expanding now would save a backup without
|
||||
# that block, and Stop would then restore the loss. Keep the last good
|
||||
# backup, leave the file as edited, and tell the model (exit 2 sends stderr
|
||||
# back to it) so it can put the placeholder back; if it does not, Stop
|
||||
# restores the backup and keeps this version as <id>.recovered.
|
||||
if dropped=$(missing_placeholders "$FILE_PATH" "$ID"); then
|
||||
printf '%s\n%s\n%s\n' \
|
||||
"simplify-ignore: this $TOOL_NAME removed placeholder line(s) from $FILE_PATH. Each stands for protected code you cannot see:" \
|
||||
"$dropped" \
|
||||
"Put each one back exactly as shown. Until then the backup is not updated, and at session end the file is restored from it (this version is kept in the cache as .recovered)." >&2
|
||||
exit 2
|
||||
fi
|
||||
|
||||
# Expand placeholders, preserving any inline code the model added around them
|
||||
EXPANDED="$CACHE/${ID}.$$.expanded"
|
||||
expand_file "$FILE_PATH" "$EXPANDED" "$ID"
|
||||
|
||||
@@ -9,7 +9,7 @@ const fs = require('node:fs');
|
||||
const os = require('node:os');
|
||||
const path = require('node:path');
|
||||
|
||||
const { lintSkillContent, lintSkillLayout, topLevelFrontmatterKeys } = require('./skill-lint.js');
|
||||
const { lintSkillContent, lintSkillLayout, topLevelFrontmatterKeys, parseFrontmatter, frontmatterYamlErrors, lintPersonaContent } = require('./skill-lint.js');
|
||||
|
||||
const KNOWN = new Set(['alpha', 'beta']);
|
||||
|
||||
@@ -648,3 +648,115 @@ test('the spec-key check tolerates CRLF frontmatter', () => {
|
||||
const { errors } = lintSkillContent('alpha', content, KNOWN);
|
||||
assert.equal(errors.filter(e => /key 'temperature'/.test(e)).length, 1);
|
||||
});
|
||||
|
||||
test('parseFrontmatter ignores comments and nested metadata keys', () => {
|
||||
const content = [
|
||||
'---',
|
||||
'name: alpha',
|
||||
'# note: this is a comment',
|
||||
'description: Designs alphas. Use when building one.',
|
||||
'metadata:',
|
||||
' name: beta',
|
||||
' description: Nested details without trigger',
|
||||
'---',
|
||||
'',
|
||||
].join('\n');
|
||||
assert.deepEqual(parseFrontmatter(content), {
|
||||
name: 'alpha',
|
||||
description: 'Designs alphas. Use when building one.',
|
||||
metadata: '',
|
||||
});
|
||||
});
|
||||
|
||||
test('frontmatterYamlErrors ignores comment lines containing colons or quotes', () => {
|
||||
const content = [
|
||||
'---',
|
||||
'name: alpha',
|
||||
'# note: a comment: with a colon and "unclosed quote',
|
||||
'description: "Designs alphas. Use when building one."',
|
||||
'---',
|
||||
'',
|
||||
].join('\n');
|
||||
assert.deepEqual(frontmatterYamlErrors(content), []);
|
||||
});
|
||||
|
||||
test('a skill with frontmatter comments and nested metadata passes validation', () => {
|
||||
const content = withAllSections([
|
||||
'---',
|
||||
'name: alpha',
|
||||
'# Note: keep description up to date: check docs',
|
||||
'description: Designs alphas. Use when building one.',
|
||||
'metadata:',
|
||||
' name: beta',
|
||||
' description: Internal notes',
|
||||
'---',
|
||||
].join('\n'));
|
||||
const { errors } = lintSkillContent('alpha', content, KNOWN);
|
||||
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, []);
|
||||
});
|
||||
@@ -184,11 +184,12 @@ function parseFrontmatter(content) {
|
||||
|
||||
const result = {};
|
||||
for (const line of match[1].split(/\r?\n/)) {
|
||||
const colonIdx = line.indexOf(':');
|
||||
if (colonIdx === -1) continue;
|
||||
const key = line.slice(0, colonIdx).trim();
|
||||
const value = line.slice(colonIdx + 1).trim().replace(/^['"]|['"]$/g, '');
|
||||
if (key) result[key] = value;
|
||||
if (/^\s*#/.test(line)) continue;
|
||||
const m = line.match(/^([A-Za-z0-9_-]+)\s*:\s*(.*)$/);
|
||||
if (!m) continue;
|
||||
const key = m[1];
|
||||
const value = m[2].trim().replace(/^['"]|['"]$/g, '');
|
||||
result[key] = value;
|
||||
}
|
||||
return result;
|
||||
}
|
||||
@@ -234,7 +235,7 @@ function frontmatterYamlErrors(content) {
|
||||
const lines = match[1].split(/\r?\n/);
|
||||
lines.forEach((line, i) => {
|
||||
const lineNo = i + 2; // the opening `---` is line 1
|
||||
if (!line.trim()) return;
|
||||
if (!line.trim() || /^\s*#/.test(line)) return;
|
||||
|
||||
if (/^[ ]*\t/.test(line)) {
|
||||
errors.push(
|
||||
@@ -543,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.
|
||||
@@ -581,4 +635,6 @@ module.exports = {
|
||||
lintSkillContent,
|
||||
lintSkillLayout,
|
||||
lintSkill,
|
||||
lintPersonaContent,
|
||||
lintPersona,
|
||||
};
|
||||
@@ -621,3 +621,70 @@ test('materializes a git baseline and applies a working-tree patch', () => {
|
||||
fs.rmSync(workspace, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
|
||||
test('fixture baseline commits ignore inherited user signing requirements', () => {
|
||||
const root = makeSandbox();
|
||||
const config = path.join(root, 'global.gitconfig');
|
||||
const temp = fs.mkdtempSync(path.join(os.tmpdir(), 'fixture-signing-test-'));
|
||||
try {
|
||||
fs.writeFileSync(config, '[commit]\n\tgpgsign = true\n[gpg]\n\tprogram = definitely-missing-eval-signer\n');
|
||||
const result = spawnSync(process.execPath, ['-e', `
|
||||
const fs = require('node:fs');
|
||||
const { materializeWorkspace } = require(${JSON.stringify(path.join(root, 'scripts', 'run-evals.js'))});
|
||||
let workspace;
|
||||
try { workspace = materializeWorkspace({ files: ['project/context.txt'] }); }
|
||||
finally { if (workspace) fs.rmSync(workspace, { recursive: true, force: true }); }
|
||||
`], { cwd: root, encoding: 'utf8', env: { ...process.env, GIT_CONFIG_GLOBAL: config, TMPDIR: temp, TMP: temp, TEMP: temp } });
|
||||
assert.equal(result.status, 0, result.stdout + result.stderr);
|
||||
} finally {
|
||||
fs.rmSync(root, { recursive: true, force: true });
|
||||
fs.rmSync(temp, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
|
||||
test('rejects duplicate behavioral IDs before they can overwrite a grading slot', () => {
|
||||
const root = makeSandbox();
|
||||
try {
|
||||
writeSkill(root, 'alpha-skill', 'Handles alpha widgets. Use when changing alpha widgets.');
|
||||
const evalCase = completeCase('alpha-skill', 'change alpha widget');
|
||||
evalCase.evals.push({ ...behavioralEval(), prompt: 'A different evaluation' });
|
||||
writeJson(path.join(root, 'evals', 'cases', 'alpha-skill.json'), evalCase);
|
||||
const result = run(root);
|
||||
assert.equal(result.status, 1, result.stdout + result.stderr);
|
||||
assert.match(result.stdout, /duplicate behavioral eval id=1/);
|
||||
const dryRun = run(root, ['--behavioral', 'alpha-skill', '--dry-run']);
|
||||
assert.equal(dryRun.status, 1, dryRun.stdout + dryRun.stderr);
|
||||
assert.match(dryRun.stderr, /duplicate behavioral eval id=1/);
|
||||
} finally { fs.rmSync(root, { recursive: true, force: true }); }
|
||||
});
|
||||
|
||||
test('accepts distinct behavioral IDs including zero', () => {
|
||||
const root = makeSandbox();
|
||||
try {
|
||||
writeSkill(root, 'alpha-skill', 'Handles alpha widgets. Use when changing alpha widgets.');
|
||||
const evalCase = completeCase('alpha-skill', 'change alpha widget');
|
||||
evalCase.evals.push({ ...behavioralEval(), id: 0 });
|
||||
writeJson(path.join(root, 'evals', 'cases', 'alpha-skill.json'), evalCase);
|
||||
const result = run(root);
|
||||
assert.equal(result.status, 0, result.stdout + result.stderr);
|
||||
} finally { fs.rmSync(root, { recursive: true, force: true }); }
|
||||
});
|
||||
|
||||
test('removes the throwaway workspace when fixture setup fails', () => {
|
||||
const root = makeSandbox();
|
||||
const temp = fs.mkdtempSync(path.join(os.tmpdir(), 'workspace-cleanup-test-'));
|
||||
try {
|
||||
const result = spawnSync(process.execPath, ['-e', `
|
||||
const { materializeWorkspace } = require(${JSON.stringify(path.join(root, 'scripts', 'run-evals.js'))});
|
||||
try { materializeWorkspace({ files: ['project/context.txt', 'missing.txt'] }); }
|
||||
catch (error) { console.error(error.message); }
|
||||
`], { cwd: root, encoding: 'utf8', env: { ...process.env, TMPDIR: temp, TMP: temp, TEMP: temp } });
|
||||
assert.equal(result.status, 0, result.stdout + result.stderr);
|
||||
assert.match(result.stderr, /fixture listed in files\[\] not found/);
|
||||
assert.deepEqual(fs.readdirSync(temp), [], 'partially copied fixture data must be removed');
|
||||
} finally {
|
||||
fs.rmSync(root, { recursive: true, force: true });
|
||||
fs.rmSync(temp, { recursive: true, force: true });
|
||||
}
|
||||
});
|
||||
@@ -193,6 +193,16 @@ function resolveFixturePath(root, rel) {
|
||||
return resolvedPath;
|
||||
}
|
||||
|
||||
function duplicateEvalIds(evals) {
|
||||
const seen = new Set();
|
||||
const duplicates = new Set();
|
||||
for (const ev of evals) {
|
||||
if (seen.has(ev.id)) duplicates.add(ev.id);
|
||||
seen.add(ev.id);
|
||||
}
|
||||
return [...duplicates];
|
||||
}
|
||||
|
||||
// ---------- tier 2 ----------
|
||||
|
||||
function runDeterministic(minRank1) {
|
||||
@@ -235,6 +245,11 @@ function runDeterministic(minRank1) {
|
||||
continue;
|
||||
}
|
||||
|
||||
for (const id of duplicateEvalIds(d.evals || [])) {
|
||||
console.log(` ✗ ${c.file}: duplicate behavioral eval id=${id}`);
|
||||
errors++;
|
||||
}
|
||||
|
||||
// Schema: behavioral evals (skill-creator evals.json shape)
|
||||
for (const ev of d.evals || []) {
|
||||
const kind = ev.kind || 'execution';
|
||||
@@ -389,6 +404,15 @@ function materializeWorkspace(ev) {
|
||||
// Fresh throwaway project dir per eval; fixtures (if any) copied in so the
|
||||
// agent has real code to operate on rather than describing what it would do.
|
||||
const workspace = fs.mkdtempSync(path.join(os.tmpdir(), 'agent-skills-eval-'));
|
||||
try {
|
||||
return initializeWorkspace(ev, workspace);
|
||||
} catch (error) {
|
||||
fs.rmSync(workspace, { recursive: true, force: true });
|
||||
throw error;
|
||||
}
|
||||
}
|
||||
|
||||
function initializeWorkspace(ev, workspace) {
|
||||
const setupDirs = new Set();
|
||||
for (const rel of ev.files || []) {
|
||||
const src = resolveFixturePath(FIXTURES_DIR, rel);
|
||||
@@ -412,6 +436,7 @@ function materializeWorkspace(ev) {
|
||||
// throwaway workspace.
|
||||
execFileSync('git', ['init', '--quiet'], { cwd: workspace });
|
||||
execFileSync('git', ['config', 'core.autocrlf', 'false'], { cwd: workspace });
|
||||
execFileSync('git', ['config', 'commit.gpgsign', 'false'], { cwd: workspace });
|
||||
execFileSync('git', ['config', 'user.name', 'Skill Eval'], { cwd: workspace });
|
||||
execFileSync('git', ['config', 'user.email', 'skill-eval@example.invalid'], { cwd: workspace });
|
||||
execFileSync('git', ['add', '--all'], { cwd: workspace });
|
||||
@@ -522,6 +547,11 @@ function runBehavioral(skillName, dryRun) {
|
||||
console.error(`"${skillName}" has no behavioral evals`);
|
||||
process.exit(1);
|
||||
}
|
||||
const duplicateIds = duplicateEvalIds(d.evals);
|
||||
if (duplicateIds.length) {
|
||||
console.error(`"${skillName}" has duplicate behavioral eval id=${duplicateIds.join(', ')}; each grading slot needs a unique id`);
|
||||
process.exit(1);
|
||||
}
|
||||
if (!dryRun) fs.mkdirSync(RESULTS_DIR, { recursive: true });
|
||||
let failures = 0;
|
||||
|
||||
|
||||
@@ -493,3 +493,21 @@ test('a missing file is reported once, not again for its anchor', () => {
|
||||
assert.match(result.stdout, /L1: references\/renamed\.md — resolves to skills\/hardening\/references\/renamed\.md, which does not exist/);
|
||||
assert.match(result.stdout, /1 skills checked — 1 error\(s\) — FAILED/);
|
||||
});
|
||||
|
||||
|
||||
test('heading slugs remain unique when a literal suffix collides with an allocated slug', () => {
|
||||
const root = makeSandbox();
|
||||
hardeningSkill(root, 'references/patterns.md#example-1-1');
|
||||
// A hyphen in the literal heading makes its base slug collide with Example's suffix.
|
||||
writeFile(root, 'skills/hardening/references/patterns.md', '## Example\n\n## Example\n\n## Example-1\n');
|
||||
const result = run(root);
|
||||
assert.equal(result.status, 0, result.stdout + result.stderr);
|
||||
});
|
||||
|
||||
test('a duplicate skips a slug occupied by an earlier literal heading', () => {
|
||||
const root = makeSandbox();
|
||||
hardeningSkill(root, 'references/patterns.md#example-2');
|
||||
writeFile(root, 'skills/hardening/references/patterns.md', '## Example\n\n## Example-1\n\n## Example\n');
|
||||
const result = run(root);
|
||||
assert.equal(result.status, 0, result.stdout + result.stderr);
|
||||
});
|
||||
@@ -77,8 +77,10 @@ function headingAnchors(file) {
|
||||
const match = line.match(/^ {0,3}#{1,6}[ \t]+(.*?)(?:[ \t]+#+)?[ \t]*$/);
|
||||
if (!match) continue;
|
||||
const slug = slugify(match[1]);
|
||||
const count = seen.get(slug) || 0;
|
||||
anchors.add(count === 0 ? slug : `${slug}-${count}`);
|
||||
let count = seen.get(slug) || 0;
|
||||
let anchor = count === 0 ? slug : `${slug}-${count}`;
|
||||
while (anchors.has(anchor)) anchor = `${slug}-${++count}`;
|
||||
anchors.add(anchor);
|
||||
seen.set(slug, count + 1);
|
||||
}
|
||||
return anchors;
|
||||
|
||||
@@ -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
|
||||
@@ -79,7 +79,7 @@ export function TaskItem({ task, onToggle, onDelete }: TaskItemProps) {
|
||||
```tsx
|
||||
// Container: handles data
|
||||
export function TaskListContainer() {
|
||||
const { tasks, isLoading, error } = useTasks();
|
||||
const { tasks, isLoading, error, refetch } = useTasks();
|
||||
|
||||
if (isLoading) return <TaskListSkeleton />;
|
||||
if (error) return <ErrorState message="Failed to load tasks" retry={refetch} />;
|
||||
|
||||
@@ -159,7 +159,7 @@ The `range() !== 'unicast'` check covers loopback, link-local `169.254.169.254`
|
||||
import { z } from 'zod';
|
||||
|
||||
const CreateTaskSchema = z.object({
|
||||
title: z.string().min(1).max(200).trim(),
|
||||
title: z.string().max(200).trim().min(1),
|
||||
description: z.string().max(2000).optional(),
|
||||
priority: z.enum(['low', 'medium', 'high']).default('medium'),
|
||||
dueDate: z.string().datetime().optional(),
|
||||
|
||||
@@ -190,6 +190,12 @@ Client metrics:
|
||||
```typescript
|
||||
// Set up error boundary with reporting
|
||||
class ErrorBoundary extends React.Component {
|
||||
state = { hasError: false };
|
||||
|
||||
static getDerivedStateFromError() {
|
||||
return { hasError: true };
|
||||
}
|
||||
|
||||
componentDidCatch(error: Error, info: React.ErrorInfo) {
|
||||
// Report to error tracking service
|
||||
reportError(error, {
|
||||
|
||||
Reference in new issue
Block a user