@erclx/canon 5.36.0 → 5.37.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/claude/.claude-plugin/plugin.json +1 -1
- package/claude/skills/api-design/SKILL.md +6 -0
- package/claude/skills/backlog-triage/SKILL.md +7 -7
- package/claude/skills/build-in-slices/SKILL.md +6 -0
- package/claude/skills/build-in-slices/references/adopted.md +3 -0
- package/claude/skills/canon-cli/SKILL.md +3 -0
- package/claude/skills/canon-feedback/SKILL.md +5 -0
- package/claude/skills/canon-feedback-triage/SKILL.md +3 -0
- package/claude/skills/canvas-board/SKILL.md +3 -0
- package/claude/skills/canvas-board/references/canvas.md +12 -0
- package/claude/skills/ci-workflow/SKILL.md +5 -0
- package/claude/skills/code-craft/SKILL.md +6 -0
- package/claude/skills/context-fold/references/context.md +48 -34
- package/claude/skills/create-rule/SKILL.md +11 -9
- package/claude/skills/create-rule/references/rule.md +6 -0
- package/claude/skills/create-skill/SKILL.md +11 -2
- package/claude/skills/create-skill/references/skill-disclosure.md +26 -0
- package/claude/skills/create-skill/references/skill-paths.md +3 -0
- package/claude/skills/create-skill/references/skill-reference.md +12 -0
- package/claude/skills/create-skill/references/skill.md +25 -24
- package/claude/skills/deprecation-migration/SKILL.md +6 -0
- package/claude/skills/deprecation-migration/references/adopted.md +3 -0
- package/claude/skills/design-taste/SKILL.md +6 -0
- package/claude/skills/design-taste/references/craft.md +3 -0
- package/claude/skills/design-taste/references/preflight.md +16 -0
- package/claude/skills/docs-sync/references/docs.md +6 -0
- package/claude/skills/docs-sync/references/readme.md +15 -0
- package/claude/skills/draft-and-pick/SKILL.md +12 -0
- package/claude/skills/draft-doc/references/context.md +1 -1
- package/claude/skills/draft-doc/references/readme.md +3 -0
- package/claude/skills/draft-figure/references/mermaid.md +6 -0
- package/claude/skills/draft-slides/SKILL.md +3 -0
- package/claude/skills/git-branch/references/branch.md +16 -11
- package/claude/skills/git-commit/references/commit.md +19 -11
- package/claude/skills/git-commit/references/versioning.md +9 -0
- package/claude/skills/git-issue/references/issue.md +12 -9
- package/claude/skills/git-pr/SKILL.md +5 -0
- package/claude/skills/git-pr/references/pr.md +24 -6
- package/claude/skills/git-ship/SKILL.md +3 -0
- package/claude/skills/git-split/SKILL.md +6 -0
- package/claude/skills/git-stage/SKILL.md +3 -0
- package/claude/skills/git-worktree/SKILL.md +6 -6
- package/claude/skills/markdown-craft/references/markdown.md +24 -6
- package/claude/skills/plan-feature/SKILL.md +9 -0
- package/claude/skills/plan-feature/references/plan.md +20 -8
- package/claude/skills/plan-groundwork/SKILL.md +6 -0
- package/claude/skills/plan-groundwork/references/groundwork.md +10 -7
- package/claude/skills/plan-intake/references/intake.md +6 -6
- package/claude/skills/read-frames/SKILL.md +3 -0
- package/claude/skills/review-craft/SKILL.md +3 -0
- package/claude/skills/review-ui/SKILL.md +6 -3
- package/claude/skills/role-orchestrator/SKILL.md +3 -0
- package/claude/skills/role-orchestrator/references/orchestrator-dispatch.md +7 -4
- package/claude/skills/role-orchestrator/references/orchestrator-refill.md +3 -0
- package/claude/skills/role-planner/SKILL.md +3 -0
- package/claude/skills/role-worker/SKILL.md +12 -0
- package/claude/skills/search-craft/SKILL.md +3 -0
- package/claude/skills/systematic-debugging/SKILL.md +6 -0
- package/claude/skills/target-check/references/domains.md +5 -0
- package/claude/skills/target-setup/SKILL.md +5 -0
- package/claude/skills/task-board/references/tasks.md +9 -6
- package/claude/skills/task-complete/references/archive.md +3 -0
- package/claude/skills/teach-workspace/SKILL.md +3 -0
- package/claude/skills/teach-workspace/references/glossary.md +3 -0
- package/claude/skills/teach-workspace/references/lesson-build.md +3 -0
- package/claude/skills/teach-workspace/references/lesson-craft.md +3 -0
- package/claude/skills/teach-workspace/references/teach.md +8 -8
- package/claude/skills/test-craft/SKILL.md +5 -0
- package/claude/skills/video-craft/SKILL.md +6 -0
- package/claude/skills/write-human/SKILL.md +9 -0
- package/docs/agents/capture.md +2 -0
- package/docs/agents/commands.md +54 -54
- package/docs/agents/context-audit-checks.md +6 -0
- package/docs/agents/context-audit.md +8 -8
- package/docs/agents/context-classify.md +2 -0
- package/docs/agents/drift-surfaces.md +5 -5
- package/docs/agents/gate.md +6 -7
- package/docs/agents/index.md +1 -1
- package/docs/agents/install-and-sync.md +2 -2
- package/docs/agents/markdown-audit-weight.md +11 -3
- package/docs/agents/markdown-audit.md +2 -2
- package/docs/agents/pr-frames.md +17 -3
- package/docs/agents/sessions-transfer.md +8 -6
- package/docs/agents/skills-audit.md +9 -1
- package/docs/target/scenarios.md +1 -1
- package/docs/target/standards-moved.md +20 -18
- package/docs/workflow/ai-workflow.md +3 -0
- package/docs/workflow/visual-design-workflow.md +5 -0
- package/package.json +2 -2
- package/src/cli/help.ts +1 -1
- package/src/commands/context.ts +29 -4
- package/src/commands/gate.ts +1 -8
- package/src/commands/markdown.ts +52 -0
- package/src/commands/pr.ts +17 -10
- package/src/context/audit.ts +83 -0
- package/src/context/classify/prompts.ts +6 -1
- package/src/context/gate.ts +6 -3
- package/src/gate/measures.ts +186 -1
- package/src/gate/sequencer.ts +0 -4
- package/src/gate/stages.ts +32 -27
- package/src/git/files.ts +30 -0
- package/src/gov/adapter.ts +2 -2
- package/src/gov/install.ts +2 -2
- package/src/gov/list.ts +1 -1
- package/src/gov/payload.ts +1 -1
- package/src/gov/stacks.ts +1 -1
- package/src/markdown/gate.ts +10 -0
- package/src/markdown/growth.ts +43 -0
- package/src/markdown/stacks.ts +74 -0
- package/src/markdown/structure.ts +72 -4
- package/src/migrate/rule-layout.ts +12 -12
- package/src/pr/frames.ts +66 -1
- package/src/sync/check.ts +23 -23
- package/tooling/astro/configs/tsconfig.json +1 -1
- package/tooling/astro/reference.md +2 -2
- package/tooling/base/configs/scripts/verify.json +1 -1
- package/tooling/base/configs/scripts/verify.ts +2 -8
- package/tooling/base/reference.md +10 -10
- package/tooling/base/seeds/canon/context/ci.md +4 -4
- package/tooling/base/seeds/canon/context/development.md +9 -9
- package/tooling/claude/seeds/.claude/hooks/scratch-guard.sh +8 -0
- package/tooling/vite-react/configs/tsconfig.json +1 -1
- package/tooling/vite-react/configs/vitest.config.ts +1 -1
- package/tooling/vite-react/reference.md +2 -2
- package/tooling/web/configs/src/test/setup.ts +1 -1
- package/tooling/web/manifest.toml +3 -3
- package/tooling/web/reference.md +1 -1
|
@@ -57,6 +57,11 @@ Every test carries these, at any layer and in any runner:
|
|
|
57
57
|
- Verify one behavior per test.
|
|
58
58
|
- Keep conditional logic and loops out of a test body. A table of cases is one test per row, never a branch inside one.
|
|
59
59
|
- Set no coverage percentage as a target. Cover the behaviors and their edges.
|
|
60
|
+
|
|
61
|
+
### Isolation and assertions
|
|
62
|
+
|
|
63
|
+
Every test carries these too:
|
|
64
|
+
|
|
60
65
|
- Group related tests with the framework's nesting mechanism, and keep it to two levels deep.
|
|
61
66
|
- Keep tests independent with no shared side effects. Clean up and restore state after each one.
|
|
62
67
|
- Await every async operation. Never leave a promise fire-and-forget in a test.
|
|
@@ -60,6 +60,9 @@ The guidance covers landscape 16:9 video. Vertical 9:16 framing is not covered y
|
|
|
60
60
|
- Every move in the composition shares one duration.
|
|
61
61
|
- A caption is centered on screen and covers the element the step acts on.
|
|
62
62
|
- A caption names a step the frame is not showing.
|
|
63
|
+
|
|
64
|
+
### Timing and checks
|
|
65
|
+
|
|
63
66
|
- The zoom's start time was added up by hand while a timeline file sits beside the take.
|
|
64
67
|
- Two pointers appear on one frame.
|
|
65
68
|
- A checker finding was dismissed and no frame was opened.
|
|
@@ -77,6 +80,9 @@ The guidance covers landscape 16:9 video. Vertical 9:16 framing is not covered y
|
|
|
77
80
|
- Easing, speed variety, anchoring, click timing, and every other general motion rule: `hyperframes-animation` and `hyperframes-creative`
|
|
78
81
|
- Title-safe margins and timeline layout: `hyperframes-studio`
|
|
79
82
|
- The carve that sits music under a voice: `hyperframes-audio`
|
|
83
|
+
|
|
84
|
+
### Media, capture, and reading
|
|
85
|
+
|
|
80
86
|
- Fetching or generating music, effects, voice, and imagery: `media-use`
|
|
81
87
|
- Recording the take and writing its timeline: `record-screencast` through `canon demo run`
|
|
82
88
|
- Reading a render frame by frame: `read-frames`
|
|
@@ -24,9 +24,15 @@ The banned characters sit in `${CLAUDE_SKILL_DIR}/../markdown-craft/references/m
|
|
|
24
24
|
- Write for a developer who is scanning rather than studying. Every sentence has to land on first read.
|
|
25
25
|
- Use active voice, and present tense unless past or future is factually correct.
|
|
26
26
|
- Name the actor in a sentence that has one. Passive voice with an unnamed actor hides who acts and reads as evasion.
|
|
27
|
+
|
|
28
|
+
### Word choice
|
|
29
|
+
|
|
27
30
|
- Prefer direct verbs and plain words. Write `use` over `utilize`, `help` over `facilitate`, `is` over `serves as`.
|
|
28
31
|
- Drop marketing words: `seamless`, `robust`, `powerful`, `revolutionary`, `enhanced`, `allows`, and `leverage`. Each claims a quality without showing it, so state what the thing does and let the reader judge it.
|
|
29
32
|
- Drop vague qualifiers: `simply`, `just`, `easily`, `quickly`, `very`, and `really`. Cut the word where the sentence stands without it, and give the measurement where the degree matters.
|
|
33
|
+
|
|
34
|
+
### Stance and density
|
|
35
|
+
|
|
30
36
|
- Be direct on an established fact. Hedge on a genuinely uncertain claim and say which it is.
|
|
31
37
|
- Assume developer-level knowledge. Skip the explanation the reader already carries.
|
|
32
38
|
- Front-load the key information in a paragraph, and give every sentence something the reader did not have.
|
|
@@ -38,6 +44,9 @@ Uniform cadence is the tell that survives the cleanest ban scan. Measure it rath
|
|
|
38
44
|
- Read the paragraph as one block. Uniformity is audible and close to invisible line by line.
|
|
39
45
|
- Compare the longest and shortest sentence in a paragraph. Within roughly five words of each other means the paragraph has one cadence and needs a short sentence or a long one added.
|
|
40
46
|
- Count the opening word of each sentence. Two alike is coincidence and three is a pattern to break.
|
|
47
|
+
|
|
48
|
+
### Variety
|
|
49
|
+
|
|
41
50
|
- Vary the grammatical shape of the opening, not the word alone. Three sentences opening on three different subjects still share one shape.
|
|
42
51
|
- Never buy variety with a fragment. A verbless clause standing as a sentence trades one uniformity for another and is the failure these rules exist against.
|
|
43
52
|
- Use a substantive connective where the flow needs one, and never add a word for rhythm alone.
|
package/docs/agents/capture.md
CHANGED
|
@@ -46,6 +46,8 @@ Each source renders at `deviceScaleFactor` 2 with a transparent background, and
|
|
|
46
46
|
|
|
47
47
|
What is asserted is the font. The command reads the first family of each rendered element holding text inside the captured element, and fails when the browser did not resolve one of them, because a fallback face rewraps the block and silently changes the output. A generic keyword as the first family, such as `monospace` or `system-ui`, also fails with its own reason, since it resolves to a different font on each machine, though a quoted `"monospace"` is a family name and goes through the probe. An element holding no text skips the check, since there is nothing to rewrap. Sources therefore name a real font rather than relying on `monospace`. A source that cannot render reports its own line and exits 1 without dropping the rest of the batch.
|
|
48
48
|
|
|
49
|
+
The user agent sets `monospace` on `pre`, `code`, `kbd`, and `samp` and does not inherit the `body` font into them, so each needs its own `font-family`.
|
|
50
|
+
|
|
49
51
|
A run refuses before it reads anything else when `--selector` is absent, naming the flag and pointing at `--help`. Ordering it first is what keeps the message about the invocation: the source defaults to `assets`, so checking that first would answer `assets not found` from whatever directory the caller happened to be in and say nothing about the flag that was actually missing. That source default is a deliberate choice rather than one inherited from some general convention: a missing folder still refuses loud, naming the argument, once the flag check passes, where the selector's dropped default cropped the wrong region in silence.
|
|
50
52
|
|
|
51
53
|
The browser binary installs separately from the package. A first run does `bunx playwright install chromium` once, and a run that cannot launch one reports the engine's own remediation inside the frame and exits 1 rather than escaping as a stack trace.
|
package/docs/agents/commands.md
CHANGED
|
@@ -82,64 +82,64 @@ query = "button, a[href], input, select, textarea, [tabindex]"
|
|
|
82
82
|
|
|
83
83
|
Each domain exposes a consistent shape where applicable: `list`, `install`, `sync`, `create`. The page named beside a domain carries its flags, records, and refusals, and `canon <domain> --help --all` prints every subcommand's flags.
|
|
84
84
|
|
|
85
|
-
-
|
|
86
|
-
-
|
|
87
|
-
-
|
|
88
|
-
-
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
-
|
|
93
|
-
-
|
|
94
|
-
-
|
|
95
|
-
-
|
|
96
|
-
-
|
|
97
|
-
-
|
|
98
|
-
-
|
|
99
|
-
-
|
|
100
|
-
-
|
|
101
|
-
-
|
|
102
|
-
-
|
|
103
|
-
-
|
|
104
|
-
-
|
|
105
|
-
-
|
|
106
|
-
-
|
|
107
|
-
-
|
|
108
|
-
-
|
|
109
|
-
-
|
|
110
|
-
-
|
|
111
|
-
-
|
|
112
|
-
-
|
|
113
|
-
-
|
|
114
|
-
-
|
|
115
|
-
-
|
|
85
|
+
- **`migrate`**, in `migrate.md`: `rename`, `skill-names`, `records`, `surface-roots`, `record-tree`, `rule-layout`, `scratch-evidence`, `record-layout`
|
|
86
|
+
- **`targets`**, in `targets.md`: `list`, `pulls`
|
|
87
|
+
- **`gov`**, in `install-and-sync.md`: `list`, `install`, `sync`, `build`, `regen`, `detect` (in `gov-detect.md`), `test-order`, `counts`, `superseded`, `citations`, `restated`
|
|
88
|
+
- **`tooling`**, in `install-and-sync.md`: `list`, `sync`, `diff`, `reference`, `verify`, `inject`, `prune-gitignore`
|
|
89
|
+
- **`claude`**, in `skills-audit.md`: `init`, `sync`, `setup`, `routing`, `plugin-update`, `seeds list`, `skills list`, `skills audit`, `skills drift`, `skills reach`, `skills rank`
|
|
90
|
+
- **`wiki`**, in `scripting.md`: `init`
|
|
91
|
+
- **`indexes`**, in `indexes.md`: `regen`, `list`
|
|
92
|
+
- **`docs`**, in `docs.md`: `list`, `<topic>`
|
|
93
|
+
- **`design`**, in `install-and-sync.md` for `install`, `sync`, and `fonts`, and below for the rest: `render`, `regen`, `css`, `install`, `sync`, `fonts`
|
|
94
|
+
- **`slides`**, described below: `render`, `list`
|
|
95
|
+
- **`demo`**, in `demo.md`: `compile`, `run`, `frames`
|
|
96
|
+
- **`inventory`**, described above: `run`
|
|
97
|
+
- **`teach`**, in `teach.md`: `list`, `up`, `open`, `resource`, `glossary`, `lesson`, `stylesheet`, `nav`, `render`
|
|
98
|
+
- **`canvas`**, described below: `serve`, `list`, `page add`, `page rename`, `frame add`, `frame move`, `frame resize`, `fit`, `arrange`, `selection`, `edit`, `editing`, `capture`
|
|
99
|
+
- **`sandbox`**, in `sandbox.md`: `run`, `equivalence`, `reset`, `clean`, `check`, `coverage`
|
|
100
|
+
- **`tasks`**, in `tasks.md`: `next-label`, `archive`, `decline`, `plan-citations`, `plan-answers`, `plan-branch`, `plan-reach`, `plan-link`, `pull-request`, `outcome`, `list`, `validate`
|
|
101
|
+
- **`intake`**, in `intake.md`: `list`, `answer`
|
|
102
|
+
- **`records`**, in `records.md`: `validate`, `ordinal`, `size`, `stale`, `prune-tmp`, `push`, `pull`
|
|
103
|
+
- **`sessions`**, in `sessions.md`: `list`, `export`, `import`
|
|
104
|
+
- **`worktrees`**, in `worktrees.md`: `list`, `reclaim`, `repair-bare-flag` (hidden)
|
|
105
|
+
- **`hooks`**, in `hooks.md`: `post-merge`
|
|
106
|
+
- **`pr`**, in `pr-reads.md`: `key-changes`, `head`, `checks`, `review-state`, `evidence`, `preview`, `local`, `frames`, `lift` (in `pr-lift.md`), `tick` (in `pr-tick.md`)
|
|
107
|
+
- **`upstream`**, in `upstream.md`: `fetch`, `catalog`, `due`, `advance`
|
|
108
|
+
- **`audits`**, in `audits.md`: `run`, `list`
|
|
109
|
+
- **`gate`**, in `gate.md`: `run`
|
|
110
|
+
- **`secrets`**, in `state-scoped-risk.md`: `scan`
|
|
111
|
+
- **`deps`**, in `state-scoped-risk.md`: `audit`
|
|
112
|
+
- **`labels`**, in `label-coverage.md`: `audit`, `apply`, `scan`
|
|
113
|
+
- **`comments`**, in `comments.md`: `scan`
|
|
114
|
+
- **`context`**, in `context-audit.md`: `audit`, `classify diff`, `classify sweep`, `classifier show`, `classifier set`
|
|
115
|
+
- **`markdown`**, in `markdown-audit.md`: `audit`
|
|
116
116
|
|
|
117
117
|
Common patterns:
|
|
118
118
|
|
|
119
|
-
-
|
|
120
|
-
-
|
|
121
|
-
-
|
|
122
|
-
-
|
|
119
|
+
- **`list --json`** → machine-readable catalog on stdout.
|
|
120
|
+
- **`install <name> <path>`** → install a specific entry into a target project.
|
|
121
|
+
- **`sync <path>`** → reapply all installed entries in a target project.
|
|
122
|
+
- **`create [name]`** → scaffold a new authoring entry in this repo.
|
|
123
123
|
|
|
124
124
|
Subcommands no other page describes:
|
|
125
125
|
|
|
126
|
-
-
|
|
127
|
-
-
|
|
128
|
-
-
|
|
129
|
-
-
|
|
130
|
-
-
|
|
131
|
-
-
|
|
132
|
-
-
|
|
133
|
-
-
|
|
134
|
-
-
|
|
126
|
+
- **`claude plugin-update`** matches the installed marketplace plugin against `claude/.claude-plugin/plugin.json`'s own name and runs `claude plugin update` on it, reading the version back off `claude plugin list --json`, since the update call reports none of its own (`--json`).
|
|
127
|
+
- **`claude skills rank`** scores either skill corpus's descriptions against a case corpus by TF-IDF cosine similarity, reporting rank-one and top-three (`--cases <path>`).
|
|
128
|
+
- **`design regen`** rewrites this repository's `canon/DESIGN.md` from `src/design/tokens.ts` and `src/design/base.css` from `src/design/neutral.ts`. `design css` emits the tokens and components as CSS on stdout, with `--no-components` for properties alone, and `design render` declares each vendored face the typography table names under `--embed-fonts`.
|
|
129
|
+
- **`slides list --json`** emits one row per deck under `.canon/slides/`, carrying `name`, `title`, `slides`, and `path`.
|
|
130
|
+
- **`slides render [deck]`** takes a deck name or a folder, defaulting to the only deck, and lays out each `.html` file in filename order in Chromium at 1280 by 720 and rebuilds it as editable shapes. Each element drawn as a picture prints one `✗` line on stderr naming the slide, the selector, and the properties that forced it. A link left out, being a `#slide-N` past the deck's end or any target that is neither that nor an absolute URL, prints one too, and the exit stays 0.
|
|
131
|
+
- **`slides.md`** describes a deck folder's `deck.json` and the faces it embeds, its per-slide `<body>` attributes, transitions and entrances, speaker notes, and charts.
|
|
132
|
+
- **`canvas`**, with its verbs, content format, and write routes, is described in `canvas.md`.
|
|
133
|
+
- **`labels apply <number>`** adds the labels this branch earns to its open pull request, refusing a pull request whose head is not the current branch or that is not open, and never creating a label the remote lacks or removing one a person added (`--check` writes nothing and exits 2 when labels are owed, `--base`, `--json`).
|
|
134
|
+
- **`labels scan`** fails a pull request or a posted review whose title, body, or review comment carries a phase label, a label a code span quotes, a gitignored record path, a session link, a banned character, a body heading outside the closed section list or a missing `## Summary` or `## Key changes`, or a title breaking `claude/skills/git-pr/references/pr.md`'s format, casing, or length rule (`--event`, `--body-file`, `--json`).
|
|
135
135
|
|
|
136
136
|
## Version skew
|
|
137
137
|
|
|
138
|
-
`canon sync --check` and `canon claude skills drift` are the two moments a
|
|
139
|
-
already stops to reconcile with the toolkit, so each reports the
|
|
140
|
-
version against the newest published one. No other command performs
|
|
141
|
-
which keeps a registry round trip out of the catalog reads an agent
|
|
142
|
-
loop.
|
|
138
|
+
`canon sync --check` and `canon claude skills drift` are the two moments a
|
|
139
|
+
target already stops to reconcile with the toolkit, so each reports the
|
|
140
|
+
installed version against the newest published one. No other command performs
|
|
141
|
+
the lookup, which keeps a registry round trip out of the catalog reads an agent
|
|
142
|
+
runs in a loop.
|
|
143
143
|
|
|
144
144
|
The report carries three states and never changes an exit code. `behind` names
|
|
145
145
|
`canon upgrade` as the remedy, `current` says so, and `unknown` carries the
|
|
@@ -147,8 +147,8 @@ reason the registry could not be reached. Branch on the `skew.state` field in
|
|
|
147
147
|
the JSON record rather than on the exit, since an offline machine has to read as
|
|
148
148
|
unmeasured rather than as a failing check.
|
|
149
149
|
|
|
150
|
-
`canon upgrade --json` carries one further state, `pending`, that the skew
|
|
151
|
-
does not: the working directory's checkout holds a release npm does not
|
|
152
|
-
yet, so there is nothing to install. The record names it in `checkout`
|
|
153
|
-
`latest`, exits 0, and its `message` starts `CLI stays at`. Outside a
|
|
154
|
-
checkout it never reads `pending`.
|
|
150
|
+
`canon upgrade --json` carries one further state, `pending`, that the skew
|
|
151
|
+
report does not: the working directory's checkout holds a release npm does not
|
|
152
|
+
serve yet, so there is nothing to install. The record names it in `checkout`
|
|
153
|
+
beside `latest`, exits 0, and its `message` starts `CLI stays at`. Outside a
|
|
154
|
+
canon checkout it never reads `pending`.
|
|
@@ -17,6 +17,12 @@ It reports rather than gates by default, the closer call because a missing secti
|
|
|
17
17
|
|
|
18
18
|
`--gate` promotes the finding to a failing exit code, which the seed stage runs and no other caller does. That mode needs an answer to the sanctioned omission above, so a file declaring `stub: true` in its frontmatter is dropped before the check and reported nowhere. Both are described in `context-audit.md`.
|
|
19
19
|
|
|
20
|
+
### The closed set
|
|
21
|
+
|
|
22
|
+
The same section also reports an H2 outside the folder's closed set. A context entry allows `Overview`, `Layout`, `Decisions`, and `Gotchas` and no other H2, so a topic of the domain's own sits one level down as an H3. The finding is per entry rather than per folder, since an extra heading is a fact about the file carrying it. Fenced blocks are skipped, a stub seed is skipped, and only H2 is read, so where an H3 sits is not audited. It gates under `--gate` alone, like a missing section.
|
|
23
|
+
|
|
24
|
+
The record carries it as a top-level `extraSections` array of `{ rel, headings }`, and the set itself as `checkpoints.allowedSectionsByFolder`, keyed on the folder name the way `requiredSectionsByFolder` is. Both are additive.
|
|
25
|
+
|
|
20
26
|
## Reference form
|
|
21
27
|
|
|
22
28
|
The reference-form check reports an entry naming a sibling entry by bare filename where `claude/skills/context-fold/references/context.md` asks for the path it sits at. A bare name resolves against whichever folder its reader is already in, so a domain that splits into subfolders strands every inbound reference and the break surfaces nowhere. A path is checkable, which is what makes the form rule worth measuring at all: once a reference spells its path, the citation gate resolves it and a split that moves the file fails the push.
|
|
@@ -18,12 +18,12 @@ canon context audit --folder docs
|
|
|
18
18
|
canon context audit tooling/base/seeds --gate
|
|
19
19
|
```
|
|
20
20
|
|
|
21
|
-
| Option | Behavior
|
|
22
|
-
| ------------------ |
|
|
23
|
-
| `--json` | Add a machine-readable record on stdout, keeping the frame
|
|
24
|
-
| `--folder <list>` | Comma-separated folder names (default: the three below)
|
|
25
|
-
| `--citations-only` | Run the gating citation check alone, printing nothing when it passes
|
|
26
|
-
| `--gate` | Fail on a missing required section or index drift as well
|
|
21
|
+
| Option | Behavior |
|
|
22
|
+
| ------------------ | ------------------------------------------------------------------------- |
|
|
23
|
+
| `--json` | Add a machine-readable record on stdout, keeping the frame |
|
|
24
|
+
| `--folder <list>` | Comma-separated folder names (default: the three below) |
|
|
25
|
+
| `--citations-only` | Run the gating citation check alone, printing nothing when it passes |
|
|
26
|
+
| `--gate` | Fail on a missing required section, an off-set H2, or index drift as well |
|
|
27
27
|
|
|
28
28
|
`--citations-only` and `--gate` refuse together. The first runs the citation check alone, so the two findings the second adds are never measured, and a run honoring both would exit clean on a file short a required section.
|
|
29
29
|
|
|
@@ -39,11 +39,11 @@ A run where no requested name resolves refuses, whichever list it read. Naming t
|
|
|
39
39
|
|
|
40
40
|
Exit codes are `0` for a clean run, `1` for a refusal, and `2` for a gating finding. An unresolved citation gates under every mode. A requirements record stating a word cap gates past it, on any run that measures it, which is every mode except `--citations-only`. A record stating none is reported and never gated.
|
|
41
41
|
|
|
42
|
-
`bun run check` in the toolkit repository reads every one of these rules through its own Canonical records stage
|
|
42
|
+
`bun run check` in the toolkit repository reads every one of these rules through its own Canonical records stage as well as through this verb, whose gating stage there runs `--gate`.
|
|
43
43
|
|
|
44
44
|
Entry length, reference form, table, provenance, the record's claim classification, and every word figure no record caps print and return `0` under every mode, because each is a judgment or a weight read alongside one, and failing a push on either would make the check something to route around.
|
|
45
45
|
|
|
46
|
-
Required-section and index findings sit between the two. Both are answerable from the file rather than weighed, so `--gate` promotes them to failing codes while a bare run leaves them advisory. The toolkit runs the bare form against itself and the widened form against the seed tree, described below.
|
|
46
|
+
Required-section, off-set H2, and index findings sit between the two. Both are answerable from the file rather than weighed, so `--gate` promotes them to failing codes while a bare run leaves them advisory. The toolkit runs the bare form against itself and the widened form against the seed tree, described below.
|
|
47
47
|
|
|
48
48
|
## The seed gate
|
|
49
49
|
|
|
@@ -31,6 +31,8 @@ The regex layer always runs. It is free, needs nothing installed, and catches na
|
|
|
31
31
|
|
|
32
32
|
The local Ollama layer runs only when configured, through `canon context classifier`. When it runs, its call is one chunk or section per request, never batched: the groundwork measurement behind this verb found that batching 16 hunks into one call returned KEEP for every one of them. Thinking is always off, since it was measured to catch nothing thinking-off missed while running roughly five times slower and, in sweep mode, losing three real flags by reasoning past them.
|
|
33
33
|
|
|
34
|
+
Sweep mode reads decision rationale as current. A reason naming why an alternative was left out, what an earlier approach got wrong, what a measurement caught, or what a past run cost is KEEP even told in the past tense. Only a superseded figure kept beside its replacement, a "now" or "no longer" marking a change, branch or PR narration, or rounds of candidates is REWRITE.
|
|
35
|
+
|
|
34
36
|
A finding carries both layers' readings when the model ran. The `verdict` field takes the model's reading when it ran and parsed, and falls back to the regex reading otherwise, since the model catches shapes the regex layer cannot reach structurally. `decidedBy` names which one won.
|
|
35
37
|
|
|
36
38
|
A configured-but-unreachable backend warns on stderr and falls back to the regex layer alone. The run still exits clean: the record's `modelLayer` field names why the model layer did not run (`off`, `skipped-no-model`, `skipped-unreachable`, or `ran`), so a clean regex-only report never reads as a clean model pass.
|
|
@@ -101,7 +101,7 @@ rule on the far side of a window a later sync moved past it. The per-file
|
|
|
101
101
|
rule the chain lists reaches both surfaces the same way.
|
|
102
102
|
|
|
103
103
|
A target stamped before governance recorded a chain falls back to the older
|
|
104
|
-
|
|
104
|
+
rule-folder-inference read below. The measurement there anchors on governance's own
|
|
105
105
|
stamp rather than on the oldest anchor across domains, since rules are
|
|
106
106
|
domain-scoped and a shared anchor would let another domain's sync move the
|
|
107
107
|
revision rules are measured from. A target carrying no chain and no governance anchor
|
|
@@ -124,16 +124,16 @@ their own language and testing rules, and every other rule is opt-in, so an
|
|
|
124
124
|
unfiltered list would tell a base consumer about rules it can never receive and
|
|
125
125
|
train the reader to skip the section.
|
|
126
126
|
|
|
127
|
-
The filter accepts a
|
|
127
|
+
The filter accepts a rule folder on either of two grounds. A folder holding a rule the
|
|
128
128
|
base stack resolves to is entitled to every target, read through the stack file so
|
|
129
|
-
a rule added to base later needs no code change. Every other
|
|
129
|
+
a rule added to base later needs no code change. Every other rule folder is read off the folders the
|
|
130
130
|
target already carries, which is the fallback's only evidence of what a target
|
|
131
|
-
was entitled to before it recorded a chain. One
|
|
131
|
+
was entitled to before it recorded a chain. One rule folder can be reached by more than
|
|
132
132
|
one stack, so the test over-reports inside a folder the target holds, which
|
|
133
133
|
costs a line where under-reporting would cost the section its point.
|
|
134
134
|
|
|
135
135
|
A rule the target already holds is dropped by name. That is what keeps a rule the
|
|
136
|
-
toolkit moved between
|
|
136
|
+
toolkit moved between rule folders out of the list, since a rename reaches this
|
|
137
137
|
read as an addition and only the name tells the two apart.
|
|
138
138
|
|
|
139
139
|
This closes the dangling-citation case as a side effect rather than checking for
|
package/docs/agents/gate.md
CHANGED
|
@@ -9,16 +9,15 @@ description: Running the gate this repository verifies a branch with, what the s
|
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
11
|
canon gate run
|
|
12
|
-
canon gate run --all
|
|
12
|
+
canon gate run --all
|
|
13
13
|
canon gate run --json
|
|
14
14
|
```
|
|
15
15
|
|
|
16
|
-
| Option
|
|
17
|
-
|
|
|
18
|
-
| `--all`
|
|
19
|
-
| `--
|
|
20
|
-
| `--
|
|
21
|
-
| `--json` | Add a machine-readable record on stdout |
|
|
16
|
+
| Option | Behavior |
|
|
17
|
+
| ---------- | ----------------------------------------------------------------------------- |
|
|
18
|
+
| `--all` | Run every stage instead of scoping shell, types, and tests to the changed set |
|
|
19
|
+
| `--nested` | Suppress the outer frame when a calling script has already opened one |
|
|
20
|
+
| `--json` | Add a machine-readable record on stdout |
|
|
22
21
|
|
|
23
22
|
## What the command owns and what it runs
|
|
24
23
|
|
package/docs/agents/index.md
CHANGED
|
@@ -30,7 +30,7 @@ CLI catalog and invocation rules for agents, split by command domain. Start with
|
|
|
30
30
|
- [Intake](intake.md): Reading intake folder counts and items, the three read states an item can be in, landing a batch of selections in one cluster, the refusal reasons, and why a call is scoped to one file
|
|
31
31
|
- [Key changes bijection](key-changes.md): Comparing the files a pull request body's Key changes names against its own diff, the two directions and the split inside each that decides what is worth raising, the span rules the extractor was measured into, and the three refusals that separate a clean pass from a read that produced nothing
|
|
32
32
|
- [Label coverage](label-coverage.md): Reading a changed set against the pull request label map, the two tables it matches, how a gap is separated from a decision, and why an absent map is an answer
|
|
33
|
-
- [Markdown audit weight](markdown-audit-weight.md): The structural half of the markdown audit, being bullet and paragraph weight, run depth, the two cadence numbers, and the length ceiling, with the samples behind each checkpoint and why none of them gates
|
|
33
|
+
- [Markdown audit weight](markdown-audit-weight.md): The structural half of the markdown audit, being bullet and paragraph weight, bullet stacks, run depth, the two cadence numbers, and the length ceiling, with the samples behind each checkpoint and why none of them gates
|
|
34
34
|
- [Markdown audit](markdown-audit.md): Running the audit over any markdown path, where its bans and checkpoints are read from, what each check reports, and why the ban half gates while the structural half reports
|
|
35
35
|
- [Migrate](migrate.md): What each canon migrate verb moves and rewrites, what it refuses, the markers that keep an old spelling, and the idempotence check a second run gives
|
|
36
36
|
- [Output shape](output-shape.md): Two framed shapes every command renders into, how JSON and --names modes keep stdout clean, and the exit discipline that lets piped output drain
|
|
@@ -84,7 +84,7 @@ postdates a rule joining its stack still see that rule: the report reads the
|
|
|
84
84
|
target's current entitlement against its current tree rather than diffing
|
|
85
85
|
from an anchor a later sync could advance past the rule's own commit. A
|
|
86
86
|
target whose install predates the recorded chain falls back to the same
|
|
87
|
-
|
|
87
|
+
rule-folder-inference `newRules` uses in `canon sync --check`.
|
|
88
88
|
|
|
89
89
|
## Tooling diff and sync
|
|
90
90
|
|
|
@@ -137,7 +137,7 @@ since a target has no rule source of its own that ships nowhere.
|
|
|
137
137
|
It takes `--root <path>` and defaults to the toolkit root, prints nothing on success, and
|
|
138
138
|
reports the reason on stderr with exit 1 when the record names a stack or rule
|
|
139
139
|
that does not resolve. The Consumed copies stage of `bun run check` calls it and
|
|
140
|
-
asserts both the generated
|
|
140
|
+
asserts both the generated rule folders and the consumed copy are committed.
|
|
141
141
|
|
|
142
142
|
## Whole-project sync
|
|
143
143
|
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: Markdown audit weight
|
|
3
|
-
description: The structural half of the markdown audit, being bullet and paragraph weight, run depth, the two cadence numbers, and the length ceiling, with the samples behind each checkpoint and why none of them gates
|
|
3
|
+
description: The structural half of the markdown audit, being bullet and paragraph weight, bullet stacks, run depth, the two cadence numbers, and the length ceiling, with the samples behind each checkpoint and why none of them gates
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# Markdown audit weight
|
|
7
7
|
|
|
8
8
|
## Bullets, paragraphs, and depth
|
|
9
9
|
|
|
10
|
-
Bullet weight and depth are the checks that moved off `canon context audit`, carrying what they measured at the time. A top-level bullet reports past roughly
|
|
10
|
+
Bullet weight and depth are the checks that moved off `canon context audit`, carrying what they measured at the time. A top-level bullet reports past roughly 250 characters with continuation lines folded in and nested items left out. A run reports past roughly 40 rendered lines, measured at 80 columns, where a heading breaks one and so does a bold section marker taking the whole line at column zero, either ending in a colon, or holding one whole code span at any width, or running to 20 characters or fewer, skipping fenced blocks and exempting a flat peer list averaging under 130 characters a bullet and a run that is entirely table rows. Each file reports its longest run alone, so a second run past the checkpoint in the same file is never named.
|
|
11
11
|
|
|
12
12
|
Every weight and depth measure counts the text a reader is shown. A link reduces to its anchor text and an autolink drops whole, since no reader is shown either destination. A backticked path stays counted, which is where these measures part from the ban scan `markdown-audit.md` describes: that one blanks a code span so a standard quoting its own banned character does not report itself, and discounting the same span here would under-report a paragraph carrying several. One file holds both span sets and each answers its own question.
|
|
13
13
|
|
|
@@ -17,7 +17,7 @@ The paragraph check measures both halves of one rule. `markdown.md` caps a parag
|
|
|
17
17
|
|
|
18
18
|
A sentence boundary closes on terminal punctuation ahead of a capital or a code span. The capital is what keeps a version pin and a decimal from each reading as two sentences, and the code span is admitted beside it because a command name opening a sentence carries no capital to find.
|
|
19
19
|
|
|
20
|
-
The paragraph weight sits at 700 and the bullet weight at
|
|
20
|
+
The paragraph weight sits at 700 and the bullet weight at 250. Both shipped at 400, and the bullet number moved to 250 so the audit's warning and the `paragraph-growth` gate stage, which fails a bullet a branch adds or grows past it in a context entry, read one number. The paragraph number was borrowed from the bullet rule when the two checks landed together, and each has since been read against a sample of its own. They are separate checkpoints in the standard and separate patterns in the parser, so a read that moves one leaves the other where it is.
|
|
21
21
|
|
|
22
22
|
### The sample behind the paragraph number
|
|
23
23
|
|
|
@@ -46,6 +46,14 @@ That re-sample ran once the scan stopped counting link syntax as prose. Findings
|
|
|
46
46
|
|
|
47
47
|
A bullet, a heading, a table row, a blockquote, a blank line, and a fence each end a paragraph, so a heavy bullet is reported by the bullet check alone and never counted twice.
|
|
48
48
|
|
|
49
|
+
## Bullet stacks
|
|
50
|
+
|
|
51
|
+
A run of consecutive top-level bullets reports past 5. A blank line, an indented continuation, and a nested item do not break the run, and a paragraph, a heading, or any other column-zero line does. A fenced line is skipped without breaking it. The count is of items rather than weight, so it catches a catalog of short bullets the 250-character checkpoint above passes.
|
|
52
|
+
|
|
53
|
+
Two shapes are exempt. A run whose every item opens with a bold label or a link names its own subject per item and reads as a table of entries, and a numbered list states an order, so numbered items never count. `CHANGELOG.md` is exempt by name. Governance rules and `REQUIREMENT.md` sit outside the gate stage's scope rather than being exempted here, since a rule is one imperative per bullet.
|
|
54
|
+
|
|
55
|
+
The audit reports a stack and never fails on one. The `bullet-stacks` stage in `canon gate run` fails the push, for the reason the length ceiling does: the audit also runs on plans and groundwork records kept out of version control.
|
|
56
|
+
|
|
49
57
|
## Cadence
|
|
50
58
|
|
|
51
59
|
Uniform cadence is the failure a ban list cannot express. A ban set states negatives, and fragments, verbless clauses, and sentences that all run one length are each the absence of something, so no word added to a ban list reaches any of them. The shape layer already measured a bullet, a paragraph, and a run, and stopped one level above where that failure lives.
|
|
@@ -67,11 +67,11 @@ The heading-case measure reports a heading or a frontmatter `title` with a capit
|
|
|
67
67
|
|
|
68
68
|
### Weight, cadence, and length
|
|
69
69
|
|
|
70
|
-
Bullet and paragraph weight, run depth, the two cadence numbers, and the document length ceiling are each a judgment a reader settles rather than a fact a scan settles. What each measures, the samples behind its checkpoint, and why none of them gates are in `markdown-audit-weight.md`.
|
|
70
|
+
Bullet and paragraph weight, bullet stacks, run depth, the two cadence numbers, and the document length ceiling are each a judgment a reader settles rather than a fact a scan settles. What each measures, the samples behind its checkpoint, and why none of them gates are in `markdown-audit-weight.md`.
|
|
71
71
|
|
|
72
72
|
## Exit codes
|
|
73
73
|
|
|
74
|
-
Exit codes are `0` for a completed run with no gating finding, `1` for a refusal, `2` for a ban hit or a dead relative link, and `3` for a shipped ban set that arrived empty. A banned character and a relative link resolving to nothing on disk each fail the run, both facts a scan settles rather than a reader judging. Bullet, paragraph, and depth weight are judgments a reader settles, and cadence is a distribution whose healthy range moves with the surface, so all four report under every code. Length reports the same way, since the audit also runs on a plan kept out of version control, and the Document ceiling stage in `canon gate run` owns that verdict instead.
|
|
74
|
+
Exit codes are `0` for a completed run with no gating finding, `1` for a refusal, `2` for a ban hit or a dead relative link, and `3` for a shipped ban set that arrived empty. A banned character and a relative link resolving to nothing on disk each fail the run, both facts a scan settles rather than a reader judging. Bullet, paragraph, and depth weight are judgments a reader settles, and cadence is a distribution whose healthy range moves with the surface, so all four report under every code. A bullet stack, a run of more than 5 plain bullets, reports the same way, and the `bullet-stacks` stage in `canon gate run` owns its verdict. Length reports the same way, since the audit also runs on a plan kept out of version control, and the Document ceiling stage in `canon gate run` owns that verdict instead.
|
|
75
75
|
|
|
76
76
|
`3` is separate from `1` because the two want different responses from a caller. A refusal means no corpus was built, and the `Markdown bans` stage in `canon gate run` is right to report it as unmeasured rather than as a pass. An empty set means the corpus was walked and nothing was looked for, so that stage fails the push on `3` rather than skipping.
|
|
77
77
|
|
package/docs/agents/pr-frames.md
CHANGED
|
@@ -8,7 +8,7 @@ description: How canon pr frames pushes a UI review frame to a never-merged bran
|
|
|
8
8
|
`canon pr frames` gives a review comment an image it can embed. `review-ui`
|
|
9
9
|
drives a pull request's checklist and captures a frame per box, and a frame
|
|
10
10
|
on the reviewer's disk resolves for nobody else. The verb pushes one frame to
|
|
11
|
-
the `canon
|
|
11
|
+
the `canon/frames` branch and returns a link to its path there.
|
|
12
12
|
|
|
13
13
|
```bash
|
|
14
14
|
canon pr frames 1341 --add frames/3.png --box 3 --head <sha> --pass 20261002T154450Z --json
|
|
@@ -19,7 +19,7 @@ canon pr frames --prune 30 --json
|
|
|
19
19
|
|
|
20
20
|
## What it writes
|
|
21
21
|
|
|
22
|
-
|
|
22
|
+
An add writes `refs/heads/canon/frames` and no other ref. Every call goes
|
|
23
23
|
through the GitHub git data API, being blobs, trees, commits, and that one ref,
|
|
24
24
|
so nothing is checked out, no worktree is entered, and neither `main` nor any
|
|
25
25
|
branch a pull request holds is touched. The branch never merges.
|
|
@@ -36,7 +36,7 @@ box therefore writes a new file rather than replacing the image an earlier
|
|
|
36
36
|
comment shows, which matters when a preview is minted again at one head.
|
|
37
37
|
|
|
38
38
|
`link` uses the same `blob/<ref>/<path>?raw=true` form as the evidence comment,
|
|
39
|
-
naming the `canon
|
|
39
|
+
naming the `canon/frames` branch rather than a commit. Every drop rewrites the
|
|
40
40
|
branch, and a link pinned to a commit would stop resolving for every other pull
|
|
41
41
|
request's frames once GitHub collects the commit it names. A path link lives
|
|
42
42
|
exactly as long as its file, so it survives every rewrite that drops another
|
|
@@ -97,6 +97,20 @@ than that many days ago, in a single rewrite. It keeps one still open, one
|
|
|
97
97
|
reopened after closing, one closed exactly the given days ago, and one whose
|
|
98
98
|
state could not be read, listing that last kind under `unread`.
|
|
99
99
|
|
|
100
|
+
## The legacy branch
|
|
101
|
+
|
|
102
|
+
Frames lived on `canon-frames` before the rename to `canon/frames`. An add
|
|
103
|
+
never writes it. `--drop` and `--prune` also run against it after the
|
|
104
|
+
current branch, remove only, and delete it once empty. `--prune` drains it
|
|
105
|
+
as its pull requests expire, and `--drop` clears one pull request at once.
|
|
106
|
+
The record carries `legacy: true` when that
|
|
107
|
+
pass changed the ref, and its `removed` list folds both branches in, naming
|
|
108
|
+
a pull request once. A missing or unreadable legacy ref never fails a run
|
|
109
|
+
the current branch finished.
|
|
110
|
+
|
|
111
|
+
A link minted before the rename points at `blob/canon-frames/...` and keeps
|
|
112
|
+
resolving until its pull request has been closed 30 days or `--drop` runs.
|
|
113
|
+
|
|
100
114
|
This repository runs `--prune 30` daily from
|
|
101
115
|
`.github/workflows/pr-frames-cleanup.yml`. A frame's file stays on the branch
|
|
102
116
|
until its own pull request has been closed for 30 days, so a link in a review
|
|
@@ -67,12 +67,14 @@ The transcript and side folder land under `projects/<encoding>/`, where the enco
|
|
|
67
67
|
|
|
68
68
|
Exit codes: `0` the session was placed, `1` refused. The refusal carries one of these reasons:
|
|
69
69
|
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
70
|
+
| Reason | Meaning |
|
|
71
|
+
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
72
|
+
| `not-a-bundle` | the file is no gzip tarball, carries no manifest at format `1`, or names a path outside its own session, such as one climbing out with `..` or an absolute one |
|
|
73
|
+
| `other-repository` | the local `origin` differs from the one the bundle recorded |
|
|
74
|
+
| `exists` | the target transcript or side folder is already there, or any other project folder already holds a transcript for the id, which `--resume <id>` could reach first |
|
|
75
|
+
| `live-here` | the id is live in the local roster, so a second copy would fork it |
|
|
76
|
+
| `write-failed` | a write failed partway for a reason other than a copy appearing, such as a bundle carrying a file where it also needs a folder |
|
|
77
|
+
| `no-archive` | the running Bun predates `Bun.Archive` |
|
|
76
78
|
|
|
77
79
|
A write that fails partway removes every file this run placed and every folder it created before refusing, so a retry of the same bundle does not refuse on its own leftovers. Any path it could not remove is named in the message. A copy that appears between the existence check and the write refuses as `exists` on the same terms.
|
|
78
80
|
|
|
@@ -28,14 +28,22 @@ The audit reads the directory it is pointed at, defaulting to the cwd. `canon cl
|
|
|
28
28
|
|
|
29
29
|
Each check traces to a line in the standard.
|
|
30
30
|
|
|
31
|
-
|
|
31
|
+
### Folder and frontmatter
|
|
32
|
+
|
|
32
33
|
- Frontmatter `name` matching the folder name
|
|
33
34
|
- Frontmatter `description` present
|
|
34
35
|
- `description` under 1024 characters
|
|
35
36
|
- No `README.md` inside a skill folder
|
|
36
37
|
- Folder name in kebab-case
|
|
38
|
+
|
|
39
|
+
### Requirement and content
|
|
40
|
+
|
|
41
|
+
- `REQUIREMENT.md` present in every skill folder
|
|
37
42
|
- Each `REQUIREMENT.md` declaring `Gap` and `Must`, matched at any heading level
|
|
38
43
|
- No ISO date in `SKILL.md` or any file under `references/`, reported as `datedProvenance` in the JSON record's `findings`
|
|
44
|
+
|
|
45
|
+
### Practice, references, and family
|
|
46
|
+
|
|
39
47
|
- Each listed practice skill closing with `## Excuses and rebuttals`, `## Red flags`, and `## Before handing over`, and each skill on the wider ledger list carrying `references/adopted.md`, reported together as `practiceShape`
|
|
40
48
|
- Each file under `references/` running over 100 lines opening with a `## Contents` H2, reported as `referenceContents`
|
|
41
49
|
- Each skill under `claude/skills/` declaring a `metadata.family` that names a key in `checkpoints.families`, reported as `family`
|
package/docs/target/scenarios.md
CHANGED
|
@@ -52,4 +52,4 @@ A sync whose target sits below the git root knows it is writing into a subfolder
|
|
|
52
52
|
|
|
53
53
|
- It withholds `.github/`, since GitHub reads workflows only at the repository root, and names each withheld file. Run the subtree from a job in the root workflow instead, with `working-directory` set to the subtree path the sync prints, such as `working-directory: frontend`.
|
|
54
54
|
- It installs no dependencies and adds no scripts to a subtree without a `package.json`. It names what it skipped and ends on `run 'bun init' in <path>, then sync again`.
|
|
55
|
-
- The subtree carries no `check` script, since that lives in the root's base layer, so run `bun scripts/verify.ts` there. It skips the format
|
|
55
|
+
- The subtree carries no `check` script, since that lives in the root's base layer, so run `bun scripts/verify.ts` there. It skips the format phase a subtree does not declare, since the root runs them, and still fails on a missing lint, typecheck, or test script, the phases its stack's `scripts/verify.json` requires.
|
|
@@ -10,23 +10,25 @@ category: Agent surface
|
|
|
10
10
|
|
|
11
11
|
Each standard now lives at `references/<name>.md` in the skill that owns it. Load that skill and read the reference it names:
|
|
12
12
|
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- `
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
13
|
+
| Skill | Standards |
|
|
14
|
+
| ----------------- | ------------------------------------------------------------- |
|
|
15
|
+
| `task-board` | `board`, `tasks`, `tasks-decline` |
|
|
16
|
+
| `context-fold` | `context` |
|
|
17
|
+
| `canvas-board` | `canvas`, `design` |
|
|
18
|
+
| `docs-sync` | `docs`, `readme` |
|
|
19
|
+
| `draft-figure` | `figures`, `mermaid` |
|
|
20
|
+
| `create-rule` | `rule` |
|
|
21
|
+
| `create-skill` | `skill`, `skill-paths`, `skill-practice`, `skill-requirement` |
|
|
22
|
+
| `git-branch` | `branch`, `slug` |
|
|
23
|
+
| `git-commit` | `commit`, `versioning` |
|
|
24
|
+
| `git-pr` | `pr`, `publish` |
|
|
25
|
+
| `markdown-craft` | `markdown` |
|
|
26
|
+
| `teach-workspace` | `glossary`, `teach` |
|
|
27
|
+
| `plan-groundwork` | `groundwork`, `groundwork-spikes` |
|
|
28
|
+
| `plan-intake` | `intake` |
|
|
29
|
+
| `plan-feature` | `plan`, `plan-lifecycle` |
|
|
30
|
+
| `draft-ready` | `ready` |
|
|
31
|
+
| `draft-doc` | `requirements`, `wiki` |
|
|
32
|
+
| `session-map` | `session` |
|
|
31
33
|
|
|
32
34
|
One name moved under a new filename. `standard`, the shape of a standard itself, became `skill-reference.md` in `create-skill`, since the toolkit no longer ships a standards folder to hold one.
|
|
@@ -52,6 +52,9 @@ Work in Claude Code directly. It reads `CLAUDE.md` automatically and has full fi
|
|
|
52
52
|
- When the input is a pile of findings rather than one feature, invoke `canon:plan-intake` first. It files the dump into `.canon/intake/<nn>-<slug>/`, one item per finding carrying a problem measured against the tree, a proposed fix, and a verdict, then names which items are plan-ready, which need measuring, and which are already settled.
|
|
53
53
|
- When the backlog has grown past what anyone rereads, invoke `canon:backlog-triage`. It files one item per backlog row into an intake folder, suggesting decline, archive, keep, or promote and leaning toward decline, and once `canon:plan-intake-answer` has taken your answers, a second run applies the approved verdicts through the task verbs.
|
|
54
54
|
- When the current state is unmeasured and more than one approach is live, invoke `canon:plan-groundwork` first. It opens a track folder under `.canon/groundwork/<nn>-<slug>/` and ends in a decision, which may be to do nothing. Skip it when the approach is already settled.
|
|
55
|
+
|
|
56
|
+
Then plan and build:
|
|
57
|
+
|
|
55
58
|
- Invoke `canon:plan-feature` to scan for code-level conflicts and ambiguities, confirm approach before proceeding
|
|
56
59
|
- Implement the feature, then Claude Code runs the commands defined in `CLAUDE.md`, fixes failures, and iterates until all pass
|
|
57
60
|
- For UI changes, invoke `canon:ui-checklist` to write what a reviewer has to look at and name any behavior shipping without a test
|