@erclx/canon 5.48.0 → 5.50.0

package/src/commands/markdown.ts

@@ -6,7 +6,7 @@ import { BAN_SETS, emptyBanSets } from '@/markdown/bans'
 import { isChangelog, lengthExemption } from '@/markdown/ceiling'
 import { type ColonFinding, findColons } from '@/markdown/colons'
 import { type MarkdownAuditRefusal, resolveMarkdown } from '@/markdown/files'
-import { densityFindings, type DensityKind } from '@/markdown/density'
+import type { DensityKind } from '@/markdown/density'
 import {
   type GatedDensityFinding,
   type GatedReferenceShapeFinding,
@@ -38,7 +38,19 @@ import {
   readGatedConfig,
   resolveGatedList,
 } from '@/markdown/gated'
-import { densityGates, inDensityScope } from '@/markdown/scope'
+import {
+  densityGates,
+  inDensityScope,
+  scopedDensityFindings,
+} from '@/markdown/scope'
+import {
+  TABLE_CELL,
+  TABLE_ROWS,
+  TABLE_TOKEN,
+  type TableFinding,
+  tableFindings,
+  type TableKind,
+} from '@/markdown/tables'
 import {
   BASELINE,
   CHECKPOINTS,
@@ -86,6 +98,8 @@ interface FileReport {
   readonly headingCase: readonly HeadingCaseFinding[]
   /** Empty on a path outside the density scope, so a plan never carries one. */
   readonly density: readonly GatedDensityFinding[]
+  /** Empty outside the density scope, and never gating anywhere. */
+  readonly tables: readonly TableFinding[]
   /** Empty on a page whose frontmatter does not carry `kind: reference`. */
   readonly referenceShape: readonly GatedReferenceShapeFinding[]
   readonly structure: StructureReport
@@ -131,13 +145,20 @@ export function register(program: Command): void {
         'a row, a 200-character bullet, 5 plain bullets in a row, no H4, and a',
         'paragraph or table opening every H3. Only context, docs, skills, tooling',
         'seeds and references, the wiki, README.md, and CONTRIBUTING.md take a',
-        'finding. In a canon checkout one gates under a prefix in GATED_PATHS in',
-        'src/markdown/scope.ts, and a bullet run gates in context, docs, and',
-        'skills from the start. Elsewhere one gates only under a prefix',
-        'canon/config/markdown.toml lists, which canon markdown gated add writes,',
-        'and with no such file every density finding reports and none gates.',
+        'finding. CLAUDE.md and its seed take only the bullet run and the H3',
+        'opening, inside Key paths. In a canon checkout one gates under a',
+        'prefix in GATED_PATHS in src/markdown/scope.ts, and a bullet run gates',
+        'in context, docs, and skills from the start. Elsewhere one gates only',
+        'under a prefix canon/config/markdown.toml lists, which canon markdown',
+        'gated add writes, and with no such file every density finding reports',
+        'and none gates.',
         'A config that does not parse refuses with its path named.',
         '',
+        'Tables take four limits on the same paths, CLAUDE.md aside: a',
+        '120-character cell, 8 body rows, a list as the next block, and a code',
+        'span with a run past 30 characters. A table finding reports and never',
+        'fails a run.',
+        '',
         'A page whose frontmatter carries kind: reference takes the reference',
         'shape: no H2 beyond Output, Refusals, and See also, each at most once',
         'and in that order, no H3, and no table whose first header cell names',
@@ -361,17 +382,16 @@ async function runAudit(
         bans: scanBans(lines, bans),
         colons: advisory ? findColons(lines) : [],
         headingCase: advisory ? findHeadingCase(source) : [],
-        density: inDensityScope(rel)
-          ? densityFindings(lines).map((finding) => ({
-              ...finding,
-              gating: densityGates(
-                rel,
-                finding.kind,
-                gated.prefixes,
-                gated.alwaysGated,
-              ),
-            }))
-          : [],
+        density: scopedDensityFindings(rel, lines).map((finding) => ({
+          ...finding,
+          gating: densityGates(
+            rel,
+            finding.kind,
+            gated.prefixes,
+            gated.alwaysGated,
+          ),
+        })),
+        tables: inDensityScope(rel) ? tableFindings(lines) : [],
         referenceShape: referenceShapeFindings(source).map((finding) => ({
           ...finding,
           gating: referenceShapeGates(rel, gated.prefixes),
@@ -393,6 +413,7 @@ async function runAudit(
   reportColons(reports)
   reportHeadingCase(reports)
   reportDensity(reports, gated, resolution.source)
+  reportTables(reports)
   reportReferenceShape(reports, gated)
   reportBullets(reports, checkpoints)
   reportParagraphs(reports, checkpoints)
@@ -430,6 +451,7 @@ async function runAudit(
           colons: report.colons,
           headingCase: report.headingCase,
           density: report.density,
+          tables: report.tables,
           referenceShape: report.referenceShape,
           longestRun: report.structure.longestRun,
           longestRunLine: report.structure.longestRunLine,
@@ -643,7 +665,7 @@ function reportDensity(
     `Paragraphs past ${CHECKPOINTS.paragraph} characters, more than 2 paragraphs in a row, bullets past ${CHECKPOINTS.bullet} characters, more than 5 plain bullets in a row, a heading past H3, and an H3 opening with neither a paragraph nor a table.`,
   )
   logInfo(
-    'Measured on context entries, docs, skill bodies, references, and requirements, tooling seeds and stack references, the wiki, README.md, and CONTRIBUTING.md. Every other path takes no density finding.',
+    'Measured on context entries, docs, skill bodies, references, and requirements, tooling seeds and stack references, the wiki, README.md, and CONTRIBUTING.md. CLAUDE.md and its seed take the bullet run and the H3 opening inside Key paths alone. Every other path takes no density finding.',
   )
   logInfo(densityGatingLine(gated, source))
 
@@ -695,6 +717,63 @@ function densityGatingLine(
     : `A finding gates under a prefix ${GATED_CONFIG_REL} lists (${listed}). Every other finding reports.`
 }
 
+const TABLE_LABELS: Record<TableKind, string> = {
+  'table-cell': 'cell length',
+  'table-rows': 'rows',
+  'table-then-list': 'list after table',
+  'table-token': 'wide token',
+}
+
+function describeTable(finding: TableFinding): string {
+  const measured =
+    finding.kind === 'table-then-list'
+      ? 'follows the table with no lead sentence'
+      : `${finding.value} past ${finding.limit}`
+  return `  :${finding.line}  ${TABLE_LABELS[finding.kind]}  ${measured}`
+}
+
+/**
+ * Lists every table finding on the density scope's paths. None gates yet,
+ * since a gate is decided per path rather than per kind, and a new density
+ * kind would fail every gated folder carrying a table hit at once.
+ */
+function reportTables(reports: readonly FileReport[]): void {
+  logStep('Tables')
+  logInfo(
+    `Cells past ${TABLE_CELL} characters, tables past ${TABLE_ROWS} body rows, a list directly after a table, and a code span in a cell holding a run past ${TABLE_TOKEN} characters.`,
+  )
+  logInfo(
+    'Measured on the paths density measures in full, so never on CLAUDE.md, outside fenced blocks. This never fails a run.',
+  )
+
+  const carrying = reports
+    .filter((report) => report.tables.length > 0)
+    .sort((a, b) => b.tables.length - a.tables.length)
+
+  if (carrying.length === 0) {
+    logInfo('No table finding.')
+    return
+  }
+
+  const total = carrying.reduce((sum, report) => sum + report.tables.length, 0)
+  logWarn(
+    `${plural(total, 'finding')} across ${plural(carrying.length, 'file')}`,
+  )
+  logInfo(
+    'Move a long cell into a bullet under the lead, split a long table into groups each under a lead sentence, give a trailing list its own lead, and move a wide token out of the table.',
+  )
+  pipeOutput(
+    carrying
+      .map(
+        (report) =>
+          `${report.rel}  ${plural(report.tables.length, 'finding')}\n${report.tables
+            .map(describeTable)
+            .join('\n')}`,
+      )
+      .join('\n'),
+  )
+}
+
 const REFERENCE_SHAPE_LABELS: Record<ReferenceShapeKind, string> = {
   'extra-section': 'section outside the shape',
   'section-order': 'section out of order or repeated',