@erclx/canon 5.31.0 → 5.32.0

package/docs/agents/review-classification.md

@@ -1,76 +0,0 @@
----
-title: Review classification
-description: Deciding whether a changed set needs the review pass, the two tests it runs, why an empty set refuses rather than skipping, and the written fallback a target on an older binary falls back to
----
-
-# Review classification
-
-`canon autoship classify` answers the one decision the ship chain used to make by reading a bulleted list out of a skill body. It takes the names a branch changed and returns whether the review pass can be skipped, which file decided it, and which of the two tests that file failed.
-
-```bash
-canon autoship classify docs/index.md README.md
-canon autoship classify --json .claude/skills/deploy-check/SKILL.md
-```
-
-| Option   | Behavior                                                   |
-| -------- | ---------------------------------------------------------- |
-| `--json` | Add a machine-readable record on stdout, keeping the frame |
-
-Positional paths are the whole input. The verb never touches git, so it reads no baseline of its own and the caller hands over the set it already computed. A second read here could resolve a different range than the one the chain measured, which is the stale-baseline failure a prior row closed.
-
-Under `--json` the record holds stdout alone and the frame still renders on stderr, refusals included, which is the split `output-shape.md` fixes for every mode.
-
-## The two tests
-
-A branch skips review only when both hold across every changed name:
-
-- **Every path reads as prose.** The extension is `.md` or `.txt`, compared lowercased. Anything else is code, a config, or an asset.
-- **No path sits under a behavior path.** Markdown under one of those surfaces states what an agent does, so a change there is a behavior change wearing a prose extension.
-
-One failing file sends the whole branch to review. Documentation shipped beside a behavior change does not cancel it.
-
-The record names the first file to fail, tested in the caller's own order, and each file is read for its extension before its path. A set failing both tests reports one file and one test, which is all a caller needs to route.
-
-## The behavior paths
-
-Most carry two spellings, the one a surface authors at and the one it reaches a session at, so the rule reads the same in this toolkit and in a project that consumed one.
-
-| Surface           | Spellings                             |
-| ----------------- | ------------------------------------- |
-| Plugin skills     | `claude/skills/`, `.claude/skills/`   |
-| Governance rules  | `governance/rules/`, `.claude/rules/` |
-| Standards         | `standards/`                          |
-| Internal and seed | `internal/`, `tooling/`               |
-| Root instructions | `CLAUDE.md`                           |
-
-`standards/` carries one spelling. It never installs into a project, reaching a reader by resolution, so there is no consumed copy to name.
-
-`CLAUDE.md` is matched as a whole path rather than as a prefix, because a prefix reaches nothing that sits in no folder. A nested `docs/CLAUDE.md` stays informational.
-
-The set is data at `src/autoship/paths.ts`. That makes it permanently exempt from any later design that folds a machine-parsed list back into the surface citing it, per the toolkit's machine-parsed clause: a rule restating the list a parser reads is two sources for one list.
-
-## Exit codes and refusals
-
-| Code | Meaning                                                      |
-| ---- | ------------------------------------------------------------ |
-| `0`  | prose-only, so the review pass can be skipped                |
-| `1`  | refused, with `reason` naming the cause                      |
-| `2`  | review is needed, with `file` and `test` naming what decided |
-
-Branch on the record's `decision` rather than on the exit code. A shell function wrapping `canon` takes its status from whatever it runs last, so every non-zero exit can reach a caller as zero.
-
-An empty set refuses with `no-changes` rather than skipping. Both tests are universally quantified, so an empty set satisfies them vacuously, and reading that as prose-only would route a branch past review for having produced no output at all.
-
-## Why it is a verb
-
-The decision was three sentences in `auto-ship`'s review step, applied by a session reading a bulleted list of paths. It failed three times. A driven arm on 2026-08-30 staged `.claude/skills/deploy-check/SKILL.md`, which that list names, and the chain skipped review and opened a draft pull request anyway. The rule was correct and the session did not apply it, and the two fixes before that one were each a rewrite of the same prose.
-
-A rule a session can talk itself out of moves into a verb. That is the same argument the quiz-order draw in `canon teach lesson` was decided on: an instruction is a hope where a verb is a check.
-
-## The written fallback
-
-The verb ships with the CLI and Step 6 ships with the plugin, so a target holding an older binary meets a missing subcommand. The skill body keeps the written list and applies it by hand there, naming which of the two decided the run.
-
-The fallback is never a skip. Failing open is the exact defect the verb closes, so a body that skips on anything other than a `skip` record would ship every branch unreviewed the moment the subcommand went absent.
-
-Two copies of the path set is what the fallback costs, and it stands until a release retires the written half.

