chaffjs 0.20.0 → 0.21.0

package/rules/email-greeting-closing.yaml

@@ -0,0 +1,122 @@
+id: email-greeting-closing
+layer: L2
+status: stable
+how_to_find: email-frame
+severity: info
+
+name:
+  ja: メールの挨拶か結びが無い
+  en: Email without a greeting or a closing
+
+why:
+  ja: 仕事のメールは、挨拶で始まり結びで終わるのが読み手の期待です。挨拶が無いと用件だけを突きつけられたように読め、結びが無いと途中で切れたように見えます。下書きを貼り付けたときや、前のメールから本文だけを写したときに抜けます。本文の最初の数行に挨拶（お世話になっております、拝啓、Dear）が無いか、最後の数行（名前や連絡先の行を含む）に結び（よろしくお願いいたします、敬具、Best regards）が無いとき指します。語は語彙表から読みます。
+  en: 'A work email is expected to open with a greeting and end with a closing. Without the greeting it reads as a bare demand; without the closing it looks cut off. Both go missing when a draft is pasted in or the body is copied from an earlier email. chaff points out a body whose first lines hold no greeting ("Dear", "Hi", "Hello") or whose last lines, the name and contact lines included, hold no closing ("Best regards", "Sincerely", "Thanks"). The words come from a lexicon.'
+
+message:
+  ja: メールの挨拶か結びがありません
+  en: The email has no greeting or no closing
+
+messages:
+  greeting:
+    ja: 書き出しに挨拶がありません
+    en: The email does not open with a greeting
+  closing:
+    ja: 終わりに結びの言葉がありません
+    en: The email does not end with a closing
+
+how_to_fix:
+  ja: 書き出しに「いつもお世話になっております。」のような挨拶を、終わりに「よろしくお願いいたします。」のような結びを足してください。
+  en: Open with a greeting such as "Dear Ms Lee," and end with a closing such as "Best regards," before your name.
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [business/email, legal, docs, academic, literature, speech]
+off_for:
+  legal: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  docs: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  academic: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  literature: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  speech: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+
+group: structure
+summary:
+  ja: 仕事のメールで、書き出しの挨拶か終わりの結びが無いもの
+  en: A work email that opens without a greeting or ends without a closing
+example:
+  ja:
+    config: { genre: business/email }
+    before: |
+      件名: 打ち合わせの日程
+
+      打ち合わせの日程をお知らせします。10月13日の14時からです。
+
+      よろしくお願いいたします。
+    after: |
+      件名: 打ち合わせの日程
+
+      いつもお世話になっております。打ち合わせの日程をお知らせします。10月13日の14時からです。
+
+      よろしくお願いいたします。
+  en:
+    config: { genre: business/email }
+    before: |
+      Subject: Meeting date
+
+      The meeting is on 13 October at 14:00.
+
+      Best regards,
+      Ichiro
+    after: |
+      Subject: Meeting date
+
+      Dear facilities team,
+
+      The meeting is on 13 October at 14:00.
+
+      Best regards,
+      Ichiro
+not_flagged:
+  ja: 引用した返信（「>」の行）と、ヘッダーと署名（「-- 」の後ろ）は見ません。挨拶と結びの言い方は決めず、語彙表のどれかがあれば足ります。メール・手紙のジャンルでだけ見ます。
+  en: 'Quoted replies (lines starting with ">"), the header and the signature after "-- " are not read. Which greeting or closing is used is not decided; any word in the lexicon will do. Only the email and letter genre runs this rule.'
+rewrite:
+  depth: light
+  ja:
+    direction: 足りないほうだけを足してください。挨拶は本文の最初に一文、結びは名前の前に一文です。相手との関係が分からなければ「お世話になっております」「よろしくお願いいたします」を使います。用件の文は変えません。
+    pairs:
+      - before: 打ち合わせの日程をお知らせします。
+        after: いつもお世話になっております。打ち合わせの日程をお知らせします。
+      - before: |
+          ご都合をお知らせください。
+          佐藤
+        after: |
+          ご都合をお知らせください。
+          よろしくお願いいたします。
+          佐藤
+    keep:
+      - 用件の文
+      - 署名の名前と連絡先
+    avoid:
+      - 本文に無い用件や約束を足す
+      - 挨拶を何文も重ねる
+  en:
+    direction: Add only what is missing. The greeting is one line before the body, the closing one line before the name. If the relationship is unclear, use "Dear [name]," and "Best regards,". Leave the body as it is.
+    pairs:
+      - before: The meeting is on 13 October at 14:00.
+        after: |
+          Dear facilities team,
+
+          The meeting is on 13 October at 14:00.
+      - before: |
+          Let me know which time suits you.
+          Ichiro
+        after: |
+          Let me know which time suits you.
+
+          Best regards,
+          Ichiro
+    keep:
+      - the body's sentences
+      - the name and contact lines
+    avoid:
+      - adding a request or a promise the body does not make
+      - piling up several greetings

