chaffjs 0.27.1 → 0.29.0

package/rules/tax-mismatch.yaml

@@ -0,0 +1,71 @@
+id: tax-mismatch
+layer: L3
+status: stable
+how_to_find: tax-amount
+# The words of a tax row and of an included tax come from the language's tax-label and tax-included-word lexicons; the
+# subtotal row is found with total-label, the lexicon total-mismatch reads.
+requires: [quantities]
+languages: [ja, en]
+severity: error
+
+name:
+  ja: 税額が小計に税率を掛けた額と合わない
+  en: A tax that is not its rate of the subtotal
+
+why:
+  ja: 見積書や請求書の「消費税（10%）」の金額が、小計の10%と合わないと、読み手は税の計算を確かめ直し、合計も信じられなくなります。合計の額に税率を掛けてしまったときや、小計を直して税を直し忘れたときに起きます。表か箇条書きで、税の語（消費税・税額）で始まり率を書いた行の金額を、上の小計の行の金額（小計の行が無ければ上の項目の和）に率を掛けた額と比べます。
+  en: When the "Sales tax (10%)" of a quote or an invoice is not 10% of the subtotal, the reader has to work the tax out again and can no longer trust the total. It happens when the rate is applied to the total instead of the subtotal, or when the subtotal is changed and the tax is not. In a list or a table, the amount of a line starting with a tax word (Tax, Sales tax, VAT) and giving a rate is compared with that rate of the subtotal line above it (or, with no subtotal line, of the sum of the items above).
+
+message:
+  ja: 税額「{written}」が、上の金額の{rate}（{expected}）と合いません
+  en: "The tax {written} is not {rate} of the amount above it ({expected})"
+
+how_to_fix:
+  ja: 小計と税率を確かめて、税額を計算し直してください。合計も一緒に直します。
+  en: Check the subtotal and the rate and work the tax out again. Correct the total with it.
+
+levels: { normal: error, relaxed: warning }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+off_for:
+  literature: "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."
+
+group: facts
+summary:
+  ja: 見積書や請求書で、「消費税（10%）」の金額が小計の10%と合わない所
+  en: A tax line in a quote or an invoice whose amount is not its rate of the subtotal
+example:
+  ja:
+    before: |
+      | 項目 | 金額 |
+      | --- | --- |
+      | 設計 | 300,000円 |
+      | 開発 | 500,000円 |
+      | 小計 | 800,000円 |
+      | 消費税（10%） | 88,000円 |
+    after: |
+      | 項目 | 金額 |
+      | --- | --- |
+      | 設計 | 300,000円 |
+      | 開発 | 500,000円 |
+      | 小計 | 800,000円 |
+      | 消費税（10%） | 80,000円 |
+  en:
+    before: |
+      | Item | Amount |
+      | --- | --- |
+      | Design | $3,000 |
+      | Build | $5,000 |
+      | Subtotal | $8,000 |
+      | Sales tax (10%) | $880 |
+    after: |
+      | Item | Amount |
+      | --- | --- |
+      | Design | $3,000 |
+      | Build | $5,000 |
+      | Subtotal | $8,000 |
+      | Sales tax (10%) | $800 |
+
+not_flagged:
+  ja: 端数は切り捨て・四捨五入・切り上げのどれでも合っていると読みます。率を書いていない税の行、合計に含まれる税（「うち消費税」「内税」）の行、率の違う税の行が並ぶ表（軽減税率の8%と10%）、小計と税の行の間に金額の行（値引き・送料）がある表は比べません。文の中に書いた税は読みません。
+  en: Rounding down, to the nearest or up are all read as right. A tax line with no rate, a line for tax included in the total ("tax included"), a table with tax lines of different rates, and a table with an amount line (a discount, shipping) between the subtotal and the tax are not compared. A tax written in a sentence is not read.

package/rules/time-order.yaml

