@sushichan044/kg-core 0.4.1 → 0.6.0

package/README.md

@@ -63,7 +63,8 @@ element has source, display, and grapheme ranges; empty placement elements use
 Parsers implement `ManuscriptParser`. Composers implement `ManuscriptComposer`
 and provide Valibot schemas for their settings and layout. Proofreading rules
 carry `kind: "parsed"` or `kind: "composed"` to declare which manuscript they
-need, and report findings through `context.report`.
+need, and report findings through `context.report`. A report may name a
+`severity`; omitting it means `error`.
 
 A plugin signals its own failure with a `Rejection` — a plain reason string.
 Core turns that into a variant of the stage's error union, so plugins never
@@ -88,9 +89,45 @@ Grapheme ranges index the normalized grapheme array. Diagnostics include
 one-based source line and column positions, so renderers do not need to search
 or recalculate locations.
 
-The default proofreading rules report common Japanese novel-style issues and
-Unicode variation sequences. Diagnostics do not modify the source and do not
-contain automatic fixes.
+## Proofreading rules
+
+`createDefaultProofreadingRules()` returns the rules whose answer does not
+depend on the work: how a paragraph opens and how far it is indented,
+punctuation before a closing bracket, spacing after `！` and `？`, ellipsis and
+dash forms and counts, repeated punctuation and interpuncts, a minus sign that
+no number follows, halfwidth Japanese punctuation, Arabic
+numeral length, and Unicode variation sequences.
+
+Rules that depend on the work's own conventions are exported individually and
+report `warning` instead of `error`, so a caller opts into them:
+
+```ts
+import {
+  consistentKanjiOpeningRule,
+  consistentLatinWidthRule,
+  consistentNumeralWidthRule,
+  createConsistentKanjiOpeningRule,
+  createDefaultProofreadingRules,
+} from "@sushichan044/kg-core";
+
+const rules = [
+  ...createDefaultProofreadingRules(),
+  consistentNumeralWidthRule(),
+  consistentLatinWidthRule(),
+  consistentKanjiOpeningRule(),
+];
+```
+
+`createConsistentKanjiOpeningRule({ pairs })` replaces the built-in kanji and
+kana pairs; like every configurable rule it returns a `ManuscriptResult` and
+fails with `InvalidRuleOptions` rather than dropping bad options.
+
+`dashRule()` prefers `―` (U+2015). Use `createDashRule({ preferred: "—" })` or
+`createDashRule({ preferred: "─" })` when a work uses U+2014 or U+2500 instead.
+The selected character must appear in even-length runs. Repeated choonpu (`ー`)
+are not treated as dashes.
+
+Diagnostics do not modify the source and do not contain automatic fixes.
 
 ## Browser support