package/rules/email-subject-length.yaml

@@ -0,0 +1,112 @@
+id: email-subject-length
+layer: L2
+status: stable
+how_to_find: email-subject
+severity: warning
+
+name:
+  ja: 件名が空か長すぎる
+  en: Subject line empty or too long
+
+why:
+  ja: 受け手は件名を見て、開くか、いつ読むかを決めます。空の件名は用件が分からず、迷惑メールにも見えます。長い件名は一覧で途中から切れ、肝心の語が見えません。「件名：」「Subject:」の行があるメールだけを見て、その値の字数を数えます。返信や転送でメールソフトが足す「Re:」「Fwd:」は数えません。
+  en: 'Recipients decide from the subject whether to open a message and when. An empty subject says nothing and looks like spam; a long one is cut off in the inbox list before its key words. Only an email with a "Subject:" line is checked, and its value is counted in characters. The "Re:" and "Fwd:" a mail program adds are not counted.'
+
+message:
+  ja: 件名が {count} 字あります（{limit} 字まで）
+  en: The subject has {count} characters (up to {limit})
+
+messages:
+  empty:
+    ja: 件名が空です
+    en: The subject line is empty
+
+how_to_fix:
+  ja: 件名には、用件と、日付や案件名のような見分けの語だけを書いてください。説明は本文に移します。
+  en: Put only the request and a distinguishing word (a date, a project) in the subject, and move the explanation into the body.
+
+levels:
+  ja: { strict: 20, normal: 30, relaxed: 40 }
+  en: { strict: 50, normal: 70, relaxed: 90 }
+
+use_for: [business/email, legal, docs, academic, literature, speech]
+off_for:
+  legal: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  docs: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  academic: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  literature: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+  speech: "An email's greeting, closing, subject and attachments: only the email and letter genre turns these on."
+
+group: structure
+summary:
+  ja: 「件名：」の行がある仕事のメールで、件名が空か、字数の上限を超えるもの
+  en: A work email whose "Subject:" line is empty or longer than the limit
+example:
+  ja:
+    config: { genre: business/email }
+    before: |
+      件名: 来週の火曜日に予定している会議室の予約サービスの導入に向けた打ち合わせの日程について
+
+      いつもお世話になっております。打ち合わせの日程をお知らせします。
+
+      よろしくお願いいたします。
+    after: |
+      件名: 打ち合わせの日程（10月13日）
+
+      いつもお世話になっております。打ち合わせの日程をお知らせします。
+
+      よろしくお願いいたします。
+  en:
+    config: { genre: business/email }
+    before: |
+      Subject: Following up on our conversation last week about the meeting room booking service and a visit
+
+      Dear facilities team,
+
+      I would like to visit your office.
+
+      Best regards,
+      Ichiro
+    after: |
+      Subject: Visit for the room booking service
+
+      Dear facilities team,
+
+      I would like to visit your office.
+
+      Best regards,
+      Ichiro
+not_flagged:
+  ja: 「件名：」の行が無いメールや手紙、引用した返信の中の件名は見ません。メール・手紙のジャンルでだけ見ます。
+  en: 'An email or letter without a "Subject:" line, and subjects inside a quoted reply, are not checked. Only the email and letter genre runs this rule.'
+level_meaning:
+  ja: 件名 {limit} 字まで
+  en: up to {limit} characters in the subject
+rewrite:
+  depth: light
+  ja:
+    direction: 件名を、用件と見分けの語（日付・案件名・期限）だけに縮めてください。経緯や理由は本文に移します。空の件名には、本文の用件を短く書きます。
+    pairs:
+      - before: 来週の火曜日に予定している会議室の予約サービスの導入に向けた打ち合わせの日程について
+        after: 打ち合わせの日程（10月13日）
+      - before: 先日お送りいただいた見積書の内容についての確認とご相談
+        after: 見積書の確認（10月分）
+    keep:
+      - 用件
+      - 日付・案件名・期限
+    avoid:
+      - 本文に無い用件を件名に書く
+      - 「至急」「重要」を足す
+  en:
+    direction: Cut the subject to the request and a distinguishing word (a date, a project, a deadline). Move the background into the body. For an empty subject, state the body's request briefly.
+    pairs:
+      - before: Following up on our conversation last week about the meeting room booking service and a visit
+        after: Visit for the room booking service
+      - before: Some questions about the quote you sent us and a few things we would like to discuss
+        after: Questions on the October quote
+    keep:
+      - the request
+      - dates, project names and deadlines
+    avoid:
+      - stating a request the body does not make
+      - adding "Urgent" or "Important"