@@ -0,0 +1,65 @@
+id: time-order
+layer: L3
+status: stable
+how_to_find: time-order
+requires: [dates]
+severity: warning
+
+name:
+  ja: 一日の予定の時刻が前後している
+  en: A time out of order in a day's schedule
+
+why:
+  ja: 旅程や式次第のように、頭に時刻を書いた項目を並べた箇条書きや表で、ひとつだけ前の項目より早い時刻があると、書き間違いか順番の入れ替わりかを読み手が確かめることになり、集まる時刻を間違える人も出ます。一日の予定は早い順に並ぶので、その順に逆らう時刻を指します。日付の見出しが変わるところ、行の頭の日付が変わるところで一日を区切ります。23:30 の次の 0:15 のように夜をまたぐ時刻は、翌日の印（翌、+1）があれば翌日の時刻として読みます。
+  en: In a list or a table whose items start with a time, such as an itinerary or a programme, one time earlier than the item before it makes the reader check whether it is a typo or a swapped row, and someone turns up at the wrong time. A day's schedule runs from the earliest time, so a time against that order is pointed out. A day ends where a date heading or the date at the start of a row changes. A time past midnight, such as 0:15 after 23:30, is read as the next day's when it is marked so (+1, "next day").
+
+message:
+  ja: 「{time}」が、前後の時刻の並びから外れています（前は「{previous}」）
+  en: "{time} breaks the order of the times around it (after {previous})"
+
+messages:
+  first:
+    ja: 「{time}」が、後の時刻の並びから外れています（次は「{next}」）
+    en: "{time} breaks the order of the times after it (before {next})"
+
+how_to_fix:
+  ja: 時刻を確かめて、書き間違いなら直し、順番が違うなら並べ替えてください。
+  en: Check the time. Correct it if it is a typo, or move the item if the order is wrong.
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+off_for:
+  literature: "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."
+
+group: facts
+summary:
+  ja: 旅程や式次第で、一つだけ時刻の順番が前後している所
+  en: One time out of order in an itinerary or a day's programme
+example:
+  ja:
+    before: |
+      - 09:00 工場の見学
+      - 12:00 昼食
+      - 11:00 報告会
+      - 18:00 懇親会
+    after: |
+      - 09:00 工場の見学
+      - 12:00 昼食
+      - 14:00 報告会
+      - 18:00 懇親会
+  en:
+    before: |
+      - 9:00 AM Tour of the plant
+      - 12:00 PM Lunch
+      - 11:00 AM Report meeting
+      - 6:30 PM Dinner
+    after: |
+      - 9:00 AM Tour of the plant
+      - 12:00 PM Lunch
+      - 2:00 PM Report meeting
+      - 6:30 PM Dinner
+
+not_flagged:
+  ja: 時刻が二つしかない並び、早い順に並ぶ時刻が半分以下の並び（時刻で並べた一覧ではない）、項目の頭でなく文の中に書いた時刻は比べません。夜をまたいで半日より大きく戻る時刻（23:30 の次の 0:15）は、翌日の印が無くても翌日の時刻と読みます。「現地時間」の付いた時刻や時間帯の印が変わる所では一日を区切ります。
+  en: 'A run of only two times, a list where no more than half of the times are in order (not a schedule), and times written inside a sentence rather than at the start of an item are not compared. A time more than half a day earlier than the one before it (0:15 after 23:30) is read as past midnight even without a mark. A "local time" mark, or a change of time zone, starts a new day.'

package/rules/title-length.yaml

@@ -79,8 +79,8 @@ example:
       What every store does during the move in the 2025 financial year.
 
 not_flagged:
-  ja: 見出しの頭の番号（「第2章」「1.」）は数えません。英字の語は一語を二文字と数えます。報告書・プレスリリース・議事録・仕様書・論文は上限が高く、法務・文学・話し言葉のジャンルと、見出しが質問の文になる FAQ では見ません。
-  en: A number label at the head of a heading (Chapter 2, 1.) is not counted. Reports, press releases, minutes, specifications and papers have a higher limit; legal, literary and speech genres, and FAQs (whose headings are questions), do not run this rule.
+  ja: 見出しの頭の番号（「第2章」「1.」）は数えません。英字の語は一語を二文字と数えます。報告書・プレスリリース・議事録・仕様書・論文は上限が高く、法務・文学・話し言葉のジャンルと、見出しが質問の文になる FAQ では見ません。ほかのジャンルでも、？で終わる質問の見出しは、長さが読み手の問いそのものなので見ません。
+  en: A number label at the head of a heading (Chapter 2, 1.) is not counted. Reports, press releases, minutes, specifications and papers have a higher limit; legal, literary and speech genres, and FAQs (whose headings are questions), do not run this rule. In any genre, a heading that ends with a question mark is not counted, since its length is the reader's question.
 level_meaning:
   ja: 題や見出しが {limit} 文字を超えたら指摘
   en: reported when a title or heading runs past {limit} words

package/rules/ui-label-variant.yaml