package/governance/rules/canon/603-memory.md

@@ -1,11 +0,0 @@
----
-description: Keep memory writes scoped to .canon/memory/ and out of context-owned domains
----
-
-# Memory standards
-
-## Writing memory
-
-- Write all memory files to `.canon/memory/`, not `~/.claude/projects/`
-- A fact about a domain goes to that domain's `canon/context/` entry, not to memory. `canon:memory-capture` routes it there and `canon:context-fold` folds it in. Memory keeps only what no context entry owns. Report it rather than proceeding silently when either skill does not resolve. Both ship with the plugin and this rule ships with the CLI, so a project that installed governance alone does not have them.
-- Never delete a memory entry. Retire one by moving it to `.canon/memory/archive/`, which `canon records push` backs. A bulk retire runs through the shell, where no file edit fires a path-scoped rule.

package/governance/rules/lang/120-bash.md

@@ -1,18 +0,0 @@
----
-description: Route bash script authoring to the wrapper skill, and name the lint gate
-paths:
-  - '**/*.sh'
----
-
-# Bash standards
-
-## Skill routing
-
-- Use `canon:bash-cli-script` before writing a script, and follow its guards on what a shell script may be.
-- Load the skill's own reference template rather than hand-rolling logging patterns outside it.
-- Report it rather than proceeding silently when the skill does not resolve. It ships with the plugin and this rule ships with the CLI, so a project that installed governance alone does not have it.
-
-## Lint gate
-
-- Format with `shfmt --write --indent 2` and lint with `shellcheck --severity=warning` before committing a script.
-- Fix a shellcheck finding at the source. Suppress one with a directive comment only for a genuine false positive, and state why beside the suppression.

package/governance/rules/standards/architecture.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/architecture.md. Edit that frontmatter, not this file.
-description: Shape and content rules for canon/ARCHITECTURE.md
-paths:
-  - 'canon/ARCHITECTURE.md'
----
-
-# Architecture standards
-
-## Authority
-
-- Follow the architecture standard for shape and content rules for canon/ARCHITECTURE.md. It is the single source. Read it with `canon standards architecture`.
-- Add a decision here only when it fills one of the standard's slots, and write any other decision into the context entry for the domain it constrains. At the record's stated cap, merge or retire an entry before adding one.

package/governance/rules/standards/groundwork.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/groundwork.md. Edit that frontmatter, not this file.
-description: Folder layout, ordinal naming, reserved numbering, frontmatter and dating, required file contents, and conventions for a measurement track
-paths:
-  - '.canon/groundwork/**'
----
-
-# Groundwork standards
-
-## Authority
-
-- Follow the groundwork standard for folder layout, ordinal naming, reserved numbering, frontmatter and dating, required file contents, and conventions for a measurement track. It is the single source. Read it with `canon standards groundwork`.
-- Follow the groundwork spikes standard for `08-spikes.md` and the folders holding what a spike produced. Read it with `canon standards groundwork-spikes`.

package/governance/rules/standards/intake.md

@@ -1,12 +0,0 @@
----
-# Generated by `canon gov regen` from standards/intake.md. Edit that frontmatter, not this file.
-description: Folder layout, ordinal naming, reserved index number, frontmatter and dating, the item template, the answer contract, and retrieval
-paths:
-  - '.canon/intake/**'
----
-
-# Intake standards
-
-## Authority
-
-- Follow the intake standard for folder layout, ordinal naming, reserved index number, frontmatter and dating, the item template, the answer contract, and retrieval. It is the single source. Read it with `canon standards intake`.

package/governance/rules/standards/memory.md

@@ -1,12 +0,0 @@
----
-# Generated by `canon gov regen` from standards/memory.md. Edit that frontmatter, not this file.
-description: Filename and type prefix, frontmatter, the body shape per type, links between entries, and the lifecycle from write to retire
-paths:
-  - '.canon/memory/**'
----
-
-# Memory standards
-
-## Authority
-
-- Follow the memory standard for filename and type prefix, frontmatter, the body shape per type, links between entries, and the lifecycle from write to retire. It is the single source. Read it with `canon standards memory`.

package/governance/rules/standards/ready.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/ready.md. Edit that frontmatter, not this file.
-description: Folder layout, ordinal naming, the overview frontmatter, the thin-plan contract, and the archive lifecycle for a finished-file handoff
-paths:
-  - '.canon/ready/**'
----
-
-# Ready standards
-
-## Authority
-
-- Follow the ready standard for folder layout, ordinal naming, the overview frontmatter, the thin-plan contract, and the archive lifecycle for a finished-file handoff. It is the single source. Read it with `canon standards ready`.
-- Load the `canon:draft-ready` skill to write a ready folder, its overview, the thin plan, and the task row. It owns the procedure. Report it rather than proceeding silently when it does not resolve, since it ships with the plugin and this rule ships with the CLI.

package/governance/rules/standards/requirements.md

@@ -1,12 +0,0 @@
----
-# Generated by `canon gov regen` from standards/requirements.md. Edit that frontmatter, not this file.
-description: Shape and content rules for canon/REQUIREMENTS.md
-paths:
-  - 'canon/REQUIREMENTS.md'
----
-
-# Requirements standards
-
-## Authority
-
-- Follow the requirements standard for shape and content rules for canon/REQUIREMENTS.md. It is the single source. Read it with `canon standards requirements`.

package/governance/rules/standards/session.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/session.md. Edit that frontmatter, not this file.
-description: Filename and location, the sections a handoff carries, the write and read procedures, and how a role extends it
-paths:
-  - '.canon/tasks/session-*.md'
----
-
-# Session map standards
-
-## Authority
-
-- Follow the session standard for filename and location, the sections a handoff carries, the write and read procedures, and how a role extends it. It is the single source. Read it with `canon standards session`.
-- Follow this rule rather than the tasks rule for a `session-` file. A handoff is not a task and carries neither `## Outcomes` nor `## Findings`.

package/governance/rules/standards/tasks.md

@@ -1,15 +0,0 @@
----
-# Generated by `canon gov regen` from standards/tasks.md. Edit that frontmatter, not this file.
-description: Folder layout, filename convention, file format, origin lines, and archiving for task files under .canon/tasks/
-paths:
-  - '.canon/tasks/**'
----
-
-# Tasks standards
-
-## Authority
-
-- Follow the tasks standard for folder layout, filename convention, file format, origin lines, and archiving for task files under .canon/tasks/. It is the single source. Read it with `canon standards tasks`.
-- Follow the board standard for `priority.md` and `backlog.md`, their readiness groups, and row order. Read it with `canon standards board`.
-- Never hand-edit `.canon/tasks/index.md`. A hook regenerates it from sibling frontmatter.
-- Follow the task decline standard for a task decided against. Read it with `canon standards tasks-decline`.

package/governance/rules/standards/teach.md

@@ -1,14 +0,0 @@
----
-# Generated by `canon gov regen` from standards/teach.md. Edit that frontmatter, not this file.
-description: Workspace layout, ordinal naming, frontmatter, and the mission and learning-record formats for a learning workspace
-paths:
-  - '.canon/teach/**'
----
-
-# Teach standards
-
-## Authority
-
-- Follow the teach standard for workspace layout, ordinal naming, frontmatter, and the mission and learning-record formats for a learning workspace. It is the single source. Read it with `canon standards teach`.
-- Follow the glossary standard for the glossary every workspace carries at its root. It is the single source for the entry shape, the ordering, and which terms the file carries. Read it with `canon standards glossary`.
-- Report it rather than proceeding silently when that file does not resolve. It ships with the plugin and this rule ships with the CLI, so a project that installed governance alone does not have it.

package/governance/rules/standards/wiki.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/wiki.md. Edit that frontmatter, not this file.
-description: Folder split, frontmatter, naming convention, and sourcing for a wiki reference page
-paths:
-  - 'wiki/**/*.md'
----
-
-# Wiki standards
-
-## Authority
-
-- Follow the wiki standard for folder split, frontmatter, naming convention, and sourcing for a wiki reference page. It is the single source. Read it with `canon standards wiki`.
-- Read it before drafting a page. Do not work the placement criterion or the naming convention from memory.

package/governance/rules/standards/wireframes.md

@@ -1,13 +0,0 @@
----
-# Generated by `canon gov regen` from standards/wireframes.md. Edit that frontmatter, not this file.
-description: Shape and content rules for canon/wireframes/<surface>.md files
-paths:
-  - 'canon/wireframes/**'
----
-
-# Wireframe standards
-
-## Authority
-
-- Follow the wireframes standard for shape and content rules for canon/wireframes/<surface>.md files. It is the single source. Read it with `canon standards wireframes`.
-- Read it before adding or revising a surface.

package/src/autoship/classify.ts

@@ -1,75 +0,0 @@
-import {
-  BEHAVIOR_FILES,
-  BEHAVIOR_PREFIXES,
-  PROSE_EXTENSIONS,
-} from '@/autoship/paths'
-
-/**
- * Which of the two tests a file failed.
- *
- * Named apart rather than folded into one boolean, because the repair differs.
- * A non-prose extension means the branch carries code and review is ordinary. A
- * behavior path means prose that states what an agent does, which is the half
- * three sessions read past.
- */
-export type FailedTest = 'extension' | 'behavior-path'
-
-/** Why a classification produced no reading. */
-export type ClassifyRefusal = 'no-changes'
-
-export type Classification =
-  | { readonly kind: 'skip' }
-  | {
-      readonly kind: 'review'
-      readonly test: FailedTest
-      readonly file: string
-    }
-  | { readonly kind: 'refused'; readonly reason: ClassifyRefusal }
-
-/**
- * Prefix-anchored against the folders, matching how `resolveCoverage` reads the
- * label map, and equality against the whole paths a prefix cannot reach.
- */
-function underBehaviorPath(path: string): boolean {
-  if (BEHAVIOR_FILES.some((file) => file === path)) return true
-  return BEHAVIOR_PREFIXES.some((prefix) => path.startsWith(prefix))
-}
-
-function readsAsProse(path: string): boolean {
-  const lowered = path.toLowerCase()
-  return PROSE_EXTENSIONS.some((extension) => lowered.endsWith(extension))
-}
-
-/**
- * Decides whether a branch's changed set skips the review pass.
- *
- * The skip needs both tests to pass: every name reads as prose, and no name
- * sits under a behavior path. One behavior file sends the whole branch to
- * review, since documentation shipped beside a behavior change does not cancel
- * it.
- *
- * An empty set refuses rather than skipping. Both tests are universally
- * quantified, so an empty set satisfies them vacuously, and reading that as
- * prose-only would route a branch past review for having produced no output at
- * all.
- *
- * Names only. The caller hands the set the ship chain already computed, so no
- * second baseline is read here and the stale-baseline half stays closed.
- */
-export function classifyChanges(paths: readonly string[]): Classification {
-  if (paths.length === 0) return { kind: 'refused', reason: 'no-changes' }
-
-  // First failure in the caller's order wins, and each file is tested for its
-  // extension before its path. A set failing both tests reports one file and
-  // one test, which is all the branch needs to route.
-  for (const path of paths) {
-    if (!readsAsProse(path)) {
-      return { kind: 'review', test: 'extension', file: path }
-    }
-    if (underBehaviorPath(path)) {
-      return { kind: 'review', test: 'behavior-path', file: path }
-    }
-  }
-
-  return { kind: 'skip' }
-}

package/src/autoship/paths.ts

@@ -1,50 +0,0 @@
-/**
- * The surfaces where markdown states what an agent does, and the extensions
- * that read as prose, held as data one command parses.
- *
- * Lifted verbatim in content from the list `auto-ship` Step 6 carried, whose
- * written fallback copy now sits in `auto-ship/references/verb-absent.md`,
- * which a session was asked to apply by hand. It failed that
- * application three times, so the set moved here and the body now calls a verb
- * that reads it. Being machine-parsed makes it permanently exempt from any
- * later design that folds a standard back into the surface citing it, per the
- * machine-parsed clause in `canon/context/standards/resolution.md`.
- */
-
-/**
- * Path prefixes under which a markdown change is a behavior change.
- *
- * Most carry two spellings, the one a surface authors at and the one it reaches
- * a session at, so the rule reads the same in this toolkit and in a project
- * that consumed one. `standards/` carries one: it never installs into a
- * project, reaching a reader by resolution, so no `.claude/` spelling exists
- * to name.
- */
-export const BEHAVIOR_PREFIXES = [
-  'claude/skills/',
-  '.claude/skills/',
-  'governance/rules/',
-  '.claude/rules/',
-  'standards/',
-  'internal/',
-  'tooling/',
-] as const
-
-/**
- * Behavior surfaces named as whole paths rather than as prefixes.
- *
- * A path prefix reaches nothing that sits in no folder, which is what the root
- * instruction file is. Matching is equality rather than a suffix test, so a
- * nested `docs/CLAUDE.md` stays informational the way the body's "at the
- * repository root" qualifier says it should.
- */
-export const BEHAVIOR_FILES = ['CLAUDE.md'] as const
-
-/**
- * Extensions a changed file may carry for the branch to read as prose-only.
- *
- * Compared lowercased, so a `README.MD` is not routed to review for its
- * spelling. Everything else is code, a config, or an asset, and one of them
- * sends the whole branch to review.
- */
-export const PROSE_EXTENSIONS = ['.md', '.txt'] as const

package/src/commands/autoship.ts

@@ -1,129 +0,0 @@
-import type { Command } from 'commander'
-import {
-  type ClassifyRefusal,
-  type FailedTest,
-  classifyChanges,
-} from '@/autoship/classify'
-import { intro, logInfo, logStep, logWarn, outro, plural } from '@/cli/ui'
-
-interface ClassifyOptions {
-  readonly json?: boolean
-}
-
-/** What a reader does about the one way the classification produced no reading. */
-const REFUSALS: Record<ClassifyRefusal, string> = {
-  'no-changes':
-    'No changed files were supplied, so there is no set to classify. Pass the set the ship chain already computed.',
-}
-
-/** Why each failed test sends the branch to review, in the reader's terms. */
-const TESTS: Record<FailedTest, string> = {
-  extension: 'is not prose, so this branch carries a change review reads',
-  'behavior-path':
-    'sits under a behavior path, so its prose states what an agent does',
-}
-
-export function register(program: Command): void {
-  const autoship = program
-    .command('autoship')
-    .description('Answer the decisions the ship chain used to make in prose')
-    .helpOption('-h, --help', 'Show this help message')
-
-  autoship
-    .command('classify')
-    .description('Decide whether a changed set needs the review pass')
-    .argument('[paths...]', 'Changed set to classify, as names')
-    .helpOption('-h, --help', 'Show this help message')
-    .option('--json', 'Add a machine-readable record on stdout')
-    .addHelpText(
-      'after',
-      [
-        '',
-        'Reads names only and never touches git, so the caller hands over the',
-        'set it already computed rather than paying for a second baseline that',
-        'can disagree with the first.',
-        '',
-        'The skip needs both tests to pass. Every name reads as prose, and no',
-        'name sits under a behavior path, which is where markdown states what',
-        'an agent does. One behavior file sends the whole branch to review,',
-        'since documentation shipped beside a behavior change does not cancel',
-        'it.',
-        '',
-        'An empty set refuses rather than skipping. Both tests are universally',
-        'quantified, so an empty set satisfies them vacuously, and reading that',
-        'as prose-only would route a branch past review for producing no output.',
-        '',
-        'Exit codes:',
-        '  0  prose-only, so the review pass can be skipped',
-        '  1  refused, with the reason on stderr or in the JSON record',
-        '  2  review is needed, with the file and the test it failed named',
-        '',
-        'Examples:',
-        '  canon autoship classify docs/index.md README.md',
-        '  canon autoship classify --json .claude/skills/deploy-check/SKILL.md',
-        '',
-      ].join('\n'),
-    )
-    .action((paths: string[], opts: ClassifyOptions) => {
-      process.exitCode = runClassify(paths, opts)
-    })
-}
-
-function runClassify(paths: string[], opts: ClassifyOptions): number {
-  const emitJson = opts.json ?? false
-  const result = classifyChanges(paths)
-
-  intro('canon autoship classify')
-
-  // The frame renders on stderr in both modes and the record goes to stdout
-  // alone, so an operator reading the terminal sees the refusal rather than a
-  // command that appeared to do nothing.
-  if (result.kind === 'refused') {
-    logStep('Refused')
-    logWarn(REFUSALS[result.reason])
-    outro()
-
-    if (emitJson) {
-      process.stdout.write(
-        `${JSON.stringify({
-          decision: 'refused',
-          reason: result.reason,
-          message: REFUSALS[result.reason],
-        })}\n`,
-      )
-    }
-    return 1
-  }
-
-  logStep('Scope')
-  logInfo(`${plural(paths.length, 'path')} supplied by the caller`)
-
-  if (result.kind === 'skip') {
-    logStep('Prose only')
-    logInfo('every path reads as prose and none states agent behavior')
-    outro()
-
-    if (emitJson) {
-      process.stdout.write(
-        `${JSON.stringify({ decision: 'skip', changed: paths })}\n`,
-      )
-    }
-    return 0
-  }
-
-  logStep('Review')
-  logWarn(`${result.file} ${TESTS[result.test]}.`)
-  outro()
-
-  if (emitJson) {
-    process.stdout.write(
-      `${JSON.stringify({
-        decision: 'review',
-        test: result.test,
-        file: result.file,
-        changed: paths,
-      })}\n`,
-    )
-  }
-  return 2
-}