package/rules/emoji-density.yaml

@@ -1,6 +1,6 @@
 id: emoji-density
 layer: L1
-status: experimental
+status: stable
 how_to_find: emoji-density
 severity: info
 
@@ -24,6 +24,8 @@ how_to_fix:
 levels: { strict: 3, normal: 8, relaxed: 20 }
 
 use_for: [blog, business, technical, 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."
 sources: [zhang-2024]
 
 group: readability

package/rules/emoji-heading.yaml

@@ -1,6 +1,6 @@
 id: emoji-heading
 layer: L1
-status: experimental
+status: stable
 how_to_find: emoji-heading
 requires: [markdown]
 severity: info
@@ -25,6 +25,11 @@ how_to_fix:
 levels: { strict: 2, normal: 3, relaxed: 5 }
 
 use_for: [blog, business, legal, docs, academic, literature, speech]
+off_for:
+  legal: "Legal drafting repeats its terms and its sentence heads on purpose, puts the actor in the passive (shall be deemed), and joins long noun compounds (個人情報取扱事業者). This rule would only flag the form."
+  docs: "A help page repeats its heading in its first line (To upload a file, ...) and states no claims to back up."
+  academic: "Science writes in the passive, hedges its claims on purpose (may, suggest) and cites numbers as its evidence."
+  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."
 sources: [zhang-2024]
 
 group: ai-tells
@@ -100,6 +105,7 @@ level_meaning:
   ja: 絵文字の付いた見出しが {limit} 個あれば指摘
   en: reported once {limit} headings carry an emoji
 rewrite:
+  depth: light
   ja:
     direction: 見出しから絵文字を外し、節の中身が分かる言葉にしてください。絵文字が言っていたこと（注意、完了）が要るなら、本文の最初の文で言います。
     pairs:

package/rules/empty-intensifier.yaml

@@ -28,6 +28,9 @@ levels:
   relaxed: 3
 
 use_for: [blog, business, technical, 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."
+  speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
 
 group: wording
 summary:
@@ -48,6 +51,7 @@ level_meaning:
   ja: 当てはまる言い回しが {limit} 箇所あれば指摘
   en: reported once there are {limit}
 rewrite:
+  depth: light
   ja:
     direction: 強める語（「非常に」「言うまでもなく」）を消し、何がどう大事なのかが本文にあれば、それを主語と述語で書いてください。無ければ書き手に聞きます。
     pairs:

package/rules/empty-list-item.yaml

@@ -1,6 +1,6 @@
 id: empty-list-item
 layer: L1
-status: experimental
+status: stable
 how_to_find: empty-list-item
 requires: [markdown]
 severity: warning
@@ -57,6 +57,7 @@ not_flagged:
   ja: 見出しの語だけの項目は、同じ箇条書きのほかの項目に「見出し：値」の形が一つも無ければ指しません（記入用の書式）。下に入れ子の箇条書きや段落が続く項目（「手順：」の下に手順を並べたもの）も指しません。Markdown の箇条書きでだけ動きます。
   en: 'A label-only item is not reported when no other item in its list has a "label: value" form (a blank form to fill in). An item followed by a nested list or paragraph (a lead-in) is not reported. Markdown lists only.'
 rewrite:
+  depth: light
   ja:
     direction: 空の項目に入るものを本文から探して書いてください。本文に無ければ作らず、「未定」と書いて書き手に聞きます。中身の無い記号だけの項目は消します。
     pairs:

package/rules/empty-section.yaml

@@ -1,6 +1,6 @@
 id: empty-section
 layer: L1
-status: experimental
+status: stable
 how_to_find: empty-section
 requires: [markdown]
 severity: warning

package/rules/empty-table-cell.yaml

@@ -1,6 +1,6 @@
 id: empty-table-cell
 layer: L1
-status: experimental
+status: stable
 how_to_find: empty-table-cell
 requires: [markdown]
 severity: warning
@@ -61,6 +61,7 @@ not_flagged:
   ja: 一番左の列は見ません（空欄で「上と同じ」を表す書き方があるため）。同じ列に空欄が二つ以上ある列、本文の行が三つより少ない表、「—」「なし」と書いたセルは指しません。Markdown の表でだけ動きます。
   en: The first column is not checked, since a blank there often means "same as above". A column with two or more blanks, a table with fewer than three body rows, and a cell holding "—" or "none" are not reported. Markdown tables only.
 rewrite:
+  depth: light
   ja:
     direction: 空欄に入るものを本文から探して書いてください。本文に無ければ作らず、「未定」と書いて、決める人か時期を書き手に聞きます。
     pairs:

package/rules/excessive-hedging.yaml

@@ -1,6 +1,6 @@
 id: excessive-hedging
 layer: L2
-status: experimental
+status: stable
 how_to_find: hedging
 word_list: excessive-hedging
 # 1 つの文の重なりを数えるときの、それだけでは逃げていない包む言い方（「という状況です」、may）と、
@@ -35,6 +35,11 @@ how_to_fix:
 levels: { strict: 3, normal: 6, relaxed: 12 }
 
 use_for: [business, blog, technical, legal, docs, academic, literature, speech]
+off_for:
+  legal: "Legal drafting repeats its terms and its sentence heads on purpose, puts the actor in the passive (shall be deemed), and joins long noun compounds (個人情報取扱事業者). This rule would only flag the form."
+  academic: "Science writes in the passive, hedges its claims on purpose (may, suggest) and cites numbers as its evidence."
+  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."
+  speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
 sources: [femmer-2017]
 
 group: wording
@@ -56,6 +61,7 @@ level_meaning:
   ja: 1000 字あたり逃げの表現 {limit} 個まで（一文に重ねた逃げは、文書の長さによらず指摘）
   en: up to {limit} hedges per 1000 words (hedges stacked in one sentence are reported whatever the length)
 rewrite:
+  depth: light
   ja:
     direction: 重ねた逃げは一つだけ残すか、確かめたことなら全部外して言い切ってください。言い切れないなら、何が分かれば言い切れるかを書きます。
     pairs:

package/rules/exclamation-width-consistency.yaml

@@ -0,0 +1,64 @@
+id: exclamation-width-consistency
+layer: L1
+status: stable
+how_to_find: mark-consistency
+word_list: exclamation-width
+languages: [ja]
+severity: info
+
+name:
+  ja: ！？ の全角と半角の混在
+  en: Full-width and half-width ! and ? mixed
+
+why:
+  ja: 日本語の文の中で、感嘆符と疑問符を全角（！？）と半角（!?）で混ぜて書くと、別々の所から貼り合わせた文書に見えます。どちらが正しいかは決めません。日本語の字に接するものだけを、感嘆符と疑問符それぞれで数え、少ないほうを指します。
+  en: In a Japanese document, ! and ? written both full-width (！？) and half-width (!?) make it look pasted together. chaff does not pick a side; it counts only marks touching Japanese text, each kind apart, and points at the less common way.
+
+message:
+  ja: 「{mark}」と書いています（この文書はふつう「{usual}」。{of} 箇所のうち {count} 箇所が違う）
+  en: '"{mark}" here, where the document usually writes "{usual}" ({count} of {of})'
+
+# 少ないほうが 5 箇所以上で、全体の 2 割を超えるとき。書き損じではなく書き方が二通りあるので、1 件にまとめて両方の数を言う。
+messages:
+  mixed:
+    ja: "「{mark}」の仲間を、全角で {spaced} 箇所、半角で {touching} 箇所書いています。この文書には書き方が二通りあります"
+    en: '"{mark}" is written two ways in this document ({spaced} full-width, {touching} half-width)'
+
+how_to_fix:
+  ja: 文書の多いほうの書き方に合わせてください。
+  en: Match the way the rest of the document writes it.
+
+levels: { strict: 1, normal: 1, relaxed: 3 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: consistency
+summary:
+  ja: 日本語の文の中で、！？ の全角と半角（!?）が混ざっている所
+  en: Full-width ！？ and half-width !? mixed in one Japanese document
+example:
+  ja:
+    before: |
+      本当ですか？ 来週ですか？ 今日ですか?
+    after: |
+      本当ですか？ 来週ですか？ 今日ですか？
+
+not_flagged:
+  ja: 日本語の字に接するものだけを数えます。URL やコードの中の「?」、英語の文の中のものは数えません。
+  en: Only marks touching Japanese text. A ? in a URL, in code or in English text is not counted.
+level_meaning:
+  ja: 少ないほうの書き方が {limit} 箇所あれば指摘
+  en: reported once the less common way appears {limit} times
+rewrite:
+  depth: light
+  ja:
+    direction: 指された感嘆符・疑問符だけを、文書の多いほうの書き方（全角か半角）に替えてください。
+    pairs:
+      - before: 今日ですか?
+        after: 今日ですか？
+      - before: 完成しました!
+        after: 完成しました！
+    keep:
+      - 文の言葉
+    avoid:
+      - 感嘆符を増やしたり減らしたりする

package/rules/expletive-construction.yaml

@@ -1,6 +1,6 @@
 id: expletive-construction
 layer: L3
-status: experimental
+status: stable
 how_to_find: expletive
 requires: [pos]
 languages: [en]
@@ -25,6 +25,12 @@ how_to_fix:
 levels: { strict: 1, normal: 3, relaxed: 6 }
 
 use_for: [blog, business, legal, docs, academic, literature, speech]
+off_for:
+  legal: "Legal drafting repeats its terms and its sentence heads on purpose, puts the actor in the passive (shall be deemed), and joins long noun compounds (個人情報取扱事業者). This rule would only flag the form."
+  docs: "A help page repeats its heading in its first line (To upload a file, ...) and states no claims to back up."
+  academic: "Science writes in the passive, hedges its claims on purpose (may, suggest) and cites numbers as its evidence."
+  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."
+  speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
 
 group: readability
 summary:

package/rules/fact-conflict.yaml

@@ -1,6 +1,6 @@
 id: fact-conflict
 layer: L3
-status: experimental
+status: stable
 how_to_find: fact-conflict
 requires: [quantities]
 uses: [pos]
@@ -25,6 +25,8 @@ how_to_fix:
 levels: { 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:
@@ -58,6 +60,7 @@ not_flagged:
   ja: 違う見出しの下、違う親の項目の下、太字だけの行や「第2回：」のような行の後ろの値は、別のものの値として比べません。値の後ろに条件が続くもの（「3,000円から」「10月5日に開催」）、読点のあとから始まる項目名（「大人は、参加費は」）、単位の違う値（単位の食い違いは別に見ます）も比べません。同じ項目に三通り以上の値があれば、一覧として何も言いません。
   en: Values under different headings, under different parent list items, or after a bold-only line or a line like "Session 2:" are taken as values of different things. A value followed by a condition ("$300 per person", "May 3 at noon"), a name that starts after a comma ("For adults, the fee"), and values in different units are not compared. An item with three or more different values is read as a list and left alone.
 rewrite:
+  depth: light
   ja:
     direction: 二つの値のどちらが正しいかを書き手に確かめ、もう一方を同じ値に直してください。どちらが正しいか文書から決まらないときは、推測で選ばずに書き手に聞いてください。
     pairs:

package/rules/figure-reference-order.yaml

@@ -1,6 +1,6 @@
 id: figure-reference-order
 layer: L3
-status: experimental
+status: stable
 how_to_find: figure-order
 severity: info
 
@@ -34,6 +34,11 @@ how_to_fix:
 levels: { strict: warning, normal: info, relaxed: info }
 
 use_for: [academic, legal, docs, literature, speech]
+off_for:
+  legal: "A paper's citations, figures and abstract: only the academic paper genre turns these on."
+  docs: "A paper's citations, figures and abstract: only the academic paper genre turns these on."
+  literature: "A paper's citations, figures and abstract: only the academic paper genre turns these on."
+  speech: "A paper's citations, figures and abstract: only the academic paper genre turns these on."
 
 group: structure
 summary:
@@ -81,6 +86,7 @@ not_flagged:
   ja: キャプション（行の頭の「図1　…」）を一つも書いていない種類の図、他の文書の図（「報告書の図5」）、リンクの字、番号が字や漢数字のもの（付録A、別表第一）は見ません。付録・別表・様式は文書の終わりに置くものなので、参照の順だけを見て、置き場所と参照の有無は見ません。見出しの無い文書では、節を越えたかどうかは見ません。論文のジャンルでだけ見ます。
   en: 'A kind of figure the document never captions (a "Figure 1: …" line), figures of another document ("Figure 5 of the report"), link text, and numbers that are letters or numerals in words (Appendix A) are left alone. Appendices and annexes sit at the end, so only the order of their references is checked, not where they are or whether they are referred to. A document without headings is not checked for references past the section. Only the academic paper genre runs this rule.'
 rewrite:
+  depth: structure
   ja:
     direction: 初めて参照する順に番号が増えるよう、参照の順を入れ替えるか、図と表の番号を振り直してください。振り直すなら、キャプションとほかの参照も同じく直します。参照しない図には、本文に参照の文を足します。
     pairs:

package/rules/fullwidth-alnum-consistency.yaml

@@ -1,9 +1,9 @@
 id: fullwidth-alnum-consistency
 layer: L3
-status: experimental
+status: stable
 how_to_find: fullwidth-alnum
 languages: [ja]
-severity: warning
+severity: info
 
 name:
   ja: 英数字の全角と半角が混ざっている

package/rules/hankaku-kana.yaml

@@ -1,6 +1,6 @@
 id: hankaku-kana
 layer: L1
-status: experimental
+status: stable
 how_to_find: hankaku-kana
 languages: [ja]
 severity: warning

package/rules/heading-command-missing.yaml

@@ -0,0 +1,109 @@
+id: heading-command-missing
+layer: L1
+status: stable
+how_to_find: heading-command
+requires: [markdown]
+severity: info
+
+name:
+  ja: 見出しのコマンドやオプションが、その節のコードに無い
+  en: A heading names a command its section's code does not show
+
+why:
+  ja: 「## `--dry-run`」の節のコード例が「--dryrun」を使っていると、読み手はどちらが正しいか分かりません。コマンドやオプションの名前を変えたときに、見出しかコード例の片方だけを直すと起きます。見出しのコードの部分（`npm install`、`--force`、`init`）が、その節（次の同じ深さか浅い見出しまで）のコードブロックにもコードの部分にも無いとき指します。節にコードが一つも無ければ見ません。
+  en: 'When the section "## `--dry-run`" shows an example using "--dryrun", the reader cannot tell which is right. It happens when a command or an option is renamed and only the heading or only the example is updated. chaff points out a heading''s code part (`npm install`, `--force`, `init`) that appears in none of the code blocks or code spans of its section (up to the next heading of the same or a higher level). A section with no code at all is not checked.'
+
+message:
+  ja: 見出しの「{command}」が、この節のコードにありません
+  en: '"{command}" in this heading does not appear in the section''s code'
+
+how_to_fix:
+  ja: 見出しとコード例のどちらが今の名前かを確かめて、もう一方を直してください。
+  en: Check which of the heading and the example has the current name, and correct the other.
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [technical, docs, blog, legal, academic, literature, speech]
+off_for:
+  legal: "Code blocks, shell prompts, command headings and numbered steps belong to technical writing."
+  academic: "Code blocks, shell prompts, command headings and numbered steps belong to technical writing."
+  literature: "Code blocks, shell prompts, command headings and numbered steps belong to technical writing."
+  speech: "Code blocks, shell prompts, command headings and numbered steps belong to technical writing."
+
+group: facts
+summary:
+  ja: 見出しが名指すコマンドやオプションが、その節のコード例のどこにも無い所
+  en: A command or option named in a heading that the section's examples never use
+example:
+  ja:
+    config: { genre: docs/manual }
+    before: |
+      # 使い方
+
+      ## `--dry-run`
+
+      直さずに、直す所だけを見せます。
+
+      ```bash
+      npx chaffjs fix --dryrun README.md
+      ```
+    after: |
+      # 使い方
+
+      ## `--dry-run`
+
+      直さずに、直す所だけを見せます。
+
+      ```bash
+      npx chaffjs fix --dry-run README.md
+      ```
+  en:
+    config: { genre: docs/manual }
+    before: |
+      # Usage
+
+      ## `--dry-run`
+
+      Show what would change without changing it.
+
+      ```bash
+      npx chaffjs fix --dryrun README.md
+      ```
+    after: |
+      # Usage
+
+      ## `--dry-run`
+
+      Show what would change without changing it.
+
+      ```bash
+      npx chaffjs fix --dry-run README.md
+      ```
+
+not_flagged:
+  ja: コードの無い節、ファイル名や関数名（`config.yaml`、`useEffect`）を書いた見出し、コードの部分の無い見出しは見ません。`--force` は `--force-with-lease` の中にあっても、あったとは数えません。
+  en: "Sections with no code, headings naming a file or a function (`config.yaml`, `useEffect`), and headings with no code part are not checked. `--force` inside `--force-with-lease` does not count as shown."
+rewrite:
+  depth: light
+  ja:
+    direction: 見出しとコード例のどちらが今のコマンドやオプションの名前かを書き手に確かめ、もう一方を直してください。分からなければ推測で書き換えず、確かめるよう伝えます。
+    pairs:
+      - before: npx chaffjs fix --dryrun README.md
+        after: npx chaffjs fix --dry-run README.md
+      - before: "## `chaff lint`"
+        after: "## `chaff check`"
+    keep:
+      - 節の説明の文
+    avoid:
+      - どちらの名前が正しいかを推測で決める
+  en:
+    direction: Ask the writer which of the heading and the example has the current name of the command or option, and correct the other. If it is not clear, do not guess; ask.
+    pairs:
+      - before: npx chaffjs fix --dryrun README.md
+        after: npx chaffjs fix --dry-run README.md
+      - before: "## `chaff lint`"
+        after: "## `chaff check`"
+    keep:
+      - the section's explanation
+    avoid:
+      - guessing which name is right

package/rules/heading-echo.yaml

@@ -3,7 +3,7 @@ layer: L1
 status: stable
 how_to_find: heading-echo
 uses: [pos]
-severity: warning
+severity: info
 
 name:
   ja: 見出しの繰り返し
@@ -29,6 +29,11 @@ levels:
   relaxed: 75
 
 use_for: [blog, business, technical, legal, docs, academic, literature, speech]
+off_for:
+  legal: "Legal drafting repeats its terms and its sentence heads on purpose, puts the actor in the passive (shall be deemed), and joins long noun compounds (個人情報取扱事業者). This rule would only flag the form."
+  docs: "A help page repeats its heading in its first line (To upload a file, ...) and states no claims to back up."
+  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."
+  speech/transcript: "A transcript records what was said: its sentences, repeats and register are the speaker's, not the writer's to fix."
 
 group: readability
 summary: