chaffjs 0.5.1 → 0.7.0

package/dist/structure/universal.d.ts

@@ -0,0 +1,7 @@
+import type { NumberedLine, NumberingContext } from "../plugin.ts";
+/**
+ * 本文の「1. 」は箇条書きで、見出しの「1. 」は章番号。点を含まない番号は、見出しの行でだけ読む。
+ * 「4.2 」のように点を含むものは、.txt の仕様書でも見出しとして書かれるので本文でも読む。
+ */
+export declare const dottedNumber: (line: string, context: NumberingContext) => NumberedLine | undefined;
+//# sourceMappingURL=universal.d.ts.map

package/dist/structure/universal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"universal.d.ts","sourceRoot":"","sources":["../../src/structure/universal.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAQnE;;;GAGG;AACH,eAAO,MAAM,YAAY,GAAI,MAAM,MAAM,EAAE,SAAS,gBAAgB,KAAG,YAAY,GAAG,SAQrF,CAAC"}

package/dist/structure/universal.js

@@ -0,0 +1,21 @@
+/**
+ * 「4.2 設定」「3.1.4 Scope」のような通し番号。数字と点だけで書くので言語を問わない。
+ * 各部分を 3 桁・深さを 6 までに抑え、後戻りが爆発しない形にしてある。
+ */
+const DOTTED = /^[ \t]{0,3}(?<number>\d{1,3}(?:\.\d{1,3}){0,5})\.?[ \t\u3000]+(?<rest>\S.*)$/u;
+/**
+ * 本文の「1. 」は箇条書きで、見出しの「1. 」は章番号。点を含まない番号は、見出しの行でだけ読む。
+ * 「4.2 」のように点を含むものは、.txt の仕様書でも見出しとして書かれるので本文でも読む。
+ */
+export const dottedNumber = (line, context) => {
+    const groups = DOTTED.exec(line)?.groups;
+    const number = groups?.["number"];
+    if (number === undefined)
+        return undefined;
+    const depth = number.split(".").length;
+    if (depth < 2 && !context.isHeading)
+        return undefined;
+    const rest = groups?.["rest"]?.trim() ?? "";
+    return { kind: "article", depth, number, absolute: true, label: number, heading: rest, rest, ordinal: Number(number.split(".").at(-1)) };
+};
+//# sourceMappingURL=universal.js.map

package/dist/structure/universal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"universal.js","sourceRoot":"","sources":["../../src/structure/universal.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,MAAM,MAAM,GAAG,+EAA+E,CAAC;AAE/F;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,OAAyB,EAA4B,EAAE;IAChG,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACzC,MAAM,MAAM,GAAG,MAAM,EAAE,CAAC,QAAQ,CAAC,CAAC;IAClC,IAAI,MAAM,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC;IACvC,IAAI,KAAK,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS;QAAE,OAAO,SAAS,CAAC;IACtD,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC5C,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAC3I,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chaffjs",
-  "version": "0.5.1",
+  "version": "0.7.0",
   "description": "Prose validation harness. Finds what is hard to read, and never rewrites it for you.",
   "keywords": [
     "chaff",
@@ -52,8 +52,8 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.125.0",
-    "@chaffjs/lang-en": "0.5.0",
-    "@chaffjs/lang-ja": "0.5.0",
+    "@chaffjs/lang-en": "0.6.0",
+    "@chaffjs/lang-ja": "0.6.0",
     "mdast-util-from-markdown": "^2.0.3",
     "mdast-util-frontmatter": "^2.0.1",
     "mdast-util-gfm-table": "^2.0.0",

package/rules/dangling-reference.yaml

@@ -0,0 +1,27 @@
+id: dangling-reference
+layer: L3
+status: experimental
+how_to_find: dangling-reference
+requires: [structure]
+severity: error
+
+name:
+  ja: 参照先が無い
+  en: Reference to a missing provision
+
+why:
+  ja: 「第12条に定める」のような参照は、その条が文書に無ければ読み手を行き止まりにします。条を消したり番号を振り直したりしたときに、参照だけが古い番号のまま残ることがよくあります。chaff は文書を番地の付いた木にして（chaff tree）、参照の番地が木にあるかを見ます。
+  en: A reference such as "as set out in Section 12" leaves the reader at a dead end when that section is not in the document. It usually happens when a provision is deleted or renumbered and the reference keeps the old number. chaff builds the document's tree of addresses (chaff tree) and checks that each reference's address is in it.
+
+message:
+  ja: 「{label}」（番地 {target}）はこの文書にありません
+  en: '"{label}" (address {target}) is not in this document'
+
+how_to_fix:
+  ja: 正しい番号に直すか、参照を消してください。他の文書を指しているなら、「民法第3条」のように文書名を添えると読み手に伝わります。
+  en: Fix the number or remove the reference. If it points into another document, name that document so the reader knows where to look.
+
+# 何件あれば指摘するか。1 は「1 件でもあれば」。
+levels: { strict: 1, normal: 1, relaxed: 1 }
+
+use_for: [business, technical, blog]

package/rules/duplicate-definition.yaml

@@ -0,0 +1,26 @@
+id: duplicate-definition
+layer: L3
+status: experimental
+how_to_find: duplicate-definition
+requires: [structure]
+severity: warning
+
+name:
+  ja: 同じ語の二重定義
+  en: Term defined twice
+
+why:
+  ja: 同じ語を二か所で定義すると、二つの定義が食い違っていないかを読み手が確かめなければなりません。長い契約書では、後から足した定義が先の定義と少しずれることがよくあります。中身が食い違っているかは機械では決まらないので、chaff は二度目の定義の場所だけを示します。
+  en: A term defined in two places makes the reader check whether the two definitions agree. In long contracts a definition added later often drifts from the first. Whether they conflict is not something a machine can decide, so chaff only points at the second one.
+
+message:
+  ja: 「{term}」は {first} 行目でも定義されています
+  en: '"{term}" is also defined on line {first}'
+
+how_to_fix:
+  ja: 定義を一か所にまとめ、もう一方は「第2条に定める{term}」のように参照にしてください。意図して意味を変えているなら、別の語にします。
+  en: Keep one definition and refer to it from the other place. If the meaning changes on purpose, use a different term.
+
+levels: { strict: 1, normal: 1, relaxed: 1 }
+
+use_for: [business, technical, blog]

package/rules/latin-spacing.yaml

@@ -0,0 +1,27 @@
+id: latin-spacing
+layer: L3
+status: experimental
+how_to_find: latin-spacing
+languages: [ja]
+severity: warning
+
+name:
+  ja: 英数字の前後の空白がそろっていない
+  en: Spacing around Latin text is inconsistent
+
+why:
+  ja: 日本語と英字・数字のあいだを空けるか詰めるかは、どちらでも読めます。困るのは一つの文書の中で混ざることで、読み手には違いに意味があるように見えます。chaff はどちらが正しいかを決めず、文書の中で少ないほうを指摘します。英字と、数字の前、数字の後ろは別々に数えます。「を 3回」のように、数字の前は空けて助数詞とは詰める書き方がふつうにあるからです。「3GBの」のように数字に続く単位は、英字ではなく数字の側として数えます。
+  en: Whether to put a space between Japanese and Latin letters or digits is a choice either way. What reads badly is mixing both in one document, which suggests the difference means something. chaff does not decide which is right; it points at whichever the document uses less. Letters, the space before a digit and the space after one are counted separately, since spacing before a number but not before its counter is common.
+
+message:
+  ja: "日本語と{kind}のあいだを{style}（この文書はふつう{usual}。{of} 箇所のうち {count} 箇所が違う）"
+  en: "Spacing between Japanese and {kind} differs here ({count} of {of})"
+
+how_to_fix:
+  ja: 文書の多いほうの書き方に合わせてください。チームで決めているなら、STYLE.md に書いておくと迷いません。
+  en: Match the way the rest of the document does it. If the team has decided, write it in the style guide.
+
+# 何箇所違えば指摘するか。1 は「1 箇所でも混ざっていれば」。
+levels: { strict: 1, normal: 1, relaxed: 3 }
+
+use_for: [business, blog, technical]

package/rules/numbering-gap.yaml

@@ -0,0 +1,26 @@
+id: numbering-gap
+layer: L3
+status: experimental
+how_to_find: numbering-gap
+requires: [structure]
+severity: error
+
+name:
+  ja: 番号の抜け・重なり
+  en: Skipped or repeated number
+
+why:
+  ja: 第3条の次が第5条、(a) の次が (c)、同じ第2項が二つ。番号が飛ぶか重なると、読み手は何かが消えたのか、参照がどちらを指すのかを判断できません。同じ親の中で並ぶ番号だけを比べます。枝番号（第3条の2）は並びの外として扱います。
+  en: Article 5 right after Article 3, (c) right after (a), two paragraphs numbered 2. A reader cannot tell whether something was removed, or which one a reference means. Only numbers side by side under the same parent are compared.
+
+message:
+  ja: 「{previous}」の次が「{label}」です（{expected} 番目のはず）
+  en: '"{label}" follows "{previous}" (expected number {expected})'
+
+how_to_fix:
+  ja: 番号を振り直してください。削った条を欠番として残すなら、「第4条（削除）」のように番号だけを残すと読み手に伝わります。
+  en: Renumber. If a provision was removed on purpose, keep its number with a note such as "Section 4 [Deleted]".
+
+levels: { strict: 1, normal: 1, relaxed: 1 }
+
+use_for: [business, technical, blog]

package/rules/preferred-term.yaml

@@ -0,0 +1,27 @@
+id: preferred-term
+layer: L2
+status: experimental
+how_to_find: preferred-term
+word_list: preferred-term
+severity: warning
+
+name:
+  ja: チームの表記と違う
+  en: Not the team's spelling
+
+why:
+  ja: 同じものを「サーバー」とも「サーバ」とも書くと、読み手は別のものかと迷い、検索でも片方を取りこぼします。どちらに寄せるかはチームごとに違うので、chaff.yaml の prefer に「使わない書き方」と「使う書き方」の組を自分で並べてください。並べていなければ何も言いません。
+  en: Writing the same thing two ways ("e-mail" and "email") makes a reader wonder whether they differ, and a search misses one of them. Which way wins is the team's choice, so list pairs (the spelling to avoid, then the one to use) under `prefer` in chaff.yaml. With nothing listed, this rule says nothing.
+
+message:
+  ja: 「{matched}」は「{preferred}」と書きます
+  en: 'Write "{preferred}", not "{matched}"'
+
+how_to_fix:
+  ja: 「{preferred}」に直してください。固有名詞など、そのままにすべき箇所なら stet で理由を添えて黙らせます。
+  en: Change it to "{preferred}". Where it must stay (a product's own name, a quotation), silence it with stet and the reason.
+
+# チームが並べた書き方なので、1 つでも指摘する。並べた時点で「使わない」と決めている。
+levels: { strict: 1, normal: 1, relaxed: 3 }
+
+use_for: [business, blog, technical]

package/src/adapter-load.ts

@@ -50,7 +50,24 @@ const pickExport = (module: object): unknown => {
   return isAdapter(record["adapter"]) ? record["adapter"] : record["default"];
 };
 
-export const packageFor = (language: string): string | undefined => ADAPTER_PACKAGE[language];
+/**
+ * 同梱の言語は表から、それ以外は `@chaffjs/lang-<言語>` を探す。
+ * 利用者が lang-zh のようなパッケージを書いて入れれば、core を変えずにその言語で動く。
+ */
+const LANGUAGE_ID = /^[a-z]{2,3}$/u;
+
+export const packageFor = (language: string): string | undefined =>
+  ADAPTER_PACKAGE[language] ?? (LANGUAGE_ID.test(language) ? `@chaffjs/lang-${language}` : undefined);
+
+const importAdapter = async (specifier: string, language: string): Promise<unknown> => {
+  try {
+    return await import(specifier);
+  } catch (err) {
+    const missing = err instanceof Error && "code" in err && err.code === "ERR_MODULE_NOT_FOUND";
+    if (missing) throw new Error(`言語 ${language} のパッケージ ${specifier} が入っていません（npm i -D ${specifier}）`, { cause: err });
+    throw err;
+  }
+};
 
 /**
  * アダプタは「必要になったものだけ」を実行時に解決する。spec §17.2。
@@ -60,7 +77,7 @@ export const packageFor = (language: string): string | undefined => ADAPTER_PACK
 export const loadAdapter = async (language: string): Promise<LanguageAdapter> => {
   const specifier = packageFor(language);
   if (specifier === undefined) throw new Error(`no adapter for language "${language}"`);
-  const module: unknown = await import(specifier);
+  const module = await importAdapter(specifier, language);
   if (typeof module !== "object" || module === null) throw new Error(`${specifier} did not export a module`);
   const candidate = pickExport(module);
   const broken = checkAdapter(candidate);

package/src/cli.ts

@@ -23,6 +23,9 @@ import { renderFriendly } from "./render/friendly.ts";
 import { rulesJson } from "./render/rules-json.ts";
 import { renderSarif } from "./render/sarif.ts";
 import { VERSION } from "./version.ts";
+import { runTree, treeTargets } from "./commands/tree.ts";
+import { citeTargets, runCite } from "./commands/cite.ts";
+import { ruleProblems } from "./config/rule-problems.ts";
 import { renderSummary, type FileOutcome } from "./render/summary.ts";
 import { neededBy, runRules } from "./run.ts";
 import type { Level, RuleDefinition } from "./plugin.ts";
@@ -37,6 +40,8 @@ const USAGE = `chaff — 文章の読みにくいところを見つけます。
   chaff eval <dir>               手元の文書で閾値を測り直す
   chaff explain <rule>           そのルールの意図と根拠を読む
   chaff genres                   ジャンルの一覧
+  chaff tree <file> [--format sexp|json]  文書を番地の付いた木にする（条・項・定義・参照）
+  chaff cite <原文> <引用.json>           回答の引用（番地と引用文）が原文にあるかを確かめる
   chaff rules --json             いまの設定を JSON で出す（AI に渡す用）
   chaff baseline <dir>           いまある指摘を棚上げする（既存の repo に入れるとき）
   chaff suppressions <dir>       stet で黙らせている指摘を数える
@@ -109,7 +114,7 @@ const inspect = async (path: string, config: Config, argv: readonly string[]): P
   const experimental = config.experimental || argv.includes("--experimental");
   await adapter.prepare?.(neededBy(rules, config.rules, experimental, genre, language));
   const doc = buildDocument(path, source, adapter, teamRules(config));
-  const raw = runRules(doc, rules, config.rules, experimental, genre);
+  const raw = runRules(doc, rules, config.rules, experimental, genre, config.limits);
   // 応答は 3 つ。stet で黙らせたものは、ここで落とす。
   const applied = applySuppressions(
     source,
@@ -147,6 +152,11 @@ const writeSarif = (results: readonly Inspected[], argv: readonly string[]): voi
   console.log(`\n  SARIF を書きました: ${path}（${located.length} 件）`);
 };
 
+/** 効いていない設定は、結果の前に一度だけ言う。標準エラーに出すので、JSON や SARIF の出力は汚さない。 */
+const warnRuleProblems = (config: Config, language: string): void => {
+  ruleProblems(config, loadRules(language)).forEach((problem) => console.error(`chaff: ${problem}`));
+};
+
 const lint = async (targets: readonly string[], argv: readonly string[]): Promise<number> => {
   const paths = collectTargets(targets);
   if (paths.length === 0) {
@@ -160,6 +170,7 @@ const lint = async (targets: readonly string[], argv: readonly string[]): Promis
     console.error(`言語 "${language}" のアダプタがありません。`);
     return 1;
   }
+  warnRuleProblems(config, language);
   const results = await Promise.all(paths.map((path) => inspect(path, config, argv)));
   writeSarif(results, argv);
   results.filter((result) => result.outcome.findings.length > 0 || paths.length === 1).forEach((result) => console.log(result.text));
@@ -178,6 +189,7 @@ const runWatch = async (targets: readonly string[], argv: readonly string[]): Pr
     return 1;
   }
   const config = readConfig();
+  warnRuleProblems(config, config.language ?? "ja");
   const seen = new Map<string, Snapshot>();
   const once = async (path: string, first: boolean): Promise<void> => {
     const result = await inspect(path, config, argv);
@@ -264,6 +276,7 @@ const positional = (argv: readonly string[]): string[] => argv.slice(1).filter((
 const showRules = (): number => {
   const config = readConfig();
   const language = config.language ?? "ja";
+  warnRuleProblems(config, language);
   console.log(rulesJson(loadRules(language), config, language, config.genre ?? "blog/tech"));
   return 0;
 };
@@ -283,6 +296,8 @@ const HANDLERS: Readonly<Record<string, Handler>> = {
   rules: showRules,
   explain: (argv) => explain(argv[1]),
   eval: (argv) => runEval(positional(argv), argv, { config: readConfig(), resolveGenre, flag }),
+  tree: (argv) => runTree(treeTargets(argv), argv, { config: readConfig(), flag }),
+  cite: (argv) => runCite(citeTargets(argv), argv, { config: readConfig(), flag }),
   test: (argv) => runTest(positional(argv), argv, { config: readConfig(), resolveGenre, inspect }),
   baseline: (argv) => runBaseline(positional(argv), argv),
   suppressions: (argv) => runSuppressions(positional(argv), argv),

package/src/commands/cite.ts

@@ -0,0 +1,74 @@
+import { checkCitations, type Citation, type CitationResult } from "../structure/cite.ts";
+import { readSource, readTree, type TreeContext } from "./tree.ts";
+
+const USAGE = "使い方: chaff cite <原文> <引用.json> [--format text|json] [--language ja|en|…]";
+const FORMATS = ["text", "json"];
+const QUOTE_WIDTH = 40;
+const VALUED = ["--format", "--language"];
+
+export const citeTargets = (argv: readonly string[]): string[] =>
+  argv.slice(1).filter((arg, index, all) => !arg.startsWith("--") && !VALUED.includes(all[index - 1] ?? ""));
+
+const isRecord = (value: unknown): value is Record<string, unknown> => typeof value === "object" && value !== null && !Array.isArray(value);
+
+const isCitation = (value: unknown): value is Citation => isRecord(value) && typeof value["address"] === "string" && typeof value["quote"] === "string";
+
+export type ParsedCitations = { readonly citations: readonly Citation[] } | { readonly error: string };
+
+const parseJson = (text: string): { readonly value: unknown } | { readonly error: string } => {
+  try {
+    return { value: JSON.parse(text) };
+  } catch (err) {
+    return { error: `JSON として読めません: ${err instanceof Error ? err.message : String(err)}` };
+  }
+};
+
+/** 引用の一覧。[{ address, quote }] の配列だけを受け取る。形が違えば理由を返す。 */
+export const parseCitations = (text: string): ParsedCitations => {
+  const parsed = parseJson(text);
+  if ("error" in parsed) return parsed;
+  if (!Array.isArray(parsed.value)) return { error: '引用は配列で渡してください: [{ "address": "3.2", "quote": "…" }]' };
+  const entries: readonly unknown[] = parsed.value;
+  const bad = entries.findIndex((entry) => !isCitation(entry));
+  if (bad !== -1) return { error: `${String(bad + 1)} 件目に address（文字列）と quote（文字列）がありません` };
+  return { citations: entries.filter(isCitation).map((entry) => ({ address: entry.address, quote: entry.quote })) };
+};
+
+const MESSAGES: Readonly<Record<CitationResult["status"], (result: CitationResult) => string>> = {
+  ok: () => "一致",
+  "missing-address": (result) => `番地 ${result.citation.address} は原文にありません`,
+  "quote-elsewhere": (result) => `引用文は ${result.citation.address} ではなく ${result.foundAt ?? "番地の外"}（${String(result.line ?? "?")} 行目）にあります`,
+  "quote-not-found": () => "引用文が原文のどこにもありません",
+};
+
+const describe = (result: CitationResult): string => {
+  const mark = result.status === "ok" ? "✓" : "✗";
+  const oneLine = result.citation.quote.replace(/\s+/gu, " ").trim();
+  const quote = oneLine.length > QUOTE_WIDTH ? `${oneLine.slice(0, QUOTE_WIDTH)}…` : oneLine;
+  return `${mark} ${result.citation.address}「${quote}」: ${MESSAGES[result.status](result)}`;
+};
+
+/**
+ * 回答の引用が原文にあるかを確かめる。書き換えはしない。
+ * 一つでも外れていれば 1 で終わるので、AI の回答を単体試験のように検査できる。
+ */
+export const runCite = async (targets: readonly string[], argv: readonly string[], context: TreeContext): Promise<number> => {
+  const [sourcePath, citationsPath] = targets;
+  const format = context.flag(argv, "--format") ?? "text";
+  if (sourcePath === undefined || citationsPath === undefined || targets.length !== 2 || !FORMATS.includes(format)) {
+    console.error(USAGE);
+    return 1;
+  }
+  const citationsText = await readSource(citationsPath);
+  if (citationsText === undefined) return 1;
+  const parsed = parseCitations(citationsText);
+  if ("error" in parsed) {
+    console.error(`${citationsPath}: ${parsed.error}`);
+    return 1;
+  }
+  const read = await readTree(sourcePath, argv, context);
+  if (read === undefined) return 1;
+  const results = checkCitations(read.source, read.tree, parsed.citations);
+  console.log(format === "json" ? JSON.stringify(results, null, 2) : results.map(describe).join("\n"));
+  return results.every((result) => result.status === "ok") ? 0 : 1;
+};

package/src/commands/eval.ts

@@ -58,6 +58,7 @@ export const runEval = async (targets: readonly string[], argv: readonly string[
         rules,
         genre,
         language,
+        config.limits,
       ),
       docs.length,
       paths.length,

package/src/commands/tree.ts

@@ -0,0 +1,94 @@
+import { readFile } from "node:fs/promises";
+import { loadAdapter } from "../adapter-load.ts";
+import { applyByPath } from "../config/by-path.ts";
+import { guessLanguage } from "../detect.ts";
+import { isMarkdownPath } from "../structure/markdown-path.ts";
+import { buildStructure } from "../structure/of.ts";
+import { toSexp } from "../structure/sexp.ts";
+import type { Config } from "../config/load.ts";
+import type { StructureNode } from "../plugin.ts";
+
+export type TreeContext = {
+  readonly config: Config;
+  readonly flag: (argv: readonly string[], name: string) => string | undefined;
+};
+
+const FORMATS = ["sexp", "json"];
+
+const USAGE = "使い方: chaff tree <file>... [--format sexp|json] [--language ja|en|…]";
+
+/** 値を取るフラグ。その次の引数は値で、対象のファイルではない。 */
+const VALUED = ["--format", "--language"];
+
+export const treeTargets = (argv: readonly string[]): string[] =>
+  argv.slice(1).filter((arg, index, all) => !arg.startsWith("--") && !VALUED.includes(all[index - 1] ?? ""));
+
+export const readSource = async (path: string): Promise<string | undefined> => {
+  try {
+    return await readFile(path, "utf8");
+  } catch (err) {
+    console.error(`${path} を読めませんでした: ${err instanceof Error ? err.message : String(err)}`);
+    return undefined;
+  }
+};
+
+/**
+ * 言語の決め方は lint / test / eval と同じ。そのファイルの by_path、全体の language、中身からの推定の順で、
+ * その前に --language を置く。混在するリポジトリで、英語の契約書を日本語として読まないため。
+ */
+export const treeLanguage = (path: string, source: string, argv: readonly string[], context: TreeContext): string =>
+  context.flag(argv, "--language") ??
+  applyByPath(context.config.byPath, context.config.baseDir, path).language ??
+  context.config.language ??
+  guessLanguage(source).language;
+
+export type SourceTree = { readonly source: string; readonly tree: StructureNode };
+
+/**
+ * 1 ファイルを読んで木にする。読めない・言語パッケージが構造を読めないときは、黙らずに言って undefined を返す。
+ * chaff tree と chaff cite が同じ木を見るように、ここを一つにしておく。
+ */
+export const readTree = async (path: string, argv: readonly string[], context: TreeContext): Promise<SourceTree | undefined> => {
+  const source = await readSource(path);
+  if (source === undefined) return undefined;
+  const language = treeLanguage(path, source, argv, context);
+  const adapter = await loadAdapter(language);
+  if (adapter.structure === undefined) {
+    console.error(`${path}: 言語 ${language} のパッケージは文書の構造を読めません（structure がありません）`);
+    return undefined;
+  }
+  // 日本語は形態素で数量と日付を読む。解析器が無ければ単位の表で読むので、木は作れる。
+  await adapter.prepare?.({ pos: true });
+  return { source, tree: buildStructure({ path, source, language, markdown: isMarkdownPath(path) }, adapter.structure) };
+};
+
+const printTree = async (path: string, argv: readonly string[], context: TreeContext): Promise<boolean> => {
+  const read = await readTree(path, argv, context);
+  if (read === undefined) return false;
+  console.log(context.flag(argv, "--format") === "json" ? JSON.stringify(read.tree, null, 2) : toSexp(read.tree));
+  return true;
+};
+
+/**
+ * 1 つずつ、渡された順に処理する。前のファイルが終わってから次を始めるので、出力の順が入れ替わらない。
+ * 失敗したファイルがあっても残りは処理し、1 つでも失敗していれば false を返す。
+ */
+export const inOrder = async (paths: readonly string[], each: (path: string) => Promise<boolean>): Promise<boolean> =>
+  paths.reduce<Promise<boolean>>(async (previous, path) => {
+    const earlier = await previous;
+    return (await each(path)) && earlier;
+  }, Promise.resolve(true));
+
+/**
+ * 文書を番地の付いた木にして出す。S 式は人と AI が読むため、JSON は機械が読むため。
+ * 書き換えはしない。Markdown でない .txt（見出しの無い契約書）も、行頭の番号で木にする。
+ */
+export const runTree = async (paths: readonly string[], argv: readonly string[], context: TreeContext): Promise<number> => {
+  const format = context.flag(argv, "--format") ?? "sexp";
+  if (paths.length === 0 || !FORMATS.includes(format)) {
+    console.error(USAGE);
+    return 1;
+  }
+  const printed = await inOrder(paths, (path) => printTree(path, argv, context));
+  return printed ? 0 : 1;
+};

package/src/config/load.ts

@@ -14,12 +14,18 @@ export type Config = {
   readonly aiBackend: BackendName;
   readonly language: string | undefined;
   readonly rules: Readonly<Record<string, Level>>;
+  /** rules に数値で書いた上限。段階の 4 語では足りないときに、その rule の数値を直接決める。段階は normal として扱う。 */
+  readonly limits: Readonly<Record<string, number>>;
+  /** rules に書かれていたが読めなかった値。黙って捨てると、書いた設定が効いていないことに気づけない。 */
+  readonly unreadableRules: readonly { readonly id: string; readonly value: string }[];
   readonly experimental: boolean;
   readonly path: string | undefined;
   readonly aiModel: string;
   readonly confidenceThreshold: number;
   /** チームの言葉。社内でしか通じない語を、チームが自分で並べる。 */
   readonly jargon: readonly string[];
+  /** チームの表記。{ 使わない書き方: 使う書き方 }。「サーバー」ではなく「サーバ」、のように。 */
+  readonly prefer: Readonly<Record<string, string>>;
   /** この種類の文書に無いと困る見出し。チームが自分で決める。 */
   readonly requiredSections: readonly string[];
   /** パスごとの上書き。設定ファイルのある場所からの相対で照合する。 */
@@ -35,12 +41,15 @@ export const EMPTY: Config = {
   genre: undefined,
   language: undefined,
   rules: {},
+  limits: {},
+  unreadableRules: [],
   experimental: false,
   path: undefined,
   aiBackend: DEFAULT_BACKEND,
   aiModel: defaultModel(DEFAULT_BACKEND),
   confidenceThreshold: 0.7,
   jargon: [],
+  prefer: {},
   requiredSections: [],
   byPath: [],
   baseDir: process.cwd(),
@@ -48,11 +57,29 @@ export const EMPTY: Config = {
 
 const isRecord = (value: unknown): value is Record<string, unknown> => typeof value === "object" && value !== null && !Array.isArray(value);
 
+const isLimit = (value: unknown): value is number => typeof value === "number" && Number.isFinite(value) && value > 0;
+
+/** 段階の 4 語はそのまま、数値の上限は normal として読む。上限そのものは limitsOf が持つ。 */
 const rulesOf = (raw: unknown): Record<string, Level> => {
   if (!isRecord(raw)) return {};
-  return Object.entries(raw).reduce<Record<string, Level>>((acc, [id, value]) => (isLevel(value) ? { ...acc, [id]: value } : acc), {});
+  return Object.fromEntries(
+    Object.entries(raw).flatMap(([id, value]): [string, Level][] => {
+      if (isLevel(value)) return [[id, value]];
+      return isLimit(value) ? [[id, "normal"]] : [];
+    }),
+  );
 };
 
+const limitsOf = (raw: unknown): Record<string, number> =>
+  isRecord(raw) ? Object.fromEntries(Object.entries(raw).flatMap(([id, value]): [string, number][] => (isLimit(value) ? [[id, value]] : []))) : {};
+
+const unreadableOf = (raw: unknown): { id: string; value: string }[] =>
+  isRecord(raw)
+    ? Object.entries(raw)
+        .filter(([, value]) => !isLevel(value) && !isLimit(value))
+        .map(([id, value]) => ({ id, value: JSON.stringify(value) ?? String(value) }))
+    : [];
+
 const str = (value: unknown): string | undefined => (typeof value === "string" ? value : undefined);
 
 /** files は 1 つの文字列でも配列でも書ける。 */
@@ -72,6 +99,18 @@ const toPathRule = (raw: unknown): PathRule | undefined => {
 /** 利用者が書く語の並び。空白だけのものは落とす。 */
 const wordsOf = (raw: unknown): string[] => (Array.isArray(raw) ? raw.map((entry) => String(entry).trim()).filter((entry) => entry.length > 0) : []);
 
+/** 両側とも空でない文字列の対だけを読む。同じ語どうし（「サーバ: サーバ」）は何も言えないので捨てる。 */
+const preferOf = (raw: unknown): Record<string, string> =>
+  isRecord(raw)
+    ? Object.fromEntries(
+        Object.entries(raw).flatMap(([avoid, use]): [string, string][] => {
+          const from = avoid.trim();
+          const to = typeof use === "string" ? use.trim() : "";
+          return from !== "" && to !== "" && from !== to ? [[from, to]] : [];
+        }),
+      )
+    : {};
+
 const byPathOf = (raw: unknown): PathRule[] => (Array.isArray(raw) ? raw.map(toPathRule).filter((rule) => rule !== undefined) : []);
 
 /** 設定ファイルが無くても動く。あっても、既定から変えたものだけが書かれている。spec §18。 */
@@ -84,12 +123,15 @@ export const loadConfig = (path: string): Config => {
     genre: str(raw["genre"]),
     language: str(raw["language"]),
     rules: rulesOf(raw["rules"]),
+    limits: limitsOf(raw["rules"]),
+    unreadableRules: unreadableOf(raw["rules"]),
     experimental: raw["experimental"] === true,
     path,
     aiBackend: backend,
     aiModel: str(raw["ai_model"]) ?? defaultModel(backend),
     confidenceThreshold: typeof raw["confidence_threshold"] === "number" ? raw["confidence_threshold"] : 0.7,
     jargon: wordsOf(raw["jargon"]),
+    prefer: preferOf(raw["prefer"]),
     requiredSections: wordsOf(raw["required_sections"]),
     byPath: byPathOf(raw["by_path"]),
     baseDir: dirname(path),

package/src/config/rule-problems.ts

@@ -0,0 +1,24 @@
+import type { Config } from "./load.ts";
+
+/**
+ * chaff.yaml の rules のうち、効いていないもの。知らない rule 名と、読めない値。
+ * どちらも黙って捨てると、書いた人は設定したつもりで何も変わっていない。打ち間違いがいちばん多い。
+ */
+export const ruleProblems = (
+  config: Pick<Config, "rules" | "limits" | "unreadableRules" | "path">,
+  known: readonly { readonly id: string; readonly layer: string }[],
+): string[] => {
+  const knownIds = new Set(known.map((rule) => rule.id));
+  const where = config.path ?? "chaff.yaml";
+  const written = [...new Set([...Object.keys(config.rules), ...Object.keys(config.limits), ...config.unreadableRules.map((entry) => entry.id)])];
+  const unknown = written.filter((id) => !knownIds.has(id)).map((id) => `${where}: ${id} というルールはありません（npx chaff rules --json で一覧が出ます）`);
+  const unreadable = config.unreadableRules
+    .filter((entry) => knownIds.has(entry.id))
+    .map((entry) => `${where}: ${entry.id} の値 ${entry.value} は読めません（strict / normal / relaxed / off か、正の数）`);
+  // 意味を読む検査（L4）に閾値は無い。数を書いても normal として動くので、そう言う。
+  const semantic = new Set(known.filter((rule) => rule.layer === "L4").map((rule) => rule.id));
+  const numberOnSemantic = Object.keys(config.limits)
+    .filter((id) => semantic.has(id))
+    .map((id) => `${where}: ${id} は意味を読む検査なので数値の上限はありません。normal として動きます（strict / normal / relaxed / off で書いてください）`);
+  return [...unknown, ...unreadable, ...numberOnSemantic];
+};

package/src/detectors/index.ts

@@ -14,6 +14,8 @@ import { paragraphLength, paragraphVariance, preambleLength, ruleOfThree, sectio
 import { concreteEvidence, dashDensity, emojiDensity, ngramRepetition, undefinedAcronym } from "./signals.ts";
 import { aiTell, contractionMix, cushionDensity, hedgingDensity, repeatedConjunction, unqualifiedSuperlative } from "./lexicon.ts";
 import { internalJargon, properNounDensity, requiredSections } from "./team.ts";
+import { latinSpacing, preferredTerm } from "./orthography.ts";
+import { danglingReference, duplicateDefinition, numberingGap } from "./structure-tree.ts";
 
 /** rule 定義の how_to_find がここを引く。rule 側は実装を知らない。 */
 export const DETECTORS: Readonly<Record<string, Detector>> = {
@@ -53,4 +55,9 @@ export const DETECTORS: Readonly<Record<string, Detector>> = {
   "internal-jargon": internalJargon,
   "required-sections": requiredSections,
   "proper-noun-density": properNounDensity,
+  "preferred-term": preferredTerm,
+  "latin-spacing": latinSpacing,
+  "dangling-reference": danglingReference,
+  "numbering-gap": numberingGap,
+  "duplicate-definition": duplicateDefinition,
 };