@@ -0,0 +1,70 @@
+id: ui-label-variant
+layer: L3
+status: stable
+how_to_find: ui-label
+# A label is text in bold or in ［］; the words a label is written with or without come from the label-particle lexicon.
+languages: [ja, en]
+severity: info
+
+name:
+  ja: 二通りに書いた画面の札
+  en: Screen label written two ways
+
+why:
+  ja: 手順書で同じボタンを［復元を開始］とも［復元開始］とも書くと、読み手は画面に二つのボタンがあるのかと探します。画面の文字と同じ綴りで書くのが手順書の決まりです。画面の文言が変わったあとに一部だけ直すと起きます。太字か［］で囲んだ札のうち、大文字・小文字、空白、「を」「の」だけが違う二つを同じ札と見て、少ないほうを指します。
+  en: "When a manual writes the same button as **Start Restore** in one step and **Start restore** in another, the reader looks for two buttons. A manual spells every label exactly as the screen does. It happens when the screen's wording changes and only some steps are updated. Labels in bold (or in ［］) that differ only in case, spaces or a particle are read as one label, and the form written less often is pointed out."
+
+message:
+  ja: 「{written}」は、ほかの所では「{usual}」と書いています
+  en: '"{written}" is written as "{usual}" elsewhere'
+
+how_to_fix:
+  ja: 画面の文字を確かめて、どちらか一方にそろえてください。
+  en: Check the screen and use its spelling in every step.
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [technical, docs, blog, legal, academic, literature, speech]
+off_for:
+  legal: "Screen labels in bold or in brackets are a convention of manuals and technical writing."
+  academic: "Screen labels in bold or in brackets are a convention of manuals and technical writing."
+  literature: "Screen labels in bold or in brackets are a convention of manuals and technical writing."
+  speech: "Screen labels in bold or in brackets are a convention of manuals and technical writing."
+
+group: consistency
+summary:
+  ja: 太字や［］の画面の札で、大文字・小文字や空白、「を」「の」だけが違う二通りの書き方
+  en: A bold or bracketed screen label written two ways that differ only in case, spaces or a particle
+example:
+  ja:
+    config: { genre: docs/manual }
+    before: |
+      # 復元する
+
+      ［復元を開始］を押します。終わらないときは、もう一度［復元を開始］を押します。
+
+      失敗したら、前のバックアップを選んで［復元開始］を押します。
+    after: |
+      # 復元する
+
+      ［復元を開始］を押します。終わらないときは、もう一度［復元を開始］を押します。
+
+      失敗したら、前のバックアップを選んで［復元を開始］を押します。
+  en:
+    config: { genre: docs/manual }
+    before: |
+      # Restore
+
+      Click **Start Restore**. If nothing happens, click **Start Restore** again.
+
+      If it fails, select the previous backup and click **Start restore**.
+    after: |
+      # Restore
+
+      Click **Start Restore**. If nothing happens, click **Start Restore** again.
+
+      If it fails, select the previous backup and click **Start Restore**.
+
+not_flagged:
+  ja: 太字か［］で囲んだ札だけを見ます。かぎ括弧の語、コードの中の語、字の違う札（［保存］と［上書き保存］）、最初の一字の大文字・小文字だけが違う強調（**Note** と **note**）、語の中の「の」（［その他］）は比べません。技術文書・手順書・ブログでだけ動きます。
+  en: "Only labels in bold or in ［］ are compared. Quoted words, code, labels with different words (**Save** and **Save As**), and emphasis differing only in its first letter's case (**Note** and **note**) are not. Technical documents, manuals and blogs only."

package/rules/unbalanced-bracket.yaml

@@ -9,8 +9,8 @@ name:
   en: Unbalanced bracket
 
 why:
-  ja: 閉じ忘れた「（」や、開きの無い「」」があると、読み手はどこまでが括弧の中なのか分からなくなります。全角の「（」を半角の「)」で閉じるのも、書き換えの途中で残った印です。見出しで区切った節ごとに、「」『』（）()［］[]【】〔〕〈〉《》“” の組を数えます。詩の連や長い引用は段落をまたぐので、段落を越えて組にします。行の頭や空白の後ろの「1)」「a)」「事例）」のような三文字までの番号の印と数の後ろの「）」、コードと URL は数えません。英語の小説のように、次の段落も同じ開きで始まるなら、閉じない開きは続きとして数えません。
-  en: A "(" never closed, or a ")" never opened, leaves the reader unsure where the aside ends. A full-width "（" closed by a half-width ")" is left over from an edit too. Brackets are paired within each section under a heading ((), [], “”, and the Japanese 「」『』（）［］【】〔〕〈〉《》), across paragraphs, since a stanza or a long quotation may span several. A short label of up to three characters such as "1)", "a)" or "iv)" at the start of a line or after a space, a ")" right after a number, code and URLs are not counted. An opening quotation mark carried into a paragraph that opens with the same mark, as in fiction, is not counted.
+  ja: 閉じ忘れた「（」や、開きの無い「」」があると、読み手はどこまでが括弧の中なのか分からなくなります。全角の「（」を半角の「)」で閉じるのも、書き換えの途中で残った印です。見出しで区切った節ごとに、「」『』（）()［］[]【】〔〕〈〉《》“” の組を数えます。詩の連や長い引用は段落をまたぐので、段落を越えて組にします。行の頭や空白の後ろの「1)」「a)」「事例）」のような三文字までの番号の印と数の後ろの「）」、括弧の中の番号の印（「（…以下、事例5）まで同じ。）」の「事例5）」。同じ字の印を行の頭でも使っていて、同じ行の後ろの閉じで括弧が閉じるときに限る）、コードと URL、引用の閉じのすぐ前の開き（法令の読替えの「取締役（」とあるのは）は数えません。英語の小説のように、次の段落も同じ開きで始まるなら、閉じない開きは続きとして数えません。
+  en: A "(" never closed, or a ")" never opened, leaves the reader unsure where the aside ends. A full-width "（" closed by a half-width ")" is left over from an edit too. Brackets are paired within each section under a heading ((), [], “”, and the Japanese 「」『』（）［］【】〔〕〈〉《》), across paragraphs, since a stanza or a long quotation may span several. A short label of up to three characters such as "1)", "a)" or "iv)" at the start of a line or after a space, a ")" right after a number, a numbered label inside an aside ("A3)" in "(see the notes; A3) and more)", when the same label is used at the start of a line and later closes on the same line still close the aside), code, URLs, and an opening bracket quoted as the last character of a quotation (「取締役（」, as statutes quote the text they amend) are not counted. An opening quotation mark carried into a paragraph that opens with the same mark, as in fiction, is not counted.
 
 message:
   ja: 「{mark}」が組になっていません
@@ -52,5 +52,5 @@ example:
       The plan (see below) is ready.
 
 not_flagged:
-  ja: 行の頭や空白の後ろの「1)」「a)」「事例）」のような三文字までの番号の印、数の後ろの「）」、コードと URL は数えません。段落をまたいで閉じる括弧と、次の段落を同じ引用符で始める台詞も指しません。
-  en: Labels of up to three characters such as "1)" or "a)" at the start of a line or after a space, a ")" right after a number, code and URLs are not counted. A bracket closed in a later paragraph, and a quotation carried into a paragraph that opens with the same mark, are not reported.
+  ja: 行の頭や空白の後ろの「1)」「a)」「事例）」のような三文字までの番号の印、数の後ろの「）」、行の頭でも使う番号の印を括弧の中に書いたもの（「以下、事例5）まで同じ。」）、コードと URL は数えません。段落をまたいで閉じる括弧と、次の段落を同じ引用符で始める台詞も指しません。
+  en: Labels of up to three characters such as "1)" or "a)" at the start of a line or after a space, a ")" right after a number, a numbered label also used at the start of a line, written inside an aside ("(see the notes; A3) and more)"), code and URLs are not counted. A bracket closed in a later paragraph, and a quotation carried into a paragraph that opens with the same mark, are not reported.

package/rules/uncomparable-graded.yaml

@@ -4,7 +4,7 @@ status: stable
 how_to_find: phrase-match
 word_list: uncomparable-graded
 requires: [pos]
-languages: [en]
+languages: [ja, en]
 severity: info
 
 name:
@@ -12,16 +12,16 @@ name:
   en: An uncomparable adjective given a degree
 
 why:
-  ja: 英語の「unique」「unanimous」「impossible」は、そうであるかないかの二つしかない状態を言います。「very unique」「more unanimous」と程度を付けても何も足されず、読み手は書き手が語の意味を確かめていないと受け取ります。語の一覧は言語ごとの語彙表にあります。
-  en: '"Unique", "unanimous" and "impossible" name a state that holds or does not. "Very unique" or "more unanimous" adds nothing, and tells the reader the writer did not weigh the word. The phrases are listed in the lexicon.'
+  ja: 「最適」「完璧」（英語の unique、unanimous、impossible）は、一番であるか・欠けが無いかを言う語で、程度がありません。「より最適な」「とても完璧」（very unique、more unanimous）と程度を付けても何も足されず、読み手は書き手が語の意味を確かめていないと受け取ります。語の一覧は言語ごとの語彙表にあります。
+  en: '"Unique", "unanimous" and "impossible" (最適, 完璧) name a state that holds or does not. "Very unique" or "more unanimous" (より最適な, とても完璧) adds nothing, and tells the reader the writer did not weigh the word. The phrases are listed in the lexicon.'
 
 message:
-  ja: 「{matched}」は、程度の無い形容詞に程度を付けています
+  ja: 「{matched}」は、程度の無い語に程度を付けています
   en: '"{matched}" grades an adjective that has no degrees'
 
 how_to_fix:
-  ja: 程度の語を外すか、本当に言いたい程度の言える語に替えてください（very unique → unique、または unusual）。
-  en: Drop the grade, or use a word that has degrees ("very unique" → "unique", or "unusual").
+  ja: 程度の語を外すか、本当に言いたい程度の言える語に替えてください（より最適な → 最適な、または より適した。very unique → unique、または unusual）。
+  en: Drop the grade, or use a word that has degrees ("very unique" → "unique", or "unusual"; より最適な → 最適な, or より適した).
 
 levels: { strict: 1, normal: 1, relaxed: 2 }
 
@@ -31,9 +31,14 @@ off_for:
 
 group: wording
 summary:
-  ja: 英語で、「very unique」「more unanimous」のように、程度の無い形容詞に付けた程度
-  en: A degree given to an adjective that has none, such as "very unique" or "more unanimous"
+  ja: 「より最適な」「とても完璧」（very unique、more unanimous）のように、程度の無い語に付けた程度
+  en: A degree given to an adjective that has none, such as "very unique" or "more unanimous" (より最適な, とても完璧)
 example:
+  ja:
+    before: |
+      より最適な案を選びました。
+    after: |
+      最適な案を選びました。
   en:
     before: |
       The design is very unique.
@@ -41,14 +46,28 @@ example:
       The design is unusual.
 
 not_flagged:
-  ja: 一覧にある組み合わせだけを見ます。「almost」「nearly」のように近さを言う語（almost unique、nearly impossible）は指しません。英語の文書だけで動き、文学のジャンルは対象にしません。
-  en: Only the pairs on chaff's list are checked. Words that say how close ("almost unique", "nearly impossible") are not reported. English documents only; literature is not checked.
+  ja: 一覧にある組み合わせだけを見ます。「ほぼ完璧」（almost unique、nearly impossible）のように近さを言う語は指しません。「最も最適」「一番ベスト」のように最上を重ねた形は redundant-expression が見ます。「より最適化する」は指しません。文学のジャンルは対象にしません。
+  en: Only the pairs on chaff's list are checked. Words that say how close ("almost unique", "nearly impossible", ほぼ完璧) are not reported. A superlative stacked on a superlative (最も最適) is redundant-expression's, and より最適化する (optimise further) is not reported. Literature is not checked.
 level_meaning:
   ja: 当てはまる言い回しが {limit} 箇所あれば指摘
   en: reported once there are {limit}
 sources: [proselint]
 rewrite:
   depth: light
+  ja:
+    direction: 程度の語（より、とても、非常に）を外してください。程度を言いたいのなら、程度のある語に替えます（より最適な → より適した）。文のほかの所は変えません。
+    pairs:
+      - before: より最適な案を選びました。
+        after: 最適な案を選びました。
+      - before: 仕上がりはとても完璧でした。
+        after: 仕上がりは完璧でした。
+      - before: 前の版より最善の方法です。
+        after: 前の版より良い方法です。
+    keep:
+      - 文の主張
+      - 文のほかの所
+    avoid:
+      - 別の程度の語（本当に最適）に替えるだけ
   en:
     direction: Drop the grade before the adjective, or swap the adjective for one that has degrees when a degree is meant. Change nothing else in the sentence.
     pairs:

package/rules/undefined-function-call.yaml

@@ -0,0 +1,77 @@
+id: undefined-function-call
+layer: L1
+status: stable
+how_to_find: undefined-call
+requires: [markdown]
+severity: warning
+
+name:
+  ja: ページに無い関数をコード例で呼んでいる
+  en: Example calls a function the page does not define
+
+why:
+  ja: "API リファレンスや README が「wrap」を説明しているのに、例が「wrapText(...)」を呼んでいると、読み手が例を写したとたんに「関数がありません」で止まります。関数の名前を変えたあとに例だけ古い名前のまま残ったときや、書き間違えたときに起きます。見出しの最初の語（## wrap）と import した名前を、このページが説明する関数として読み、コードブロックの中で、その名前を頭に持つより長い名前を呼んでいて、その名前がページのほかのどこにも無いときに指します。"
+  en: 'When an API reference or a README documents wrap and its example calls wrapText(...), the reader who copies the example stops at "not defined". It happens when a function is renamed and an example keeps the old name, or when the name is mistyped. The first word of a heading (## wrap) and the names an example imports are read as the functions the page documents. A call in a code block to a longer name that starts with one of them, written nowhere else on the page, is pointed out.'
+
+message:
+  ja: 「{name}」を呼んでいますが、このページが説明しているのは「{documented}」です
+  en: "`{name}` is called, but this page documents `{documented}`"
+
+how_to_fix:
+  ja: 例の関数の名前を、説明している関数の名前に直してください。別の関数なら、その関数をページで説明してください。
+  en: Call the function the page documents. If it is another function, document it on the page.
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [technical, docs, blog, legal, academic, literature, speech]
+off_for:
+  legal: "Code examples belong to technical writing."
+  academic: "Code examples belong to technical writing."
+  literature: "Code examples belong to technical writing."
+  speech: "Code examples belong to technical writing."
+
+group: facts
+summary:
+  ja: コード例が、ページで説明している関数と違う、どこにも無い名前の関数を呼んでいる所
+  en: An example calling a name the page never defines, close to one it documents
+example:
+  ja:
+    config: { genre: technical/readme }
+    before: |
+      ## wrap
+
+      文章を決まった幅で折り返します。
+
+      ```js
+      const lines = wrapText("折り返したい長い文です。", 10);
+      ```
+    after: |
+      ## wrap
+
+      文章を決まった幅で折り返します。
+
+      ```js
+      const lines = wrap("折り返したい長い文です。", 10);
+      ```
+  en:
+    config: { genre: technical/readme }
+    before: |
+      ## wrap
+
+      Wraps text to a given width.
+
+      ```js
+      const lines = wrapText("A long sentence to wrap.", 10);
+      ```
+    after: |
+      ## wrap
+
+      Wraps text to a given width.
+
+      ```js
+      const lines = wrap("A long sentence to wrap.", 10);
+      ```
+
+not_flagged:
+  ja: 宣言（function wrapText(）、コメントの中の呼び出し、プログラミング言語が用意する関数（parseInt、語彙表 code-global）、ページのほかの所にも出てくる名前（例の中で定義した関数、二度呼んだ関数、文で説明した関数）、メンバーの呼び出し（console.log(、obj.wrapText(）、説明している名前で始まらない名前、4 文字より短い名前を頭に持つものは見ません。
+  en: "A declaration (function wrapText(), a commented-out call, a function the programming language provides (parseInt, lexicon code-global), a name written anywhere else on the page (defined in the example, called twice, or named in the text), a member call (console.log(, obj.wrapText(), a name that does not start with a documented one, and documented names shorter than four characters are not checked."

package/rules/undefined-term.yaml

@@ -0,0 +1,72 @@
+id: undefined-term
+layer: L3
+status: stable
+how_to_find: undefined-term
+requires: [structure, pos]
+languages: [ja]
+severity: info
+
+name:
+  ja: 定義した語の形で書いたのに、どこにも定義が無い
+  en: A term written like a defined term but defined nowhere
+
+why:
+  ja: 契約や規約は、「本業務」「本サービス」のように、頭に「本」を付けた語を定義して使います。同じ形の「本成果物」を定義せずに書くと、読み手は、どこかで定義した語なのか、何を指すのかが分かりません。定義が抜けたのか、別の定義した語（本業務）を書き違えたのかのどちらかです。文書が「本」を付けた語を一つ以上定義しているときだけ、その形で書いたのに定義も言い換えの形（本件業務）も無い語を、最初の一か所だけ指します。
+  en: "A Japanese contract defines its terms with the prefix 本 (本業務, 本サービス). A term in the same form that is never defined (本成果物) leaves the reader asking whether it was defined somewhere and what it means: either a definition is missing, or another defined term was miswritten. Only a document that defines at least one term with that prefix is read, and only the first use of each such term with no definition and no other-prefix form (本件業務) is reported."
+
+message:
+  ja: 「{term}」は定義した語の形ですが、この文書のどこにも定義がありません
+  en: '"{term}" is written like a defined term, but the document defines it nowhere'
+
+how_to_fix:
+  ja: 定義した語の書き違いなら、定義した語に直してください（本成果物 → 本業務）。新しい語なら、最初に使う所で「（以下「本成果物」という。）」と定義します。
+  en: If it is a defined term miswritten, use the defined term. If it is a new term, define it where it is first used.
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [legal, docs, academic, literature, speech]
+off_for:
+  docs: "Defined terms are a contract's apparatus: the legal genres check them."
+  academic: "Defined terms are a contract's apparatus: the legal genres check them."
+  literature: "Defined terms are a contract's apparatus: the legal genres check them."
+  speech: "Defined terms are a contract's apparatus: the legal genres check them."
+  legal/statute: "A statute's guidelines and circulars refer to 本項 and their own measures without defining them."
+  legal/judgment: "A court decision names the matters of its case 本件建物, 本件請求 as it goes, without defining them."
+  legal/patent: "A patent names its parts 本装置 and 本発明 without defining them."
+
+group: consistency
+summary:
+  ja: 「本業務」のように定義した語と同じ形の「本成果物」を、定義しないまま使っている所
+  en: A Japanese term in the defined form (本成果物) that the document never defines
+example:
+  ja:
+    config: { genre: legal/contract }
+    before: |
+      # 業務委託契約書
+
+      第1条　甲は、ウェブサイトの保守の業務（以下「本業務」という。）を乙に委託する。
+
+      第2条　乙は、本成果物を甲に提出する。
+    after: |
+      # 業務委託契約書
+
+      第1条　甲は、ウェブサイトの保守の業務（以下「本業務」という。）を乙に委託する。
+
+      第2条　乙は、本業務の報告書を甲に提出する。
+
+not_flagged:
+  ja: 文書が「本」を付けた語を一つも定義していなければ見ません。定義した語とその言い換え（本件業務、defined-term-form が見ます）、定義した語で始まる語（本サービス上）、この文書やその一部を指す語（本条、本項、本書、本契約、本利用規約、本サイト）、どこかでかぎ括弧に入れた語（定義の書き方を chaff が読めなかったもの）、一語の言葉（本人、本日、本社）は見ません。同じ語は最初の一か所だけ指します。英語の文書は見ません（下の理由）。法令・判決・特許は見ません。契約書・規約のジャンルで見ます。
+  en: "A document that defines no term with the prefix is not read. Defined terms and their other-prefix forms (本件業務, which defined-term-form reads), terms that start with a defined term (本サービス上), the document's names for itself and its parts (本条, 本項, 本書, 本契約, 本利用規約, 本サイト), terms set in quotes anywhere (a definition chaff could not read), and single words (本人, 本日, 本社) are not reported. Each term is reported once, at its first use. English is not read: a capitalised word there cannot be told from the name of a law, an organisation or a policy (the Federal Trade Commission Act, Acceptable Use Policies) without its meaning. Statutes, court decisions and patents are not read; the contract genre runs this rule."
+rewrite:
+  depth: light
+  ja:
+    direction: 定義した語の書き違いなら定義した語に直し、新しい語なら最初に使う所で定義します。どちらか分からなければ書き手に確かめます。
+    pairs:
+      - before: 乙は、本成果物に関する資料を甲に提出する。
+        after: 乙は、本業務に関する資料を甲に提出する。
+      - before: 本規約は、ユーザーと当社との間の本アプリの利用に関わる一切の関係に適用されます。
+        after: 本規約は、ユーザーと当社との間の本サービスの利用に関わる一切の関係に適用されます。
+    keep:
+      - 条の番号と中身
+    avoid:
+      - 語の意味を推測して定義を書く

package/rules/unknown-word.yaml

@@ -47,8 +47,8 @@ example:
       The report is attached to this email.
 
 not_flagged:
-  ja: 大文字を含む語、四字より短い語、コード・URL・メールアドレスの中の語、文書で二度以上使う語、一字違いの辞書の語が無い語、chaff.yaml の names に並べた語、語彙表 known-misspelling が別に言う語は指しません。
-  en: Words with a capital letter, words shorter than four letters, words in code, URLs and email addresses, words used twice or more in the document, words with no dictionary word one letter away, words listed under names in chaff.yaml, and the misspellings known-misspelling reports are not reported.
+  ja: 大文字を含む語、四字より短い語、コード・URL・メールアドレスの中の語、強調や角括弧で頭の字を分けた語の残り（**G**lobally の lobally、[e]xpressions の xpressions）、文書で二度以上使う語、一字違いの辞書の語が無い語、chaff.yaml の names に並べた語、語彙表 known-misspelling が別に言う語は指しません。
+  en: Words with a capital letter, words shorter than four letters, words in code, URLs and email addresses, the rest of a word whose first letter is set apart by emphasis or brackets (lobally in **G**lobally, xpressions in [e]xpressions), words used twice or more in the document, words with no dictionary word one letter away, words listed under names in chaff.yaml, and the misspellings known-misspelling reports are not reported.
 rewrite:
   depth: light
   en:

package/rules/unqualified-superlative.yaml

@@ -46,8 +46,8 @@ example:
     after: Our new product processes orders a fifth faster than the previous model.
 
 not_flagged:
-  ja: 「当社比」「〜の中で」「〜のほうが」のように、比べる相手や範囲が同じ文にあれば指しません。「SES との最大の違い」のように、最上級のすぐ前に相手があるときも同じです。「国内最大」「業界最速」のように名詞がじかに付いた最上級と、「日本で最も」のように名前と「で」が前にある最上級は、範囲を言っているので指しません。「」や引用符で引いた言葉の中の最上級は、書き手の主張ではないので指しません。
-  en: A superlative with its comparison or scope in the same sentence ("in our range", "than last year", "the fastest in the industry") is not reported, nor is one inside quotation marks, which are someone else's words.
+  ja: 「当社比」「〜の中で」「〜のほうが」のように、比べる相手や範囲が同じ文にあれば指しません。「SES との最大の違い」のように、最上級のすぐ前に相手があるときも同じです。「国内最大」「業界最速」のように名詞がじかに付いた最上級と、「日本で最も」のように名前と「で」が前にある最上級は、範囲を言っているので指しません。「バグを検出できる唯一のルール」のように、動詞で終わる節が最上級のすぐ前にあって範囲を決めているときも同じです。「」や引用符で引いた言葉の中の最上級は、書き手の主張ではないので指しません。
+  en: A superlative with its comparison or scope in the same sentence ("in our range", "than last year", "the fastest in the industry") is not reported, nor is one limited by a clause ("the best we have measured"), nor one inside quotation marks, which are someone else's words.
 level_meaning:
   ja: 比べる相手のない最上級が {limit} 箇所あれば指摘
   en: reported once there are {limit} such claims

package/rules/use-before-definition.yaml

@@ -50,8 +50,8 @@ example:
       This agreement is between Harbour Ltd (the "Seller") and Hill Ltd (the "Buyer"). The Seller ships within five days.
 
 not_flagged:
-  ja: 定義の条（「X」とは…をいう）で定義した語は、前で使っても言いません。定義の条は文書の頭にも終わりにも置く書き方があるためです。最初の一か所だけを指します。
-  en: Terms defined in a definitions clause ("X" means ...) are not checked, since a definitions clause may come first or last. Only the first early use is pointed at.
+  ja: 定義の条（「X」とは…をいう）で定義した語は、前で使っても言いません。定義の条は文書の頭にも終わりにも置く書き方があるためです。見出しの行（章・節の行、条の前の「（買主の義務）」のような見出し）の語と、漢字で終わる語にさらに漢字が続く長い語（「監査委員会」の「監査委員」）は、使った所に数えません。最初の一か所だけを指します。
+  en: Terms defined in a definitions clause ("X" means ...) are not checked, since a definitions clause may come first or last. A heading line (a chapter or section line, or the caption above an article) does not count as a use, nor does a longer word that runs on in kanji past a term ending in kanji. Only the first early use is pointed at.
 rewrite:
   depth: structure
   ja:

package/rules/version-mismatch.yaml

@@ -10,13 +10,21 @@ name:
   en: The version in the text is not the one in the code
 
 why:
-  ja: 「2.3.0 を入れます」のすぐ下のコマンドが「tidyq@2.4.0」だと、読み手はどちらを入れればよいか分かりません。新しい版を出したときに、コード例か説明の片方だけを直すと起きます。コードブロックのすぐ上の段落に書いた版（2.3.0 のように点で三つに区切った番号）を、そのコードブロックにある版と比べます。コードに版がちょうど一つあり、段落の版がそれと違うとき指します。
-  en: 'When "Install version 2.3.0" sits right above a command that installs tidyq@2.4.0, the reader cannot tell which to install. It happens when a release updates the example or the text but not both. chaff compares a version written in the paragraph right above a code block (a number in three dotted parts, such as 2.3.0) with the version the block shows. It reports when the block shows exactly one version and the paragraph names another.'
+  ja: 「2.3.0 を入れます」のすぐ下のコマンドが「tidyq@2.4.0」だと、読み手はどちらを入れればよいか分かりません。新しい版を出したときに、コード例か説明の片方だけを直すと起きます。コードブロックのすぐ上の段落に書いた版（2.3.0 のように点で三つに区切った番号）を、そのコードブロックにある版と比べます。コードに版がちょうど一つあり、段落の版がそれと違うとき指します。コードが redis:7.4 のように名前と版で固定したソフトを、段落が「Redis 7.2」のように名前のすぐ後の版で書いたときは、7.4 のような二つに区切った番号も比べます。7.4 と 7.4.1 のように一方が他方の系列なら同じと見ます。また、変更履歴のように版の見出し（または版で始まる箇条書き）が並ぶ文書では、「npm install wrapkit@3.1.0」のように自分のパッケージ（題名か冒頭の段落が名指すもの）をちょうど一つの版に固定して入れるコマンドを、その版の項の中ならその版と、外なら一覧で最新の版と比べます。
+  en: 'When "Install version 2.3.0" sits right above a command that installs tidyq@2.4.0, the reader cannot tell which to install. It happens when a release updates the example or the text but not both. chaff compares a version written in the paragraph right above a code block (a number in three dotted parts, such as 2.3.0) with the version the block shows. It reports when the block shows exactly one version and the paragraph names another. When the block pins a program by name (redis:7.4) and the paragraph writes a version right after that name (Redis 7.2), versions of two parts are compared too; 7.4 and 7.4.1 are the same series. In a document that lists its releases (version headings, as in a changelog, or list items that start with a version), a command that installs the document''s own package (the one its title or opening paragraph names) pinned to one version, such as npm install wrapkit@3.1.0, is compared with the release whose section it is in, or else with the newest release listed.'
 
 message:
   ja: 「{written}」と書いていますが、すぐ下のコードは {code} です
   en: '"{written}" is written, but the code below has {code}'
 
+messages:
+  newest:
+    ja: "{pinned} を入れるコマンドですが、この文書のリリースの一覧で最新の版は {release} です"
+    en: "This command installs {pinned}, but the newest release this document lists is {release}"
+  section:
+    ja: "{pinned} を入れるコマンドですが、{release} のリリースの項に書いています"
+    en: "This command installs {pinned}, but it is written under the release {release}"
+
 how_to_fix:
   ja: 説明とコードのどちらが今の版かを確かめて、もう一方を直してください。
   en: Check which of the text and the code has the current version, and correct the other.
@@ -73,5 +81,5 @@ example:
       ```
 
 not_flagged:
-  ja: 版の無いコードブロック、版が二つ以上あるコードブロック（「2.3.0 から 2.4.0 へ」の更新）、範囲の端や起点として書いた版（「2.3.0 から」「20.0.0 以上」）、別のプログラムの名前のすぐ後ろの版（「Node.js 18.17.0 が必要」）、見出しや箇条書きや表の版、版だけの行、二つに区切った番号（22.04、3.1）と先頭が四桁の番号（2024.01.15）は比べません。
-  en: 'A code block with no version or with two or more (an upgrade from one to the other), a version written as a bound or a starting point ("from 2.3.0", "20.0.0 or later"), a version right after the name of another program ("Requires Node.js 18.17.0"), a version in a heading, a list item, a table or a line of its own, and numbers in two parts (22.04, 3.1) or with a four-digit first part (2024.01.15) are not compared.'
+  ja: 版の無いコードブロック、版が二つ以上あるコードブロック（「2.3.0 から 2.4.0 へ」の更新）、範囲の端や起点として書いた版（「2.3.0 から」「20.0.0 以上」）、別のプログラムの名前のすぐ後ろの版（「Node.js 18.17.0 が必要」）、見出しや箇条書きや表の版、版だけの行、ブロックが名前で固定したソフトの名前のすぐ後ろ以外の、二つに区切った番号（22.04、3.1）と、先頭が四桁の番号（2024.01.15）は比べません。インストールのコマンドでは、題名や冒頭の段落が名指さない別のパッケージ（依存するもの）、範囲（^3.0.0、>=3.0.0）、latest のようなタグ、プレリリース（4.0.0-beta.1）の版と、リリースの一覧が無い文書は比べません。一覧の最新はプレリリースを除いて版の順で選びます。
+  en: 'A code block with no version or with two or more (an upgrade from one to the other), a version written as a bound or a starting point ("from 2.3.0", "20.0.0 or later"), a version right after the name of another program ("Requires Node.js 18.17.0"), a version in a heading, a list item, a table or a line of its own, numbers in two parts (22.04, 3.1) other than right after the name of a program the block pins, and numbers with a four-digit first part (2024.01.15) are not compared. Of install commands, a package the title or the opening paragraph does not name (a dependency), a range (^3.0.0, >=3.0.0), a tag such as latest, a prerelease (4.0.0-beta.1), and a document that lists no releases are not compared; the newest release is chosen by version order, prereleases left out.'