@erclx/canon 5.52.0 → 5.54.0

package/src/commands/design.ts

@@ -1,53 +1,30 @@
-import { copyFileSync, existsSync, mkdirSync } from 'node:fs'
-import { basename, join, relative, resolve } from 'node:path'
+import { existsSync } from 'node:fs'
+import { join, relative } from 'node:path'
 import type { Command } from 'commander'
-import {
-  createDesignAdapter,
-  DESIGN_INSTALL_DIR,
-  DESIGN_PROJECT_SUBDIR,
-} from '@/design/adapter'
 import { buildDesignCss } from '@/design/css'
 import { HAND_DRAWN_FONT_FACES } from '@/design/fonts'
-import { addProjectFace, listProjectFaces } from '@/design/project-fonts'
-import { renderDesignDoc } from '@/design/render'
-import { DESIGN_BASE_CSS, DESIGN_DOCUMENT, regenDesign } from '@/design/regen'
+import { DESIGN_DOCUMENT, regenDesign } from '@/design/regen'
 import { checkoutMismatchWarning, PROJECT_ROOT } from '@/roots/project'
-import { creationRel, SCRATCH } from '@/roots/record'
-import { surfaceDir } from '@/roots/surface'
-import { recordStamp, runDomainSync } from '@/sync/engine'
-import { isDirectory, resolveTarget } from '@/targets/validate'
-import {
-  intro,
-  logAdd,
-  logError,
-  logInfo,
-  logWarn,
-  outro,
-  palette,
-} from '@/cli/ui'
+import { logWarn, palette } from '@/cli/ui'
 
 export function register(program: Command): void {
   const design = program
     .command('design')
     .helpOption('-h, --help', 'Show this help message')
-    .description(
-      'Design system commands (regen, css, render, install, sync, fonts)',
-    )
+    .description('Design system commands (regen, css)')
 
   design
     .command('regen')
     .helpOption('-h, --help', 'Show this help message')
-    .description(
-      'Rewrite canon/DESIGN.md and the base stylesheet from src/design/tokens.ts',
-    )
+    .description('Rewrite canon/DESIGN.md from src/design/tokens.ts')
     .addHelpText(
       'after',
       [
         '',
-        'Unlike install and sync, this runs against the toolkit checkout rather',
-        'than a target. It rewrites the record and the base stylesheet from the',
-        'token module and refuses where the record is absent, which is what the',
-        'CLI installed into a project as a dependency looks like.',
+        'This runs against the toolkit checkout rather than a target. It',
+        'rewrites the record from the token module and refuses where the record',
+        'is absent, which is what the CLI installed into a project as a',
+        'dependency looks like.',
         '',
       ].join('\n'),
     )
@@ -60,10 +37,10 @@ export function register(program: Command): void {
       // so each emits it after its own opener rather than ahead of the branch.
       const mismatch = checkoutMismatchWarning(process.cwd())
 
-      // Both outputs resolve from `PROJECT_ROOT`, which is the installed
+      // The output resolves from `PROJECT_ROOT`, which is the installed
       // package directory when the CLI runs out of a target's `node_modules`.
-      // The record is the one output that is already committed here and ships
-      // with no package, so its absence is what separates the two.
+      // The record is already committed here and ships with no package, so
+      // its absence is what separates the two.
       if (!existsSync(join(PROJECT_ROOT, DESIGN_DOCUMENT))) {
         process.stderr.write(`${GREY}┌${NC}\n`)
         if (mismatch !== undefined) logWarn(mismatch)
@@ -79,11 +56,9 @@ export function register(program: Command): void {
       )
       if (mismatch !== undefined) logWarn(mismatch)
       const result = regenDesign(PROJECT_ROOT)
-      for (const path of [result.documentPath, result.cssPath]) {
-        process.stderr.write(
-          `${GREY}│${NC} ${GREEN}✓${NC} ${relative(PROJECT_ROOT, path)}\n`,
-        )
-      }
+      process.stderr.write(
+        `${GREY}│${NC} ${GREEN}✓${NC} ${relative(PROJECT_ROOT, result.documentPath)}\n`,
+      )
       process.stderr.write(`${GREY}└${NC}\n`)
     })
 
@@ -107,278 +82,4 @@ export function register(program: Command): void {
         }),
       )
     })
-
-  design
-    .command('render')
-    .helpOption('-h, --help', 'Show this help message')
-    .description('Render DESIGN.md tokens to HTML and CSS preview')
-    .option(
-      '-s, --source <path>',
-      'Source DESIGN.md path',
-      relative(process.cwd(), surfaceDir(process.cwd(), 'DESIGN.md')),
-    )
-    .option(
-      '-o, --out <path>',
-      'Output directory',
-      creationRel(process.cwd(), SCRATCH, 'render', 'design'),
-    )
-    .option(
-      '--embed-fonts',
-      'Declare each vendored face the typography table names, and set the page body in the body stack',
-    )
-    .action((opts: { source: string; out: string; embedFonts?: boolean }) => {
-      const sourcePath = resolve(process.cwd(), opts.source)
-      const outDir = resolve(process.cwd(), opts.out)
-      const { GREEN, GREY, NC, RED, WHITE } = palette(process.stderr)
-      if (!existsSync(sourcePath)) {
-        process.stderr.write(
-          `${GREY}┌${NC}\n${GREY}│${NC} ${RED}✗${NC} ${opts.source} not found\n${GREY}└${NC}\n`,
-        )
-        process.exitCode = 1
-        return
-      }
-      process.stderr.write(
-        `${GREY}┌${NC}\n${GREY}│${NC} ${WHITE}Render design tokens${NC}\n`,
-      )
-      const result = renderDesignDoc(sourcePath, outDir, {
-        embedFonts: opts.embedFonts,
-      })
-      process.stderr.write(
-        `${GREY}│${NC} ${GREEN}✓${NC} ${result.htmlPath}\n${GREY}│${NC} ${GREEN}✓${NC} ${result.cssPath}\n${GREY}└${NC}\n`,
-      )
-    })
-
-  design
-    .command('install')
-    .description('Install the base stylesheet into a project')
-    .argument('[target]', 'Target directory', '.')
-    .helpOption('-h, --help', 'Show this help message')
-    .addHelpText(
-      'after',
-      [
-        '',
-        'Installs one toolkit-owned file and creates no override. A project',
-        `overrides a value by writing ${join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR)}/`,
-        'itself, which sync never touches. Nothing arrives on a project that',
-        'has not run this, so a design value reaches a target on an install',
-        'rather than on the next sync. A base stylesheet already installed is',
-        'replaced.',
-        '',
-        'Exit codes:',
-        '  0  the stylesheet was installed',
-        '  1  the target is missing or is the toolkit root, or the toolkit',
-        '     source is absent',
-        '',
-      ].join('\n'),
-    )
-    .action(async (target: string) => {
-      process.exitCode = await runInstall(target)
-    })
-
-  design
-    .command('sync')
-    .description(
-      'Update the base stylesheet already installed under .claude/design/',
-    )
-    .argument('[target]', 'Target directory', '.')
-    .helpOption('-h, --help', 'Show this help message')
-    .addHelpText(
-      'after',
-      [
-        '',
-        'Replaces the shipped design files under .claude/design/ with the',
-        'toolkit copy, edited or not, and leaves',
-        `${join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR)}/ alone. It deletes nothing it finds no`,
-        'source for.',
-        '',
-        'Exit codes:',
-        '  0  synced, already up to date, or the prompt was cancelled',
-        '  1  the target is missing or is the toolkit root',
-        '',
-      ].join('\n'),
-    )
-    .action(async (target: string) => {
-      process.exitCode = await runDomainSync(
-        createDesignAdapter(PROJECT_ROOT),
-        target,
-        { protectedRoot: PROJECT_ROOT },
-      )
-    })
-
-  registerFonts(design)
-}
-
-const FONTS_DIR = join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR, 'fonts')
-
-interface FontsRefused {
-  readonly ok: false
-  readonly reason: string
-  readonly detail: string
-}
-
-function writeJson(record: unknown): void {
-  process.stdout.write(`${JSON.stringify(record)}\n`)
-}
-
-function refuseFonts(
-  title: string,
-  refusal: FontsRefused,
-  emitJson: boolean,
-): number {
-  if (emitJson) writeJson(refusal)
-  intro(title)
-  logError(refusal.detail)
-  outro()
-  return 1
-}
-
-/** A target that is a directory, or the refusal naming the path given. */
-function fontsTarget(target: string): string | FontsRefused {
-  const resolved = resolve(target)
-  if (!isDirectory(resolved)) {
-    return {
-      ok: false,
-      reason: 'no-target',
-      detail: `Target directory not found: ${target}`,
-    }
-  }
-  return resolved
-}
-
-function registerFonts(design: Command): void {
-  const fonts = design
-    .command('fonts')
-    .helpOption('-h, --help', 'Show this help message')
-    .description(`Read and add the project's own faces under ${FONTS_DIR}/`)
-    .addHelpText(
-      'after',
-      [
-        '',
-        `Faces are declared as @font-face rules in ${join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR)}/fonts.css,`,
-        'which the canvas embeds into every frame. Sync never writes the folder.',
-        '',
-      ].join('\n'),
-    )
-
-  fonts
-    .command('list')
-    .helpOption('-h, --help', 'Show this help message')
-    .description('List each face the project override sheets declare')
-    .argument('[target]', 'Target directory', '.')
-    .option('--json', 'Emit the record on stdout')
-    .action((target: string, opts: { json?: boolean }) => {
-      const title = 'canon design fonts list'
-      const resolved = fontsTarget(target)
-      if (typeof resolved !== 'string') {
-        process.exitCode = refuseFonts(title, resolved, Boolean(opts.json))
-        return
-      }
-      const faces = listProjectFaces(resolved)
-      if (opts.json) writeJson({ ok: true, faces })
-      intro(title)
-      if (faces.length === 0) logInfo(`No faces declared under ${FONTS_DIR}/`)
-      for (const face of faces) {
-        const line = `${face.family} ${face.weight} ${face.style}: ${face.file} in ${face.sheet}`
-        if (face.present) logInfo(line)
-        else logWarn(`${line} (${face.problem ?? 'missing'})`)
-      }
-      outro()
-    })
-
-  fonts
-    .command('add')
-    .helpOption('-h, --help', 'Show this help message')
-    .description(
-      `Copy a woff2, woff, ttf, or otf face into ${FONTS_DIR}/ and declare it`,
-    )
-    .argument('<file>', 'Font file to copy')
-    .argument('[target]', 'Target directory', '.')
-    .requiredOption('--family <name>', 'Family name the face declares')
-    .option('--weight <n>', "Weight, or a range such as '100 900'", '400')
-    .option('--style <style>', 'normal or italic', 'normal')
-    .option('--json', 'Emit the record on stdout')
-    .action(
-      (
-        file: string,
-        target: string,
-        opts: { family: string; weight: string; style: string; json?: boolean },
-      ) => {
-        const title = 'canon design fonts add'
-        const emitJson = Boolean(opts.json)
-        const resolved = fontsTarget(target)
-        if (typeof resolved !== 'string') {
-          process.exitCode = refuseFonts(title, resolved, emitJson)
-          return
-        }
-        if (resolved === PROJECT_ROOT) {
-          process.exitCode = refuseFonts(
-            title,
-            {
-              ok: false,
-              reason: 'toolkit-root',
-              detail:
-                'Cannot run against toolkit root. Files here are the source of truth.',
-            },
-            emitJson,
-          )
-          return
-        }
-        const outcome = addProjectFace(resolved, resolve(file), {
-          family: opts.family,
-          weight: opts.weight,
-          style: opts.style,
-        })
-        if (!outcome.ok) {
-          process.exitCode = refuseFonts(title, outcome, emitJson)
-          return
-        }
-        if (emitJson) writeJson(outcome)
-        intro(title)
-        logAdd(join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR, outcome.file))
-        logInfo(
-          `Declared ${outcome.family} ${outcome.weight} ${outcome.style} in ${outcome.sheet}`,
-        )
-        outro()
-      },
-    )
-}
-
-/**
- * Copies the base and stops. The override folder is deliberately not created:
- * an empty override is a file the project did not ask for and did not write,
- * the three-way merge already handles a missing side, and an empty file invites
- * a target to fill it before it has an opinion.
- */
-async function runInstall(target: string): Promise<number> {
-  intro('canon design install')
-
-  const resolved = resolveTarget(target, PROJECT_ROOT)
-  if (typeof resolved === 'number') {
-    outro()
-    return resolved
-  }
-
-  const source = join(PROJECT_ROOT, DESIGN_BASE_CSS)
-  if (!existsSync(source)) {
-    logError(
-      `No base stylesheet at ${DESIGN_BASE_CSS}. Run canon design regen.`,
-    )
-    outro()
-    return 1
-  }
-
-  const dir = join(resolved, DESIGN_INSTALL_DIR)
-  mkdirSync(dir, { recursive: true })
-
-  const dest = join(dir, basename(source))
-  copyFileSync(source, dest)
-  logAdd(relative(resolved, dest))
-
-  await recordStamp(createDesignAdapter(PROJECT_ROOT), resolved, new Date())
-
-  logInfo(
-    `Override a value in ${join(DESIGN_INSTALL_DIR, DESIGN_PROJECT_SUBDIR)}/, which sync leaves alone.`,
-  )
-  outro()
-  return 0
 }

package/src/commands/records.ts

@@ -127,7 +127,6 @@ export function register(program: Command): void {
         'Examples:',
         '  canon records validate plans',
         '  canon records validate plans feature-records-by-heading',
-        '  canon records validate teach',
         '  canon records validate intake --json',
         '',
       ].join('\n'),

package/src/commands/serve.ts

@@ -40,8 +40,8 @@ export function register(program: Command): void {
         'starts it in the background and reads the record off stdout.',
         '',
         'Examples:',
-        '  canon serve .canon/teach',
-        '  canon serve .canon/teach --entry 03-fde-system-design/index.html',
+        '  canon serve site',
+        '  canon serve site --entry guide/index.html',
         '  canon serve dist --port 4000 --json',
         '  canon serve .canon/groundwork --index',
         '',

package/src/commands/sync.ts

@@ -35,7 +35,6 @@ import { describeSkew } from '@/version/skew'
 
 const SYNC_ARGS: Record<SyncDomain, readonly string[]> = {
   governance: ['gov', 'sync'],
-  design: ['design', 'sync'],
   claude: ['claude', 'sync'],
 }
 
@@ -58,10 +57,10 @@ export function register(program: Command): void {
       'after',
       [
         '',
-        'Runs `canon gov sync`, `canon design sync`, and `canon claude sync`',
-        'on each domain installed, so each carries its own replace behavior:',
-        'governance replaces an edited rule and deletes a retired one, design',
-        'replaces its shipped files, and claude writes .gitignore alone.',
+        'Runs `canon gov sync` and `canon claude sync` on each domain',
+        'installed, so each carries its own replace behavior: governance',
+        'replaces an edited rule and deletes a retired one, and claude writes',
+        '.gitignore alone.',
         'Tooling is not synced. Refuses a dirty working tree.',
         '',
         'Exit codes:',