chaffjs 0.17.0 → 0.19.0

package/src/detectors/orthography.ts

@@ -1,8 +1,9 @@
 import type { Detector, Finding, ProseDocument, Sentence, Span } from "../plugin.ts";
-import { calendarRuns, calendarUnitsOf, type CalendarRun, type CalendarUnits } from "../calendar-number.ts";
-import { latinBoundaries, minorityStyle, occurrencesOutside, type Boundary, type SpacingKind } from "../orthography.ts";
+import { calendarRuns, calendarUnitsOf, type CalendarUnits } from "../calendar-number.ts";
+import { escapeRegExp, latinBoundaries, occurrencesOutside, type Boundary, type SpacingKind } from "../orthography.ts";
+import { minorityReport } from "../spacing-minority.ts";
 import { isWithinAny, quotedSpans } from "../quoted-span.ts";
-import { digitRunAround, isNumberName, sequenceLabelStarts } from "../number-name.ts";
+import { digitRunAround, endsWithDivisionLabel, isNumberName, sequenceLabelStarts, type NameContext } from "../number-name.ts";
 
 /** チームが chaff.yaml の prefer に書いた「使わない書き方」。書いていなければ何も言わない。 */
 export const preferredTerm: Detector = (doc, options): Finding[] => {
@@ -32,38 +33,105 @@ const digitBeside = (boundary: Boundary): number => {
   return boundary.spaced ? boundary.offset + 1 : boundary.offset;
 };
 
-/** 文書全体で一度だけ読むもの。sequence は続き番号の行の頭、topUnits は都道府県の単位、calendar は日付・時刻の単位。 */
-type NumberContext = { readonly sequence: ReadonlySet<number>; readonly topUnits: ReadonlySet<string>; readonly calendar: CalendarUnits };
+/**
+ * 文書全体で一度だけ読むもの（number-name.ts の NameContext に加えて）。calendar は日付・時刻の単位、
+ * divisions は「第1節」のように「第」と番号の後ろに書く区切りの語。
+ */
+type NumberContext = NameContext & {
+  readonly calendar: CalendarUnits;
+  readonly divisions: ReadonlySet<string>;
+  readonly itemNumbers: ReadonlySet<string>;
+};
 
-/** 文の中の日付・時刻の数の、並びの頭の位置と、日付の中の位置。 */
-const calendarPlaces = (sentence: Sentence, units: CalendarUnits): ReadonlyMap<number, CalendarRun["place"]> =>
-  new Map(calendarRuns(sentence.text, sentence.tokens, sentence.span.start, units).map(({ run, place }) => [run.start, place]));
+/** 文頭の項目の番号の後ろと見る境目の位置の上限。番号は短く文の頭にあるので、これより後ろの境目は番号の後ろではない。長い文で文頭からの切り出しを繰り返さない。 */
+const ITEM_NUMBER_REACH = 8;
+
+/** 行の頭の字下げと箇条書きの印。 */
+const ITEM_LEAD = /^[\s\-*+]*/u;
 
 /**
- * 日付・時刻の中の境目（「9月」の数と単位のあいだ、「2026年9月」の年と 9 のあいだ）は、詰めて書く決まりで好みではない。
- * 日付の前の境目（「は 9月」の空白）は、数の前をどう空けるかという書き手の書き方なので数える。
+ * 文書が項目の番号として行の頭に並べたもの（語彙表 item-number は並びの順）。行の頭に空白で本文と区切って書かれ、
+ * 前か次の番号も同じように書かれているものだけ。「一」「二」は番号、前後の無い「十 GBまで」の十は数量。
  */
-const isInsideCalendar = (boundary: Boundary, place: CalendarRun["place"] | undefined): boolean =>
-  place !== undefined && (boundary.kind === "after-digit" || place === "inner");
+const numberedItems = (ordered: readonly string[], source: string): ReadonlySet<string> => {
+  if (ordered.length === 0) return new Set();
+  const labels = ordered.toSorted((left, right) => right.length - left.length).map(escapeRegExp);
+  const atHead = new Set([...source.matchAll(new RegExp(`^[ \\t\\-*+]*(${labels.join("|")})[ \\u3000]`, "gmu"))].map((match) => match[1]));
+  return new Set(ordered.filter((label, at) => atHead.has(label) && (atHead.has(ordered[at - 1]) || atHead.has(ordered[at + 1]))));
+};
 
-/** 番号・識別子として書かれた数（number-name.ts）と日付・時刻の中の境目は、空け方の好みではないので数えない。 */
-const isCounted = (sentence: Sentence, boundary: Boundary, context: NumberContext, calendar: ReadonlyMap<number, CalendarRun["place"]>): boolean => {
+/** 境目が、文頭の項目の番号と本文を分ける空白か（「一 JIS」）。 */
+const followsItemNumber = (text: string, boundary: Boundary, itemNumbers: ReadonlySet<string>): boolean =>
+  boundary.spaced && boundary.offset <= ITEM_NUMBER_REACH && itemNumbers.has(text.slice(0, boundary.offset).replace(ITEM_LEAD, ""));
+
+/** 文の中の日付・時刻の数の、並びの頭の位置。 */
+const calendarStarts = (sentence: Sentence, units: CalendarUnits): ReadonlySet<number> =>
+  new Set(calendarRuns(sentence.text, sentence.tokens, sentence.span.start, units).map(({ run }) => run.start));
+
+/**
+ * 番号・識別子として書かれた数（number-name.ts）、日付・時刻の数、「第1節」の後ろの境目、文頭の項目の番号（「一 JIS」）の後ろの境目は、空け方の好みではないので数えない。
+ * 日付・時刻は前の境目（「は 9月」「午後3時」「令和 3 年」）も数えない。日付はまとめて一つの書き方で、数量の空け方の票にはしない。
+ */
+const isCounted = (sentence: Sentence, boundary: Boundary, context: NumberContext, calendar: ReadonlySet<number>): boolean => {
+  if (followsItemNumber(sentence.text, boundary, context.itemNumbers)) return false;
+  if (boundary.kind !== "after-digit" && endsWithDivisionLabel(sentence.text.slice(0, boundary.offset), context.divisions)) return false;
   if (boundary.kind === "letter") return true;
   const run = digitRunAround(sentence.text, digitBeside(boundary));
   if (run === undefined) return true;
-  if (isInsideCalendar(boundary, calendar.get(run.start))) return false;
-  return !isNumberName(sentence.text, run, sentence.tokens, sentence.span.start, context.sequence, context.topUnits);
+  if (calendar.has(run.start)) return false;
+  return !isNumberName(sentence.text, run, sentence.tokens, sentence.span.start, context);
 };
 
 const patternList = (doc: ProseDocument, id: string): string[] => (doc.lexicons[id] ?? []).map((entry) => entry.pattern);
 const patternsOf = (doc: ProseDocument, id: string): ReadonlySet<string> => new Set(patternList(doc, id));
 
+/** 語彙表 numbered-label のうち、番号の position 側に書く語。 */
+const labelsAt = (doc: ProseDocument, position: "before" | "after"): ReadonlySet<string> =>
+  new Set((doc.lexicons["numbered-label"] ?? []).filter((entry) => entry.position === position).map((entry) => entry.pattern));
+
 /**
  * 鉤括弧で引いた題名や発言（「…ガイドライン ver. 1.1」）の中の境目。空け方は引いた元のもので、書き手の書き方ではない。
  * 括弧は日本語の字でも英数字でもないので、境目はまるごと括弧の中か外にある。
  */
 const isQuoted = (quoted: readonly Span[], boundary: Boundary): boolean => isWithinAny(quoted, { start: boundary.offset, end: boundary.offset });
 
+/**
+ * リンクの文字の中の境目。リンクの文字は引いた記事や資料の題であることが多く、空け方は元のものなので、鉤括弧の中と同じに数えない。
+ * リンクの外側の端（「を [記事]」の空白）は書き手の空け方なので数える。at は文書全体の位置。
+ */
+const isInsideLink = (links: readonly Span[], at: number): boolean => links.some((link) => link.start < at && at < link.end);
+
+const findingAt = (entry: Located, values: Finding["values"], variant?: string): Finding => ({
+  rule: "",
+  severity: "warning",
+  line: 0,
+  column: 0,
+  quote: entry.sentence.text.trim(),
+  ...(variant === undefined ? {} : { variant }),
+  values: { ...values, offset: entry.sentence.span.start + entry.offset },
+});
+
+/** 一つの種類の境目の指摘。少ないほうを 1 箇所ずつか、書き方が二通りあれば 1 件で（spacing-minority.ts）。 */
+const findingsOf = (kind: SpacingKind, ofKind: readonly Located[], limit: number): Finding[] => {
+  const report = minorityReport(ofKind, limit);
+  if (report === undefined) return [];
+  if (report.mode === "mixed") {
+    const { first, odd, spaced, touching } = report;
+    return [findingAt(first, { kind: KIND_NAME[kind], spaced, touching, count: odd, of: ofKind.length, limit }, "mixed")];
+  }
+  const minority = report.odd[0]?.spaced ?? false;
+  return report.odd.map((entry) =>
+    findingAt(entry, {
+      kind: KIND_NAME[kind],
+      style: minority ? "空けています" : "詰めています",
+      usual: minority ? "詰める" : "空ける",
+      count: report.odd.length,
+      of: ofKind.length,
+      limit,
+    }),
+  );
+};
+
 /**
  * 日本語と英字・数字のあいだを、空けるか詰めるか。文書の中で混ざっていたら、少ないほうを指摘する。
  * どちらが正しいかは決めない。決めるのはチームで、chaff はそろっているかだけを見る。
@@ -73,36 +141,24 @@ export const latinSpacing: Detector = (doc, options): Finding[] => {
   const context: NumberContext = {
     sequence: sequenceLabelStarts(doc.prose ?? doc.source),
     topUnits: patternsOf(doc, "prefecture-unit"),
+    labelWords: labelsAt(doc, "before"),
     calendar: calendarUnitsOf(doc),
+    divisions: labelsAt(doc, "after"),
+    itemNumbers: numberedItems(patternList(doc, "item-number"), doc.prose ?? doc.source),
   };
   const located: Located[] = doc.sentences.flatMap((sentence) => {
     const quoted = quotedSpans(sentence.text);
-    const calendar = calendarPlaces(sentence, context.calendar);
+    const calendar = calendarStarts(sentence, context.calendar);
     return latinBoundaries(sentence.text, doc.source.slice(sentence.span.start, sentence.span.end))
-      .filter((boundary) => !isQuoted(quoted, boundary) && isCounted(sentence, boundary, context, calendar))
+      .filter((boundary) => !isQuoted(quoted, boundary) && !isInsideLink(doc.links, sentence.span.start + boundary.offset))
+      .filter((boundary) => isCounted(sentence, boundary, context, calendar))
       .map((boundary) => ({ sentence, ...boundary }));
   });
-  return KINDS.flatMap((kind) => {
-    const ofKind = located.filter((entry) => entry.kind === kind);
-    const minority = minorityStyle(ofKind);
-    if (minority === undefined) return [];
-    const odd = ofKind.filter((entry) => entry.spaced === minority);
-    if (odd.length < options.limit) return [];
-    return odd.map((entry) => ({
-      rule: "",
-      severity: "warning",
-      line: 0,
-      column: 0,
-      quote: entry.sentence.text.trim(),
-      values: {
-        kind: KIND_NAME[kind],
-        style: minority ? "空けています" : "詰めています",
-        usual: minority ? "詰める" : "空ける",
-        count: odd.length,
-        of: ofKind.length,
-        limit: options.limit,
-        offset: entry.sentence.span.start + entry.offset,
-      },
-    }));
-  });
+  return KINDS.flatMap((kind) =>
+    findingsOf(
+      kind,
+      located.filter((entry) => entry.kind === kind),
+      options.limit,
+    ),
+  );
 };

package/src/detectors/outside-announced-list.ts

@@ -0,0 +1,25 @@
+import type { Detector, Finding } from "../plugin.ts";
+import { listStatementsIn, outsideMembers } from "../announced-list.ts";
+import { linesOf, lineNumberAt } from "../structure/lines.ts";
+import { quoteAt } from "./structure-tree.ts";
+
+/** 最初に挙げた一覧（対応 OS は Windows と macOS）に無い名前を、後の文が同じ語で言う所（Linux にも対応）。 */
+export const outsideAnnouncedList: Detector = (doc): Finding[] => {
+  const lowered = (id: string): Set<string> => new Set((doc.lexicons[id] ?? []).map((entry) => entry.pattern.toLowerCase()));
+  const words = { frames: doc.lexicons["enumeration-frame"] ?? [], joiners: lowered("enumeration-joiner"), negations: lowered("enumeration-negation") };
+  const statements = doc.sentences.flatMap((sentence) => listStatementsIn(sentence, words, doc.source));
+  const lines = linesOf(doc.source);
+  return outsideMembers(statements).map(({ member, announced }) => ({
+    rule: "",
+    severity: "warning",
+    line: 0,
+    column: 0,
+    quote: quoteAt(doc.source, member.offset),
+    values: {
+      name: member.name,
+      list: announced.members.map((listed) => listed.name).join(", "),
+      listLine: lineNumberAt(lines, announced.offset) ?? 0,
+      offset: member.offset,
+    },
+  }));
+};