chaffjs 0.17.0 → 0.19.0

package/dist/text-figures.js

@@ -0,0 +1,131 @@
+import { mergeSpans } from "./span-merge.js";
+import { spansOfType } from "./markdown-read.js";
+/**
+ * 線と矢印で描いた図（RFC の状態遷移図、やり取りの図、枠の表）。文ではないので、コードブロックと同じく本文から外す。
+ *
+ * 見分けるのは形だけ。線の文字が多いか、語のあいだを 3 字以上空けて桁をそろえた行で、文の句読点が無いもの。
+ * そういう行が続く塊（行のあいだの空行は 1 行まで）のうち、2 行以上あり、線の行を 1 行でも含むものを図とする。
+ * 句読点の無い短い行（図の中の「(Close)」）は、図の行に挟まれていれば図に入る。塊の端にあれば入らない。
+ * 語の多い行は、句読点が無くても文の行（折り返した文の途中）として塊を切る。
+ * 桁をそろえただけの語の表は、線が無ければ本文のまま読む。
+ */
+/** 線を引く文字。ASCII の + - | / \ < > ^ = と、U+2500 台の罫線・U+25A0 台の図形（▶ ▼）。 */
+const LINE_CHAR = /[+\-|/\\<>^=\u2500-\u25FF]/gu;
+/** 下向きの矢印として一文字で立つ v。語の中の v は数えない。 */
+const ARROW_V = /(?<=^|\s)[vV](?=\s|$)/gu;
+/** 線の文字が 3 つ続けば線（-->、+---+、<==）。 */
+const LINE_RUN = /[+\-|/\\<>^=\u2500-\u25FF]{3,}/gu;
+/** ただし「---」ちょうどは、語のあいだのダッシュ（47.041 --- Engineering）。 */
+const DASH = /^-{3}$/u;
+/** 行の空白以外の文字のうち、この割合以上が線の文字なら線の行。「== Community ==」のような見出しの印は半分に届かない。 */
+const LINE_SHARE = 0.5;
+/** 割合で線の行と読むのに要る、線の文字の数。箇条書きの「- EU」は印が 1 つだけ。 */
+const MIN_LINE_CHARS = 2;
+/** 語のあいだの 3 字以上の空白は、桁をそろえた印。文の区切りの空白は 2 字まで（RFC は文のあいだを 2 字空ける）。 */
+const COLUMN_GAP = /\S {3,}\S/u;
+/** 文の印: 語の直後の句読点に、次の語が続く（"reply. It"、"link, then"）。日本語は句点か読点があれば文。 */
+const SENTENCE = /\p{L}\p{L}[.,;:?!]["')\]]?\s+\p{L}|[。、]/u;
+/**
+ * 行末で終わる文（"alpha  Sends requests."、"beta  Uses TCP."）。見るのは最後の桁で、小文字の語があり . ? ! で終わるもの。
+ * 括弧で閉じた注記（"(return to LISTEN!)"）と省略の点（"..."）は図の中の書き方で、文の終わりではない。
+ */
+const SENTENCE_END = /[^.][.?!]["'”’]?$/u;
+const LOWER_WORD = /\p{Ll}\p{Ll}/u;
+const LAST_CELL = / {3,}/u;
+const endsSentence = (text) => {
+    const cell = text.trim().split(LAST_CELL).at(-1) ?? "";
+    return SENTENCE_END.test(cell) && LOWER_WORD.test(cell);
+};
+/**
+ * 同じ線の文字だけの行（-----、==== ====）。見出しの下線や段の区切りで、図の中にあってもよいが図の印にはならない。
+ * 印にすると、区切りの線 2 本に挟まれた題（===== / Title / =====）や、下線を引いた見出しの前の箇条書きまで図になる。
+ */
+const RULE_LINE = /^\s*([-=_~*])\1*(?:\s+\1+)*\s*$/u;
+/** 行頭の箇条書きの印（-、*、+、1.、a)）。印の後ろの空白は桁そろえではない。 */
+const LIST_MARK = /^\s*(?:[-*+]|\p{N}{1,3}[.)]|\p{L}[.)])(?=\s)/u;
+/** 語。句読点の無い行でも、語が多ければ文の一部（折り返した文の行）で、図の中の注記ではない。 */
+const WORD = /\p{L}[\p{L}\p{N}'-]*/gu;
+/** 図の中の注記（「(Close)」「(2 MSL)」「CLOSED」）の語の数の上限。 */
+const MAX_PLAIN_WORDS = 4;
+/** 図の中で、行と行のあいだに置ける空行の数。 */
+const MAX_BLANK_RUN = 1;
+/** 図と読むのに要る行の数。区切りの線 1 行は図ではない。 */
+const MIN_FIGURE_LINES = 2;
+const matchesOf = (text, pattern) => [...text.matchAll(pattern)].map((match) => match[0]);
+const count = (text, pattern) => matchesOf(text, pattern).length;
+/** 箇条書きの印は線に数えない（「- /」はパンくずの区切り）。 */
+const isLineArt = (text) => {
+    const body = text.replace(LIST_MARK, "");
+    const visible = body.replace(/\s/gu, "").length;
+    const drawn = count(body, LINE_CHAR) + count(body, ARROW_V);
+    return matchesOf(body, LINE_RUN).some((run) => !DASH.test(run)) || (drawn >= MIN_LINE_CHARS && drawn >= visible * LINE_SHARE);
+};
+const kindOf = (text) => {
+    if (text.trim() === "")
+        return "blank";
+    if (SENTENCE.test(text) || endsSentence(text))
+        return "text";
+    if (RULE_LINE.test(text))
+        return "plain";
+    if (isLineArt(text))
+        return "line";
+    if (COLUMN_GAP.test(text.replace(LIST_MARK, "").trimStart()))
+        return "column";
+    return count(text, WORD) > MAX_PLAIN_WORDS ? "text" : "plain";
+};
+/** skip の中で始まる行は、文の行と同じく塊を切る。行も範囲も先頭から順に進むので、行ごとに範囲を全部なめない。 */
+const rowsOf = (source, skip) => {
+    const regions = mergeSpans(skip, false);
+    const scan = { start: 0, region: 0 };
+    return source.split("\n").map((text) => {
+        while ((regions[scan.region]?.end ?? Number.POSITIVE_INFINITY) <= scan.start)
+            scan.region += 1;
+        const region = regions[scan.region];
+        const skipped = region !== undefined && region.start <= scan.start;
+        const row = { start: scan.start, end: scan.start + text.length, kind: skipped ? "text" : kindOf(text) };
+        scan.start = row.end + 1;
+        return row;
+    });
+};
+/** 図の行の塊。空行が MAX_BLANK_RUN を超えて続くか、文の行が来たら切れる。塊の端の空行と句読点の無い行は入れない。 */
+const runsOf = (rows) => {
+    // 行ごとに配列を作り直すと、何万行の文書で行数の二乗になる。塊は押し足していく。
+    const runs = [[]];
+    const scan = { blanks: 0 };
+    const cut = () => {
+        if ((runs.at(-1) ?? []).length > 0)
+            runs.push([]);
+    };
+    rows.forEach((row) => {
+        if (row.kind === "blank") {
+            scan.blanks += 1;
+            if (scan.blanks > MAX_BLANK_RUN)
+                cut();
+            return;
+        }
+        scan.blanks = 0;
+        if (row.kind === "text")
+            cut();
+        else
+            runs.at(-1)?.push(row);
+    });
+    return runs.map(trimPlain).filter((run) => run.length > 0);
+};
+const isDrawn = (row) => row.kind === "line" || row.kind === "column";
+const trimPlain = (run) => {
+    const first = run.findIndex(isDrawn);
+    return first === -1 ? [] : run.slice(first, run.findLastIndex(isDrawn) + 1);
+};
+const isFigure = (run) => run.filter(isDrawn).length >= MIN_FIGURE_LINES && run.some((row) => row.kind === "line");
+/**
+ * テキストの図の範囲。最初の行の頭から最後の行の終わりまで（あいだの空行も入る）。source は LF でそろえたもの。
+ * skip は図と別に読む範囲（Markdown のコード・表・HTML・見出し）。その中の行は図の行に数えない。
+ */
+export const textFigures = (source, skip = []) => runsOf(rowsOf(source, skip))
+    .filter(isFigure)
+    .map((run) => ({ start: run[0]?.start ?? 0, end: run.at(-1)?.end ?? 0 }));
+/** Markdown が図と別に読む塊。この中の線は図として探さない（コードはもともと本文でなく、表の区切りの行は表、見出しは見出し）。 */
+const NOT_FIGURE = ["code", "table", "html", "heading"];
+/** Markdown の図。コード・表・HTML・見出しの外に描かれたものだけ。 */
+export const markdownFigures = (root, source) => textFigures(source, NOT_FIGURE.flatMap((type) => spansOfType(root, type)));
+//# sourceMappingURL=text-figures.js.map

package/dist/text-figures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-figures.js","sourceRoot":"","sources":["../src/text-figures.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGjD;;;;;;;;GAQG;AAEH,uEAAuE;AACvE,MAAM,SAAS,GAAG,8BAA8B,CAAC;AACjD,sCAAsC;AACtC,MAAM,OAAO,GAAG,yBAAyB,CAAC;AAC1C,oCAAoC;AACpC,MAAM,QAAQ,GAAG,kCAAkC,CAAC;AACpD,wDAAwD;AACxD,MAAM,IAAI,GAAG,SAAS,CAAC;AACvB,wEAAwE;AACxE,MAAM,UAAU,GAAG,GAAG,CAAC;AACvB,iDAAiD;AACjD,MAAM,cAAc,GAAG,CAAC,CAAC;AACzB,oEAAoE;AACpE,MAAM,UAAU,GAAG,YAAY,CAAC;AAChC,sEAAsE;AACtE,MAAM,QAAQ,GAAG,0CAA0C,CAAC;AAC5D;;;GAGG;AACH,MAAM,YAAY,GAAG,oBAAoB,CAAC;AAC1C,MAAM,UAAU,GAAG,eAAe,CAAC;AACnC,MAAM,SAAS,GAAG,QAAQ,CAAC;AAE3B,MAAM,YAAY,GAAG,CAAC,IAAY,EAAW,EAAE;IAC7C,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IACvD,OAAO,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1D,CAAC,CAAC;AACF;;;GAGG;AACH,MAAM,SAAS,GAAG,kCAAkC,CAAC;AACrD,+CAA+C;AAC/C,MAAM,SAAS,GAAG,+CAA+C,CAAC;AAClE,oDAAoD;AACpD,MAAM,IAAI,GAAG,wBAAwB,CAAC;AACtC,iDAAiD;AACjD,MAAM,eAAe,GAAG,CAAC,CAAC;AAC1B,4BAA4B;AAC5B,MAAM,aAAa,GAAG,CAAC,CAAC;AACxB,mCAAmC;AACnC,MAAM,gBAAgB,GAAG,CAAC,CAAC;AAO3B,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,OAAe,EAAY,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAEpH,MAAM,KAAK,GAAG,CAAC,IAAY,EAAE,OAAe,EAAU,EAAE,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,MAAM,CAAC;AAEzF,qCAAqC;AACrC,MAAM,SAAS,GAAG,CAAC,IAAY,EAAW,EAAE;IAC1C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IACzC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC;IAChD,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,GAAG,KAAK,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5D,OAAO,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,KAAK,IAAI,cAAc,IAAI,KAAK,IAAI,OAAO,GAAG,UAAU,CAAC,CAAC;AAChI,CAAC,CAAC;AAEF,MAAM,MAAM,GAAG,CAAC,IAAY,EAAQ,EAAE;IACpC,IAAI,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE;QAAE,OAAO,OAAO,CAAC;IACvC,IAAI,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,YAAY,CAAC,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC;IAC7D,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC;QAAE,OAAO,OAAO,CAAC;IACzC,IAAI,SAAS,CAAC,IAAI,CAAC;QAAE,OAAO,MAAM,CAAC;IACnC,IAAI,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,SAAS,EAAE,CAAC;QAAE,OAAO,QAAQ,CAAC;IAC9E,OAAO,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC;AAChE,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,MAAM,GAAG,CAAC,MAAc,EAAE,IAAqB,EAAS,EAAE;IAC9D,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,EAAE,KAAK,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACrC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,IAAI,MAAM,CAAC,iBAAiB,CAAC,IAAI,IAAI,CAAC,KAAK;YAAE,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAC/F,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QACpC,MAAM,OAAO,GAAG,MAAM,KAAK,SAAS,IAAI,MAAM,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC;QACnE,MAAM,GAAG,GAAQ,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7G,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;QACzB,OAAO,GAAG,CAAC;IACb,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,MAAM,GAAG,CAAC,IAAoB,EAAW,EAAE;IAC/C,0CAA0C;IAC1C,MAAM,IAAI,GAAY,CAAC,EAAE,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC;IAC3B,MAAM,GAAG,GAAG,GAAS,EAAE;QACrB,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACpD,CAAC,CAAC;IACF,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;QACnB,IAAI,GAAG,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACzB,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;YACjB,IAAI,IAAI,CAAC,MAAM,GAAG,aAAa;gBAAE,GAAG,EAAE,CAAC;YACvC,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;QAChB,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM;YAAE,GAAG,EAAE,CAAC;;YAC1B,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9B,CAAC,CAAC,CAAC;IACH,OAAO,IAAI,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;AAC7D,CAAC,CAAC;AAEF,MAAM,OAAO,GAAG,CAAC,GAAQ,EAAW,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,CAAC;AAEpF,MAAM,SAAS,GAAG,CAAC,GAAmB,EAAS,EAAE;IAC/C,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IACrC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,MAAM,QAAQ,GAAG,CAAC,GAAmB,EAAW,EAAE,CAAC,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,IAAI,gBAAgB,IAAI,GAAG,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;AAE5I;;;GAGG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CAAC,MAAc,EAAE,OAAwB,EAAE,EAAU,EAAE,CAChF,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACzB,MAAM,CAAC,QAAQ,CAAC;KAChB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC;AAE9E,yEAAyE;AACzE,MAAM,UAAU,GAAG,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAExD,6CAA6C;AAC7C,MAAM,CAAC,MAAM,eAAe,GAAG,CAAC,IAAkB,EAAE,MAAc,EAAU,EAAE,CAC5E,WAAW,CACT,MAAM,EACN,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CACtD,CAAC"}

package/dist/trailing-aside.d.ts

@@ -0,0 +1,2 @@
+export declare const ownEnd: (text: string) => number;
+//# sourceMappingURL=trailing-aside.d.ts.map

package/dist/trailing-aside.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trailing-aside.d.ts","sourceRoot":"","sources":["../src/trailing-aside.ts"],"names":[],"mappings":"AAyCA,eAAO,MAAM,MAAM,GAAI,MAAM,MAAM,KAAG,MAQrC,CAAC"}

package/dist/trailing-aside.js

@@ -0,0 +1,53 @@
+/**
+ * 文末に添えた括弧（「最優先制約とする（§17）。」の（§17））を除いた、文そのものの終わり。
+ * 括弧が注記そのもの（文全体が括弧か、終わった文の後ろで「。）」と閉じる）なら、文末はその中にある。
+ * 述語に続く括弧は、中で文が終わっていても添え物（「費用（…を除く。）」）。続けて添えた括弧は全部除く。
+ *
+ * 後ろから一度だけ読む。法令の文は数千字あり、添えた括弧が何百も続くことがある。
+ */
+const OPEN = new Set(["(", "（"]);
+const CLOSE = new Set([")", "）"]);
+const STOPS = new Set(["。", "．", "！", "？", "!", "?"]);
+const LINE_BREAKS = new Set(["\n", "\r"]);
+const isSpace = (unit) => /\s/u.test(unit);
+const isInlineSpace = (unit) => unit === " " || unit === "\t" || unit === "　";
+/** before より前で、skip に当たらない最後の位置。無ければ -1。 */
+const lastBefore = (text, before, skip) => {
+    let index = before - 1;
+    while (index >= 0 && skip(text.charAt(index)))
+        index -= 1;
+    return index;
+};
+/** closeAt の閉じ括弧と対になる開き括弧の位置。対が無ければ undefined。 */
+const openingOf = (text, closeAt) => {
+    let depth = 0;
+    for (let index = closeAt - 1; index >= 0; index -= 1) {
+        const unit = text.charAt(index);
+        if (CLOSE.has(unit))
+            depth += 1;
+        else if (OPEN.has(unit) && depth === 0)
+            return index;
+        else if (OPEN.has(unit))
+            depth -= 1;
+    }
+    return undefined;
+};
+/** open から closeAt までの括弧が注記そのもの: 文の頭にあるか、終わった文の後ろで、中の文が終わっている。 */
+const isNote = (text, open, closeAt) => {
+    if (lastBefore(text, open, isSpace) === -1)
+        return true;
+    const previous = text.charAt(lastBefore(text, open, isInlineSpace));
+    const inner = lastBefore(text, closeAt, isSpace);
+    return (STOPS.has(previous) || LINE_BREAKS.has(previous)) && inner > open && STOPS.has(text.charAt(inner));
+};
+export const ownEnd = (text) => {
+    let limit = text.length;
+    for (;;) {
+        const closeAt = lastBefore(text, limit, (unit) => isSpace(unit) || STOPS.has(unit));
+        const open = CLOSE.has(text.charAt(closeAt)) ? openingOf(text, closeAt) : undefined;
+        if (open === undefined)
+            return limit;
+        limit = isNote(text, open, closeAt) ? closeAt : open;
+    }
+};
+//# sourceMappingURL=trailing-aside.js.map

package/dist/trailing-aside.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trailing-aside.js","sourceRoot":"","sources":["../src/trailing-aside.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACjC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AAClC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC,CAAC;AACtD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAC1C,MAAM,OAAO,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC5D,MAAM,aAAa,GAAG,CAAC,IAAY,EAAW,EAAE,CAAC,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,GAAG,CAAC;AAE/F,4CAA4C;AAC5C,MAAM,UAAU,GAAG,CAAC,IAAY,EAAE,MAAc,EAAE,IAA+B,EAAU,EAAE;IAC3F,IAAI,KAAK,GAAG,MAAM,GAAG,CAAC,CAAC;IACvB,OAAO,KAAK,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAAE,KAAK,IAAI,CAAC,CAAC;IAC1D,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,kDAAkD;AAClD,MAAM,SAAS,GAAG,CAAC,IAAY,EAAE,OAAe,EAAsB,EAAE;IACtE,IAAI,KAAK,GAAG,CAAC,CAAC;IACd,KAAK,IAAI,KAAK,GAAG,OAAO,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,KAAK,IAAI,CAAC,CAAC;aAC3B,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC;YAAE,OAAO,KAAK,CAAC;aAChD,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;YAAE,KAAK,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,MAAM,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,OAAe,EAAW,EAAE;IACtE,IAAI,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;QAAE,OAAO,IAAI,CAAC;IACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,IAAI,EAAE,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;IACpE,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACjD,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,IAAI,KAAK,GAAG,IAAI,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC7G,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,MAAM,GAAG,CAAC,IAAY,EAAU,EAAE;IAC7C,IAAI,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC;IACxB,SAAS,CAAC;QACR,MAAM,OAAO,GAAG,UAAU,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;QACpF,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACpF,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACrC,KAAK,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC;IACvD,CAAC;AACH,CAAC,CAAC"}

package/dist/tree-walk.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Walks over the Markdown tree and the structure tree. Both keep their own stack instead of recursing:
+ * a blockquote nested ten thousand levels deep is valid Markdown, and one call per level overflows the call stack.
+ */
+type Branching<T> = {
+    readonly children?: readonly T[] | undefined;
+};
+/** Each node before its children, children from the left: the order a recursive walk visits them. */
+export declare const eachPreOrder: <T extends Branching<T>>(root: T, visit: (node: T) => void) => void;
+/** The nodes in pre-order. */
+export declare const preOrder: <T extends Branching<T>>(root: T) => T[];
+/**
+ * Each node's value from its children's values: children first, from the left, then the node. depth is 0 at the root.
+ * The same calls in the same order as `combine(node, childrenOf(node).map(recurse), depth)`.
+ */
+export declare const foldPostOrder: <T, R>(root: T, childrenOf: (node: T) => readonly T[], combine: (node: T, children: readonly R[], depth: number) => R) => R;
+export {};
+//# sourceMappingURL=tree-walk.d.ts.map

package/dist/tree-walk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-walk.d.ts","sourceRoot":"","sources":["../src/tree-walk.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,KAAK,SAAS,CAAC,CAAC,IAAI;IAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,EAAE,GAAG,SAAS,CAAA;CAAE,CAAC;AAErE,qGAAqG;AACrG,eAAO,MAAM,YAAY,GAAI,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,IAAI,KAAG,IAQxF,CAAC;AAEF,8BAA8B;AAC9B,eAAO,MAAM,QAAQ,GAAI,CAAC,SAAS,SAAS,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,KAAG,CAAC,EAI3D,CAAC;AAIF;;;GAGG;AACH,eAAO,MAAM,aAAa,GAAI,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,EAAE,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,SAAS,CAAC,EAAE,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAE,KAAK,EAAE,MAAM,KAAK,CAAC,KAAG,CAgBpJ,CAAC"}

package/dist/tree-walk.js

@@ -0,0 +1,45 @@
+/**
+ * Walks over the Markdown tree and the structure tree. Both keep their own stack instead of recursing:
+ * a blockquote nested ten thousand levels deep is valid Markdown, and one call per level overflows the call stack.
+ */
+/** Each node before its children, children from the left: the order a recursive walk visits them. */
+export const eachPreOrder = (root, visit) => {
+    const pending = [root];
+    while (pending.length > 0) {
+        const node = pending.pop();
+        if (node === undefined)
+            return;
+        visit(node);
+        (node.children ?? []).toReversed().forEach((child) => pending.push(child));
+    }
+};
+/** The nodes in pre-order. */
+export const preOrder = (root) => {
+    const nodes = [];
+    eachPreOrder(root, (node) => nodes.push(node));
+    return nodes;
+};
+/**
+ * Each node's value from its children's values: children first, from the left, then the node. depth is 0 at the root.
+ * The same calls in the same order as `combine(node, childrenOf(node).map(recurse), depth)`.
+ */
+export const foldPostOrder = (root, childrenOf, combine) => {
+    const frames = [{ node: root, children: childrenOf(root), results: [] }];
+    for (;;) {
+        const frame = frames.at(-1);
+        if (frame === undefined)
+            throw new Error("foldPostOrder lost its root");
+        const next = frame.children[frame.results.length];
+        if (next !== undefined) {
+            frames.push({ node: next, children: childrenOf(next), results: [] });
+            continue;
+        }
+        frames.pop();
+        const value = combine(frame.node, frame.results, frames.length);
+        const parent = frames.at(-1);
+        if (parent === undefined)
+            return value;
+        parent.results.push(value);
+    }
+};
+//# sourceMappingURL=tree-walk.js.map

package/dist/tree-walk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-walk.js","sourceRoot":"","sources":["../src/tree-walk.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,qGAAqG;AACrG,MAAM,CAAC,MAAM,YAAY,GAAG,CAAyB,IAAO,EAAE,KAAwB,EAAQ,EAAE;IAC9F,MAAM,OAAO,GAAQ,CAAC,IAAI,CAAC,CAAC;IAC5B,OAAO,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;QAC3B,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,KAAK,CAAC,IAAI,CAAC,CAAC;QACZ,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAC7E,CAAC;AACH,CAAC,CAAC;AAEF,8BAA8B;AAC9B,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAyB,IAAO,EAAO,EAAE;IAC/D,MAAM,KAAK,GAAQ,EAAE,CAAC;IACtB,YAAY,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAIF;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAAO,IAAO,EAAE,UAAqC,EAAE,OAA8D,EAAK,EAAE;IACvJ,MAAM,MAAM,GAAkB,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;IACxF,SAAS,CAAC;QACR,MAAM,KAAK,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACxE,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;QAClD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,MAAM,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC;YACrE,SAAS;QACX,CAAC;QACD,MAAM,CAAC,GAAG,EAAE,CAAC;QACb,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAC7B,IAAI,MAAM,KAAK,SAAS;YAAE,OAAO,KAAK,CAAC;QACvC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC,CAAC"}

package/genres.yaml

@@ -47,6 +47,15 @@ groups:
       paragraph-length-variance: off
       ai-tell: off
       ai-generated-composite: off
+      contrast-framing: off
+      stock-transition: off
+      announcing-opener: off
+      colon-lead-in: off
+      bold-label-list: off
+      # Statutes and opinions write "not inconsistent with" on purpose.
+      double-negative: off
+      # Legal drafting writes 「…を行う」 and "make a payment" as its register; the corpus statutes are full of them.
+      nominalization: off
   # A help page repeats its heading in its first line (To upload a file, ...) and states no claims to back up.
   - id: docs
     name: { ja: 説明書, en: Documentation }
@@ -71,6 +80,11 @@ groups:
       paragraph-length-variance: off
       ai-tell: off
       ai-generated-composite: off
+      contrast-framing: off
+      stock-transition: off
+      announcing-opener: off
+      colon-lead-in: off
+      bold-label-list: off
   # Science writes in the passive, hedges its claims on purpose (may, suggest) and cites numbers as its evidence.
   - id: academic
     name: { ja: 学術, en: Academic }
@@ -91,6 +105,9 @@ groups:
       rule-of-three: off
       section-length-uniformity: off
       paragraph-length-variance: off
+      stock-transition: off
+      bold-label-list: off
+      requirement-smell: off
   # Length, rhythm, repetition and register are the author's choices in literature, and dialogue mixes styles.
   # Only what one work can hold itself to runs: consistent spacing and commas, and numbering without gaps.
   - id: literature
@@ -135,11 +152,27 @@ groups:
       paragraph-length-variance: off
       ai-tell: off
       ai-generated-composite: off
+      contrast-framing: off
+      stock-transition: off
+      announcing-opener: off
+      colon-lead-in: off
+      bold-label-list: off
+      nominalization: off
       dangling-reference: off
       duplicate-definition: off
       date-order: off
       date-weekday-mismatch: off
       total-mismatch: off
+      announced-count-mismatch: off
+      dangling-figure-reference: off
+      date-range-reversed: off
+      percent-sum-mismatch: off
+      vague-figure-reference: off
+      # A narrator may hedge, speak with ら dropped, and spell as the work's time and place did.
+      double-negative: off
+      ra-nuki: off
+      spelling-consistency: off
+      requirement-smell: off
   # A speech opens with greetings and closes with thanks: that is its form, not padding.
   - id: speech
     name: { ja: 話し言葉, en: Speech }
@@ -154,6 +187,14 @@ groups:
       rule-of-three: off
       section-length-uniformity: off
       paragraph-length-variance: off
+      contrast-framing: off
+      stock-transition: off
+      announcing-opener: off
+      colon-lead-in: off
+      # A transcript keeps the speaker's words: hedges and ら dropped as spoken.
+      double-negative: off
+      ra-nuki: off
+      requirement-smell: off
 
 genres:
   - id: technical/spec
@@ -206,11 +247,21 @@ genres:
     summary:
       ja: プレスリリースと、お知らせ
       en: Press releases and public notices
+    # A release names the agency, the people quoted, the mission and the place: that is its news, not a crowd of
+    # names to thin out. Every English release in the corpus (GSA, NASA, NOAA) is over the limit.
+    rules:
+      proper-noun-density: off
   - id: business/meeting-notes
     name: { ja: 議事録, en: Meeting notes }
     summary:
       ja: 議事録・議事要旨
       en: Minutes and meeting notes
+    # Minutes record what the meeting did (the meeting was held, 了承された): the actor is the meeting, by the form.
+    # In the corpus the rule fires on nearly every set of minutes, English and Japanese.
+    # A header block of labelled fields (- **日時**：…, - **出席者**：…) is the form of minutes, not a list of captions.
+    rules:
+      agentless-passive: off
+      bold-label-list: off
   - id: legal/contract
     name: { ja: 契約書・規約, en: Contract and terms }
     summary:
@@ -231,6 +282,8 @@ genres:
       dangling-reference: normal
       date-weekday-mismatch: normal
       total-mismatch: normal
+      dangling-figure-reference: normal
+      date-range-reversed: normal
   - id: legal/statute
     name: { ja: 法令・規程, en: Statute and regulation }
     summary:
@@ -250,6 +303,10 @@ genres:
       dangling-reference: normal
       date-weekday-mismatch: normal
       total-mismatch: normal
+      dangling-figure-reference: normal
+      date-range-reversed: normal
+      # A statute defines its 等 terms (以下「個人情報等」という) and uses them in its obligations.
+      requirement-smell: off
   - id: legal/judgment
     name: { ja: 判決, en: Court decision }
     summary:
@@ -258,6 +315,9 @@ genres:
     suggest:
       ja: { line: "^(?:#{1,6}\\s*)?(?:主\\s*文|理\\s*由|判\\s*決)\\s*$", min_lines: 2 }
       en: { line: "delivered the opinion of the Court|^(?:Reversed|Affirmed)\\.?$", min_lines: 1 }
+    # requirement-smell is for the documents that state requirements: specifications, contracts and documentation.
+    rules:
+      requirement-smell: off
   - id: legal/patent
     name: { ja: 特許明細書, en: Patent }
     summary:
@@ -266,6 +326,9 @@ genres:
     suggest:
       ja: { line: "【(?:課題|解決手段|請求項[0-9０-９]+|選択図|技術分野|背景技術|発明の詳細な説明|特許請求の範囲)】", min_lines: 2 }
       en: { line: "^#{1,6}\\s*(?:BACKGROUND OF THE INVENTION|SUMMARY OF THE INVENTION|Claims\\b)|\\bof claim \\d+", min_lines: 3 }
+    # requirement-smell is for the documents that state requirements: specifications, contracts and documentation.
+    rules:
+      requirement-smell: off
   - id: docs/manual
     name: { ja: マニュアル・手順書, en: Manual and how-to }
     summary:
@@ -297,6 +360,8 @@ genres:
     rules:
       taigen-dome-in-prose: off
       ngram-repetition: off
+      # An entry that ends 〜すること or 〜のこと defines a word; it is no requirement.
+      requirement-smell: off
   - id: academic/paper
     name: { ja: 論文, en: Academic paper }
     summary:
@@ -383,6 +448,8 @@ genres:
       agreement-slip: off
       sasete-itadaku: off
       double-keigo: off
+      # Labelled speaker turns (- **記者**：…) are how a transcript is laid out.
+      bold-label-list: off
       cushion-phrase-density: off
       excessive-hedging: off
       unqualified-superlative: off
@@ -393,3 +460,4 @@ genres:
       undefined-acronym: off
       ai-tell: off
       ai-generated-composite: off
+      assistant-residue: off

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chaffjs",
-  "version": "0.17.0",
+  "version": "0.19.0",
   "description": "Prose validation harness. Finds what is hard to read, and never rewrites it for you.",
   "keywords": [
     "chaff",
@@ -33,6 +33,10 @@
     "./plugin": {
       "types": "./src/plugin.ts",
       "import": "./dist/plugin.js"
+    },
+    "./api": {
+      "types": "./src/api.ts",
+      "import": "./dist/api.js"
     }
   },
   "files": [
@@ -42,8 +46,10 @@
     "dist",
     "genres.yaml",
     "profiles",
+    "reference-headings.yaml",
     "rules",
     "skills",
+    "styles",
     "src"
   ],
   "engines": {
@@ -55,8 +61,8 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.125.0",
-    "@chaffjs/lang-en": "0.15.0",
-    "@chaffjs/lang-ja": "0.16.0",
+    "@chaffjs/lang-en": "0.17.0",
+    "@chaffjs/lang-ja": "0.18.0",
     "mdast-util-from-markdown": "^2.0.3",
     "mdast-util-frontmatter": "^2.0.1",
     "mdast-util-gfm-table": "^2.0.0",

package/reference-headings.yaml

@@ -0,0 +1,17 @@
+# 文献一覧の見出し。言語の見当付け（どの言語パッケージを読むか）は、この見出しの下の一覧を数えない。
+# 文献一覧は本文の言語ではなく、引いた文献の言語で書かれる。日本語の論文の英語の文献が多いと、文書が英語に見える。
+# 見当付けは言語パッケージを読む前に動くので、どちらの言語の見出しもここに置く。大文字と小文字は区別しない。
+headings:
+  - 参考文献
+  - 引用文献
+  - 参照文献
+  - 文献
+  - 文献一覧
+  - 引用・参考文献
+  - 参考・引用文献
+  - References
+  - Reference
+  - Bibliography
+  - Works Cited
+  - Literature Cited
+  - Cited Literature

package/rules/acronym-expansion-conflict.yaml

@@ -0,0 +1,82 @@
+id: acronym-expansion-conflict
+layer: L3
+status: experimental
+how_to_find: acronym-expansion-conflict
+severity: warning
+
+name:
+  ja: 同じ略語の二通りの展開
+  en: Abbreviation expanded two ways
+
+why:
+  ja: 同じ略語を二か所で違う名前に展開すると、読み手は二つが同じものか別のものか分かりません。片方は書き違いか、別の文書から貼った文であることが多いです。
+  en: An abbreviation spelled out as two different names leaves the reader unsure whether they are the same thing. One of them is usually a slip, or a sentence pasted from another document.
+
+message:
+  ja: 「{acronym}」をここでは「{name}」と、{firstLine} 行目では「{first}」と展開しています
+  en: '"{acronym}" is expanded as "{name}" here and as "{first}" on line {firstLine}'
+
+how_to_fix:
+  ja: どちらの名前が正しいかを確かめ、一つに揃えてください。別のものなら、別の略語にします。
+  en: Check which name is right and use it in both places. If they are different things, give them different abbreviations.
+
+placeholders:
+  acronym:
+    ja: 略語
+    en: the abbreviation
+  name:
+    ja: 名前
+    en: one name
+  first:
+    ja: 別の名前
+    en: another
+  firstLine:
+    ja: 〇
+    en: N
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: consistency
+summary:
+  ja: 同じ略語を、文書の中で違う名前に展開している所
+  en: The same abbreviation spelled out as two different names in one document
+example:
+  ja:
+    before: |
+      SLA（サービス品質保証）を毎月見直します。障害が続いた月は、SLA（サービスレベル契約）に従って返金します。
+    after: |
+      SLA（サービス品質保証）を毎月見直します。障害が続いた月は、SLA に従って返金します。
+  en:
+    before: |
+      We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the Support Level Agreement (SLA).
+    after: |
+      We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the SLA.
+
+not_flagged:
+  ja: 名前の大文字小文字、ハイフン、終わりの複数の s の違いは同じ名前と見ます。英語の名前は、頭文字が略語と揃うときだけ展開と読みます。
+  en: Differences of case, hyphens and a final plural s are not counted. An English name counts as an expansion only when its initials spell the abbreviation.
+rewrite:
+  ja:
+    direction: 二つの展開のうち正しいほうを書き手に確かめ、もう一方を消すか正しい名前に替えてください。二度目以降は略語だけで書けます。
+    pairs:
+      - before: SLA（サービス品質保証）を毎月見直します。障害が続いた月は、SLA（サービスレベル契約）に従って返金します。
+        after: SLA（サービス品質保証）を毎月見直します。障害が続いた月は、SLA に従って返金します。
+      - before: CI（継続的インテグレーション）で毎晩試験します。失敗したら CI（構成情報）を見直します。
+        after: CI（継続的インテグレーション）で毎晩試験します。失敗したら構成情報を見直します。（二つが別のものであるとき）
+    keep:
+      - 正しいほうの名前
+    avoid:
+      - どちらが正しいかを書き手に聞かずに決める
+  en:
+    direction: Ask the writer which expansion is right, then remove or correct the other. After the first, the abbreviation alone is enough.
+    pairs:
+      - before: We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the Support Level Agreement (SLA).
+        after: We review the Service Level Agreement (SLA) every month. After an outage, refunds follow the SLA.
+      - before: Tests run nightly in CI (Continuous Integration). On a failure, check the CI (Configuration Item).
+        after: Tests run nightly in CI (Continuous Integration). On a failure, check the configuration item. (when the two are different things)
+    keep:
+      - the right name
+    avoid:
+      - picking one without asking the writer

package/rules/adverb-overuse.yaml

@@ -26,3 +26,22 @@ how_to_fix:
 levels: { strict: 10, normal: 15, relaxed: 25 }
 
 use_for: [blog, business, legal, docs, academic, literature, speech]
+
+group: readability
+summary:
+  ja: 英語で、-ly の副詞が多すぎる所（弱い動詞の印になりやすい）
+  en: Too many -ly adverbs, which usually prop up a weak verb
+example:
+  en:
+    pad: true
+    before: |
+      She quickly walked to the room and quietly opened the door. He really badly needed the report and angrily asked for it.
+    after: |
+      She hurried to the room and eased the door open. He needed the report and demanded it.
+
+not_flagged:
+  ja: 短い文書（200 語より短いもの）は測りません。
+  en: Documents under 200 words are not measured.
+level_meaning:
+  ja: 1000 語あたり -ly 副詞 {limit} 個まで
+  en: up to {limit} -ly adverbs per 1000 words