@erclx/canon 5.34.0 → 5.36.0

package/src/standards/read.ts

@@ -1,177 +0,0 @@
-import { existsSync, readdirSync, readFileSync } from 'node:fs'
-import { basename, join } from 'node:path'
-import { stripFrontmatter } from '@/markdown/frontmatter'
-import { PROJECT_ROOT } from '@/roots/project'
-
-export const INDEX_FILE = 'index.md'
-
-/** The folder a repository authors standards in, toolkit or project alike. */
-export function standardsSourceDir(root: string): string {
-  return join(root, 'standards')
-}
-
-/**
- * Spells the package root in a report where every other root spells a
- * project-relative path. The `source` field promises a path inside the project
- * and a package copy is the one source that promise cannot cover, so the
- * spelling has to be one nothing will join to a project root.
- */
-const PACKAGE_LABEL = '<canon>'
-
-export interface StandardRoot {
-  /** Absolute directory to search. */
-  readonly dir: string
-  /** How a report spells a copy found under this root. */
-  readonly label: string
-}
-
-export interface ResolvedStandard {
-  readonly path: string
-  /** The label of the root that won, joined to the filename. */
-  readonly source: string
-}
-
-/**
- * The roots a standard resolves against. No toolkit standard installs into a
- * project any more, so `.claude/standards/` is gone from the list, no repository
- * generates one, and a target
- * carries neither entry below: the package corpus is the only root that
- * answers there, which is what leaves no precedence to reason about.
- *
- * The authoring root stays ahead of the package corpus for the repository that
- * writes standards, where an edit in progress has to win over the copy
- * `package.json` shipped. A project that authors standards of its own is the
- * same case under the same folder.
- */
-export function standardRoots(root: string): StandardRoot[] {
-  return [
-    { dir: standardsSourceDir(root), label: 'standards' },
-    {
-      dir: standardsSourceDir(PROJECT_ROOT),
-      label: join(PACKAGE_LABEL, 'standards'),
-    },
-  ]
-}
-
-/**
- * Standards retired into the skill reference that took them, keyed by name with
- * a path relative to the package root. Each retirement adds one line, and the
- * map goes with the verb in the last slice of the retirement.
- */
-const MOVED_STANDARDS: Readonly<Record<string, string>> = {
-  board: 'claude/skills/task-board/references/board.md',
-  context: 'claude/skills/context-fold/references/context.md',
-  design: 'claude/skills/canvas-board/references/design.md',
-  docs: 'claude/skills/docs-sync/references/docs.md',
-  figures: 'claude/skills/draft-figure/references/figures.md',
-  readme: 'claude/skills/docs-sync/references/readme.md',
-  rule: 'claude/skills/create-rule/references/rule.md',
-  skill: 'claude/skills/create-skill/references/skill.md',
-  branch: 'claude/skills/git-branch/references/branch.md',
-  commit: 'claude/skills/git-commit/references/commit.md',
-  pr: 'claude/skills/git-pr/references/pr.md',
-  publish: 'claude/skills/git-pr/references/publish.md',
-  slug: 'claude/skills/git-branch/references/slug.md',
-  versioning: 'claude/skills/git-commit/references/versioning.md',
-  markdown: 'claude/skills/markdown-craft/references/markdown.md',
-  canvas: 'claude/skills/canvas-board/references/canvas.md',
-  glossary: 'claude/skills/teach-workspace/references/glossary.md',
-  groundwork: 'claude/skills/plan-groundwork/references/groundwork.md',
-  'groundwork-spikes':
-    'claude/skills/plan-groundwork/references/groundwork-spikes.md',
-  intake: 'claude/skills/plan-intake/references/intake.md',
-  mermaid: 'claude/skills/draft-figure/references/mermaid.md',
-  plan: 'claude/skills/plan-feature/references/plan.md',
-  'plan-lifecycle': 'claude/skills/plan-feature/references/plan-lifecycle.md',
-  ready: 'claude/skills/draft-ready/references/ready.md',
-  requirements: 'claude/skills/draft-doc/references/requirements.md',
-  'skill-paths': 'claude/skills/create-skill/references/skill-paths.md',
-  'skill-practice': 'claude/skills/create-skill/references/skill-practice.md',
-  session: 'claude/skills/session-map/references/session.md',
-  'skill-requirement':
-    'claude/skills/create-skill/references/skill-requirement.md',
-  tasks: 'claude/skills/task-board/references/tasks.md',
-  'tasks-decline': 'claude/skills/task-board/references/tasks-decline.md',
-  teach: 'claude/skills/teach-workspace/references/teach.md',
-  wiki: 'claude/skills/draft-doc/references/wiki.md',
-}
-
-/**
- * The package-relative path a retired standard now lives at, so a caller that
- * resolves against a root of its own tests the same map the verb reads.
- */
-export function movedStandardPath(name: string): string | undefined {
-  if (!Object.hasOwn(MOVED_STANDARDS, name)) return undefined
-
-  return MOVED_STANDARDS[name]
-}
-
-function filename(name: string): string {
-  return name.endsWith('.md') ? name : `${name}.md`
-}
-
-/** Resolves a standard by name, with or without the extension. */
-export function resolveStandard(
-  root: string,
-  name: string,
-): ResolvedStandard | undefined {
-  const file = filename(name)
-
-  for (const { dir, label } of standardRoots(root)) {
-    const path = join(dir, file)
-    if (existsSync(path)) return { path, source: join(label, file) }
-  }
-
-  const movedName = basename(file, '.md')
-  if (!Object.hasOwn(MOVED_STANDARDS, movedName)) return undefined
-
-  const moved = MOVED_STANDARDS[movedName]
-  if (!moved) return undefined
-
-  const path = join(PROJECT_ROOT, moved)
-  if (!existsSync(path)) return undefined
-
-  return { path, source: join(PACKAGE_LABEL, moved) }
-}
-
-/**
- * Names every standard a resolve could reach, deduplicated across the roots and
- * sorted. Shown when a name misses, so it doubles as the answer to what the
- * caller should have typed.
- */
-export function listStandards(root: string): string[] {
-  const names = new Set<string>()
-
-  for (const { dir } of standardRoots(root)) {
-    if (!existsSync(dir)) continue
-
-    for (const entry of readdirSync(dir, { withFileTypes: true })) {
-      if (!entry.isFile()) continue
-      if (!entry.name.endsWith('.md')) continue
-      if (entry.name === INDEX_FILE) continue
-
-      names.add(basename(entry.name, '.md'))
-    }
-  }
-
-  for (const name of Object.keys(MOVED_STANDARDS)) names.add(name)
-
-  return [...names].sort()
-}
-
-/**
- * Pairs each listed name with the copy a resolve would read, so a catalog shows
- * what `canon standards <name>` prints rather than every file a root holds.
- */
-export function resolveAllStandards(
-  root: string,
-): Array<ResolvedStandard & { readonly name: string }> {
-  return listStandards(root).flatMap((name) => {
-    const resolved = resolveStandard(root, name)
-    return resolved ? [{ name, ...resolved }] : []
-  })
-}
-
-export function readStandard(standard: ResolvedStandard): string {
-  return stripFrontmatter(readFileSync(standard.path, 'utf8'))
-}

package/src/standards/scope.ts

@@ -1,56 +0,0 @@
-import { linesOutsideFences } from '@/markdown/scan'
-
-const SCOPE_HEADING = /^##[ \t]+Scope[ \t]*$/
-const ANY_HEADING = /^#{1,6}[ \t]+\S/
-const CODE_SPAN = /`([^`]+)`/g
-
-/** What an attribute standard says of itself, since it names no path. */
-export const ATTRIBUTE_MARKER = 'attribute standard'
-
-export interface Scope {
-  /** The first non-blank line under the heading, which is the statement. */
-  readonly statement: string
-  readonly lines: readonly string[]
-}
-
-export function readScope(text: string): Scope | undefined {
-  const lines = linesOutsideFences(text)
-  const opened = lines.findIndex((line) => SCOPE_HEADING.test(line.trim()))
-  if (opened === -1) return undefined
-
-  const body: string[] = []
-
-  for (const line of lines.slice(opened + 1)) {
-    if (ANY_HEADING.test(line.trim())) break
-    body.push(line)
-  }
-
-  const statement = body.find((line) => line.trim().length > 0)
-
-  return { statement: statement?.trim() ?? '', lines: body }
-}
-
-/**
- * The paths a scope statement declares: backticked spans in the first sentence
- * alone. The catalog's `appliesTo` field and the records gate both read the
- * statement through this, since one sentence read two ways would let a standard
- * pass the gate while publishing a different jurisdiction to every consumer.
- */
-export function governedPaths(statement: string): string[] {
-  const [sentence] = statement.split('. ')
-  return [...sentence.matchAll(CODE_SPAN)].map((match) => match[1])
-}
-
-/**
- * The jurisdiction a standard publishes. The marker is read only where the
- * first sentence backticks nothing, so a statement naming a path publishes that
- * path however the rest of it describes itself. An empty array means the
- * statement did not parse, which consumers report rather than skip.
- */
-export function appliesTo(text: string): string[] {
-  const statement = readScope(text)?.statement ?? ''
-  const paths = governedPaths(statement)
-
-  if (paths.length === 0 && statement.includes(ATTRIBUTE_MARKER)) return ['*']
-  return paths
-}

package/standards/index.md

@@ -1,10 +0,0 @@
----
-title: Standards
-subtitle: Reference docs for consistent authoring across the toolkit and target projects.
----
-
-# Standards
-
-Reference docs for consistent authoring across the toolkit and target projects.
-
-- [Standard reference](standard.md): Shape and content rules for authoring a standard

package/tooling/base/configs/.vscode/extensions.json

@@ -1,9 +0,0 @@
-{
-  "recommendations": [
-    "esbenp.prettier-vscode",
-    "streetsidesoftware.code-spell-checker",
-    "mkhl.shfmt",
-    "timonwong.shellcheck",
-    "mads-hartmann.bash-ide-vscode"
-  ]
-}

package/tooling/base/configs/.vscode/settings.json

@@ -1,3 +0,0 @@
-{
-  "shellcheck.customArgs": ["--severity=warning"]
-}

package/tooling/base/configs/scripts/verify.sh

@@ -1,2 +0,0 @@
-#!/bin/bash
-exec bun "$(dirname "$0")/verify.ts" "$@"

package/tooling/base/seeds/.cspell/tech-stack.txt

@@ -1,25 +0,0 @@
-canon
-bradlc
-bunx
-commitlint
-dbaeumer
-dotenv
-dotfolders
-erclx
-errexit
-esac
-esbenp
-eslintcache
-frontmatter
-lintstagedrc
-mkhl
-parallelizable
-regen
-scannability
-shellcheck
-shfmt
-timonwong
-wireframe
-wireframes
-worktree
-worktrees

package/tooling/base/seeds/cspell.json

@@ -1,20 +0,0 @@
-{
-  "version": "0.2",
-  "language": "en",
-  "useGitignore": true,
-  "gitignoreRoot": ["."],
-  "dictionaryDefinitions": [
-    {
-      "name": "project-terms",
-      "path": ".cspell/project-terms.txt",
-      "addWords": true
-    },
-    {
-      "name": "tech-stack",
-      "path": ".cspell/tech-stack.txt",
-      "addWords": true
-    }
-  ],
-  "dictionaries": ["project-terms", "tech-stack"],
-  "ignorePaths": [".cspell/**", ".git/**", ".claude/rules/canon/**"]
-}

package/tooling/go/seeds/.cspell/tech-stack.txt

@@ -1,16 +0,0 @@
-bodyclose
-Errorf
-errorlint
-Fatalf
-gofmt
-goimports
-golangci
-goroutine
-goroutines
-gosec
-httptest
-noctx
-nolint
-rowserrcheck
-sqlclosecheck
-unconvert

package/tooling/nextjs/seeds/.cspell/tech-stack.txt

@@ -1,3 +0,0 @@
-logomark
-turbopack
-vercel

package/tooling/php/seeds/.cspell/tech-stack.txt

@@ -1,5 +0,0 @@
-analyse
-friendsofphp
-phpstan
-phpunit
-testdox

package/tooling/python/seeds/.cspell/tech-stack.txt

@@ -1,18 +0,0 @@
-addopts
-appuser
-asyncio
-coveragerc
-fastapi
-flake8
-htmlcov
-mkdocs
-mypy
-pycache
-pyproject
-pytest
-pythonpath
-PYTHONUNBUFFERED
-ruff
-testpaths
-venv
-virtualenv

package/tooling/vite-react/seeds/.cspell/project-terms.txt

@@ -1 +0,0 @@
-

package/tooling/vite-react/seeds/.cspell/tech-stack.txt

@@ -1,2 +0,0 @@
-Vite
-tsgolint

package/tooling/web/configs/.vscode/extensions.json

@@ -1,13 +0,0 @@
-{
-  "recommendations": [
-    "esbenp.prettier-vscode",
-    "streetsidesoftware.code-spell-checker",
-    "mkhl.shfmt",
-    "timonwong.shellcheck",
-    "mads-hartmann.bash-ide-vscode",
-    "dbaeumer.vscode-eslint",
-    "bradlc.vscode-tailwindcss",
-    "ms-playwright.playwright",
-    "vitest.explorer"
-  ]
-}

package/tooling/web/configs/.vscode/settings.json

@@ -1,10 +0,0 @@
-{
-  "shellcheck.customArgs": ["--severity=warning"],
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": "explicit"
-  },
-  "files.associations": {
-    "*.css": "tailwindcss"
-  }
-}

package/tooling/web/seeds/.cspell/tech-stack.txt

@@ -1,21 +0,0 @@
-axios
-cksum
-evenodd
-iconify
-jsdom
-jsxSingleQuote
-labelledby
-linecap
-linejoin
-networkidle
-njsproj
-noopener
-noreferrer
-ntvs
-serviceworker
-sidepanel
-tabindex
-toplevel
-viewports
-vitest
-xlink