chaffjs 0.20.0 → 0.22.0

package/rules/bare-url-mix.yaml

@@ -0,0 +1,86 @@
+id: bare-url-mix
+layer: L3
+status: stable
+how_to_find: bare-url-mix
+requires: [markdown]
+severity: info
+
+name:
+  ja: 言葉のリンクの中に URL がそのまま混ざっている
+  en: A bare URL among worded links
+
+why:
+  ja: 文書のリンクがほとんど「[導入の手引き](https://…)」のように言葉で書かれているのに、一部だけ「https://…」がそのまま本文に出ていると、そこだけ読み手は長い記号の列を読まされ、行き先が何かを URL から推し量ることになります。言葉のリンクに揃っていない所は、書き直し忘れのことが多い形です。どちらの書き方が正しいかは決めません。URL をそのまま書く文書（言葉のリンクが少ない文書、URL のほうが多い文書）は指しません。
+  en: When a document's links are mostly words ("[the setup guide](https://…)"), a URL left bare in the text ("https://…") makes the reader read a string of symbols there and guess the target from it. A spot that does not match the worded links is usually one that was not rewritten. Neither style is called right; a document that writes its URLs bare (few worded links, or more bare URLs than worded ones) is not reported.
+
+message:
+  ja: URL「{url}」がそのまま書かれています（言葉のリンクが {count} 個ある文書）
+  en: 'The URL "{url}" is written bare ({count} worded {count|link|links} in this document)'
+
+how_to_fix:
+  ja: 行き先の名前を言葉にしてリンクにしてください（[導入の手引き](https://…)）。URL そのものを見せたいときは、山括弧で囲んでリンクにします（<https://…>）。
+  en: Make the target's name the link text ("[the setup guide](https://…)"). If the URL itself should show, wrap it in angle brackets ("<https://…>").
+
+# 指摘に要る、言葉のリンクの数。少ないと、どちらが文書の書き方かが決まらない。
+levels: { strict: 2, normal: 3, relaxed: 5 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+
+group: consistency
+summary:
+  ja: 言葉でリンクを書く文書の中に、「https://…」がそのまま書かれている所
+  en: A URL written bare in a document whose other links are words
+example:
+  ja:
+    before: |
+      導入は[導入の手引き](https://example.com/setup)に、設定は[設定の一覧](https://example.com/settings)にあります。
+
+      料金は[料金表](https://example.com/pricing)を見てください。問い合わせは https://example.com/contact から送れます。
+    after: |
+      導入は[導入の手引き](https://example.com/setup)に、設定は[設定の一覧](https://example.com/settings)にあります。
+
+      料金は[料金表](https://example.com/pricing)を見てください。問い合わせは[問い合わせの窓口](https://example.com/contact)から送れます。
+  en:
+    before: |
+      Setup is in [the setup guide](https://example.com/setup), and the options are in [the settings list](https://example.com/settings).
+
+      Prices are on [the pricing page](https://example.com/pricing). Send questions through https://example.com/contact today.
+    after: |
+      Setup is in [the setup guide](https://example.com/setup), and the options are in [the settings list](https://example.com/settings).
+
+      Prices are on [the pricing page](https://example.com/pricing). Send questions through [the contact form](https://example.com/contact) today.
+
+not_flagged:
+  ja: 山括弧で囲んだ URL（<https://…>）、言葉が URL のリンク、コードと引用の中の URL は指しません。参照の形のリンク（[言葉][1]）は言葉のリンクに数えません。言葉のリンクが指摘に要る数に届かない文書と、URL をそのまま書くほうが多い文書も指しません。
+  en: A URL in angle brackets ("<https://…>"), a link whose text is the URL, and URLs in code or quotations are not reported; reference-style links ("[text][1]") are not counted as worded links; nor is a document with fewer worded links than the level needs, or one where bare URLs are not the few.
+level_meaning:
+  ja: 言葉のリンクが {limit} 個以上ある文書で指摘
+  en: reported in a document with {limit} or more worded links
+rewrite:
+  depth: light
+  ja:
+    direction: そのまま書いた URL を、行き先の名前を言葉にしたリンクに変えてください。行き先の名前は、文がすでに言っている名前（窓口、手引き）を使います。URL は変えません。
+    pairs:
+      - before: 問い合わせは https://example.com/contact から送れます。
+        after: 問い合わせは[問い合わせの窓口](https://example.com/contact)から送れます。
+      - before: 手順は https://example.com/guide にまとめました。
+        after: 手順は[作業の手引き](https://example.com/guide)にまとめました。
+    keep:
+      - リンクの行き先（URL）
+      - 文の言っていること
+    avoid:
+      - 行き先の名前を推し量って、URL の中身と違う名前を付ける
+      - 「こちら」「ここ」をリンクの言葉にする
+  en:
+    direction: Turn the bare URL into a link whose text names the target. Use a name the sentence already gives (the form, the guide). Keep the URL.
+    pairs:
+      - before: Send questions through https://example.com/contact today.
+        after: Send questions through [the contact form](https://example.com/contact) today.
+      - before: The steps are at https://example.com/guide for now.
+        after: The steps are in [the setup guide](https://example.com/guide) for now.
+    keep:
+      - the link target (the URL)
+      - what the sentence says
+    avoid:
+      - guessing a name the target page does not have
+      - making "here" or "click here" the link text

package/rules/bold-density.yaml

@@ -61,6 +61,7 @@ level_meaning:
   ja: 1000 字あたり太字 {limit} 箇所まで
   en: up to {limit} bold spans per 1000 characters
 rewrite:
+  depth: light
   ja:
     direction: 太字をいったん全部外し、見落とすと困る所（期限、禁止、金額）を 1〜2 か所だけ太字に戻してください。
     pairs:

package/rules/bold-label-list.yaml

@@ -1,6 +1,6 @@
 id: bold-label-list
 layer: L1
-status: experimental
+status: stable
 how_to_find: bold-label-list
 requires: [markdown]
 # English human writing (handbooks, minutes, policies, changelogs) labels list items in bold as a matter of course: the
@@ -28,6 +28,13 @@ how_to_fix:
 levels: { strict: 3, normal: 5, relaxed: 8 }
 
 use_for: [technical/readme, 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."
+  business/meeting-notes: "A header block of labelled fields (- **日時**：…, - **出席者**：…) is the form of minutes, not a list of captions."
+  speech/transcript: "Labelled speaker turns (- **記者**：…) are how a transcript is laid out."
 sources: [zhang-2024]
 
 group: ai-tells
@@ -58,6 +65,7 @@ level_meaning:
   ja: 太字の札で始まる項目が {limit} 個あれば指摘
   en: reported once {limit} list items open with a bold label
 rewrite:
+  depth: structure
   ja:
     direction: 太字の札を外し、項目を文に戻してください。札の語は文の中に入れ、項目どうしの関係（理由、順番、どちらが大事か）を書きます。用語集のように、札が定義される語そのものなら箇条書きのままにします。
     pairs:

package/rules/bracket-nesting.yaml

@@ -1,6 +1,6 @@
 id: bracket-nesting
 layer: L3
-status: experimental
+status: stable
 how_to_find: bracket-nesting
 severity: info
 
@@ -47,6 +47,7 @@ level_meaning:
   ja: 括弧の重なり {limit} 重まで
   en: brackets nested up to {limit} deep
 rewrite:
+  depth: light
   ja:
     direction: 一番内側の括弧を外して、別の文か注にしてください。括弧の中身は落とさずに残します。
     pairs:

package/rules/bracket-width-consistency.yaml

@@ -0,0 +1,64 @@
+id: bracket-width-consistency
+layer: L1
+status: stable
+how_to_find: mark-consistency
+word_list: bracket-width
+languages: [ja]
+severity: info
+
+name:
+  ja: 丸括弧の全角と半角の混在
+  en: Full-width and half-width parentheses mixed
+
+why:
+  ja: 日本語の文の中で、丸括弧を全角（（））と半角（()）で混ぜて書くと、別々の所から貼り合わせた文書に見えます。どちらが正しいかは決めません。日本語の字に接する括弧だけを数え、文書の中で少ないほうを指します。
+  en: In a Japanese document, parentheses written both full-width （） and half-width () make it look pasted together. chaff does not pick a side; it counts only brackets touching Japanese text and points at the less common way.
+
+message:
+  ja: 括弧を「{mark}」と書いています（この文書はふつう「{usual}」。{of} 箇所のうち {count} 箇所が違う）
+  en: 'The parenthesis "{mark}" here, where the document usually writes "{usual}" ({count} of {of})'
+
+# 少ないほうが 5 箇所以上で、全体の 2 割を超えるとき。書き損じではなく書き方が二通りあるので、1 件にまとめて両方の数を言う。
+messages:
+  mixed:
+    ja: "丸括弧を、全角で {spaced} 箇所、半角で {touching} 箇所書いています。この文書には書き方が二通りあります"
+    en: "Parentheses are 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 () parentheses mixed in one Japanese document
+example:
+  ja:
+    before: |
+      会議（定例）は月曜です。報告（月次）は金曜です。資料(最新版)を配ります。
+    after: |
+      会議（定例）は月曜です。報告（月次）は金曜です。資料（最新版）を配ります。
+
+not_flagged:
+  ja: 日本語の字に接する括弧だけを数えます。英語の中の括弧（f(x)、API(s)）、コード、鉤括弧で引いたものの中は数えません。
+  en: Only brackets touching Japanese text. Brackets in English text (f(x)), code, and 「」 quotations are 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/broken-link.yaml

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

package/rules/chat-citation-residue.yaml

@@ -1,6 +1,6 @@
 id: chat-citation-residue
 layer: L2
-status: experimental
+status: stable
 how_to_find: chat-citation-residue
 word_list: chat-citation-marker
 severity: warning
@@ -49,6 +49,7 @@ level_meaning:
   ja: 名残の印が {limit} 個あれば指摘
   en: reported once there are {limit}
 rewrite:
+  depth: light
   ja:
     direction: リンク先を開いて、その文の出典になっているかを確かめてから、チャットの印だけを消してください。出典にならないリンクは消し、確かめた出典に替えます。
     pairs:

package/rules/citation-reference-mismatch.yaml

@@ -1,6 +1,6 @@
 id: citation-reference-mismatch
 layer: L3
-status: experimental
+status: stable
 how_to_find: citation-entry
 severity: warning
 
@@ -31,6 +31,11 @@ how_to_fix:
 levels: { strict: error, normal: warning, 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: facts
 summary:
@@ -82,6 +87,7 @@ not_flagged:
   ja: 「参考文献」「References」のような見出しの下に文献一覧が無い文書、番号も著者と年も読み取れない文献、文献が一つしか無い一覧は見ません。番号で引く引用と番号の文献、著者と年で引く引用と著者と年の文献は、それぞれの組の中だけで比べます。論文のジャンルでだけ見ます。
   en: 'A document without a list under a heading such as "References", entries that give neither a number nor an author and a year, and a list of one entry are left alone. Numbered citations are compared only with numbered entries, and author-year citations only with author-year entries. Only the academic paper genre runs this rule.'
 rewrite:
+  depth: light
   ja:
     direction: 引用と文献一覧のどちらがずれたのかを書き手に確かめ、ずれたほうを直してください。番号を推測で書き換えず、確かめられないときはその旨を書き手に伝えます。引かない文献は、消すか、引く所を書き手に尋ねます。
     pairs:

package/rules/citation-style-mix.yaml

@@ -1,6 +1,6 @@
 id: citation-style-mix
 layer: L3
-status: experimental
+status: stable
 how_to_find: citation-style
 severity: info
 
@@ -23,6 +23,11 @@ how_to_fix:
 levels: { strict: 3, normal: 2, relaxed: 1 }
 
 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: consistency
 summary:
@@ -81,6 +86,7 @@ level_meaning:
   ja: 少ないほうの書き方が {limit} 箇所以下のとき指摘
   en: reported when the minority style appears {limit} times or fewer
 rewrite:
+  depth: light
   ja:
     direction: 少数の書き方の引用を、論文で最も多い書き方に書き直してください。番号の方式なら、その文献の文献一覧での番号を使います。番号が分からなければ、書き手に確かめます。
     pairs:

package/rules/clause-chain.yaml

@@ -1,6 +1,6 @@
 id: clause-chain
 layer: L3
-status: experimental
+status: stable
 how_to_find: clause-chain
 requires: [pos]
 languages: [ja]
@@ -24,6 +24,10 @@ how_to_fix:
 
 levels: { strict: 4, normal: 5, relaxed: 7 }
 
+# 法令と契約は、要件を節でつないで一文に書く。既定の上限では group の文書の過半に出たので、測って上げた（spec §21.1）。
+by_genre:
+  legal: { strict: 7, normal: 8, relaxed: 10 }
+
 use_for: [business, technical, blog, legal, docs, academic, literature, speech]
 
 group: readability
@@ -44,6 +48,7 @@ level_meaning:
   ja: 一文の節 {limit} つまで
   en: up to {limit} clauses in one sentence
 rewrite:
+  depth: light
   ja:
     direction: 節のつなぎ目（「〜が、」「〜ので、」「〜て、」）のどこかで文を切り、切った所の関係を次の文の頭で言い直してください。
     pairs:

package/rules/cliche.yaml

@@ -0,0 +1,67 @@
+id: cliche
+layer: L2
+status: stable
+how_to_find: phrase-match
+word_list: cliche
+requires: [pos]
+languages: [en]
+severity: info
+
+name:
+  ja: 使い古された決まり文句
+  en: Cliché
+
+why:
+  ja: 英語の「at the end of the day」「low-hanging fruit」「move the needle」のような決まり文句は、使われすぎて中身が抜けた比喩です。読み手は見慣れた形を読み飛ばし、この文書で何が言いたいのかが残りません。言い回しの一覧は言語ごとの語彙表にあり、それぞれに何を書けばよいかが付いています。
+  en: '"At the end of the day", "low-hanging fruit" and "move the needle" are figures of speech worn down to filler. The reader skims the familiar shape and learns nothing about this document. The phrases are listed in the lexicon, each with what to write instead.'
+
+message:
+  ja: 「{matched}」は使い古された決まり文句です
+  en: '"{matched}" is a cliché'
+
+how_to_fix:
+  ja: 決まり文句が指していた中身を、そのまま書いてください（low-hanging fruit → 簡単に済む作業の名前）。
+  en: Say what the phrase stood for ("low-hanging fruit" → name the easy tasks).
+
+levels: { strict: 1, normal: 1, relaxed: 2 }
+
+use_for: [business, technical, blog, legal, docs, academic, literature, speech]
+off_for:
+  literature: "A narrator or a character may speak in clichés; the voice is the author's choice."
+  speech: "A transcript keeps the speaker's words."
+
+group: wording
+summary:
+  ja: 英語で、「at the end of the day」「low-hanging fruit」のような使い古された決まり文句
+  en: A worn phrase such as "at the end of the day" or "low-hanging fruit"
+example:
+  en:
+    before: |
+      At the end of the day, the new cache is faster.
+    after: |
+      The new cache cuts load time from 2 seconds to 0.5.
+
+not_flagged:
+  ja: 一覧にある言い回しだけを見ます。ほかの規則が見る言い回し（ai-tell の「game-changer」、empty-intensifier の「needless to say」）は入れていません。英語の文書だけで動き、文学と講演の書き起こしは対象にしません。
+  en: Only the phrases on chaff's list are checked. Phrases another rule reads ("game-changer" in ai-tell, "needless to say" in empty-intensifier) are not on it. English documents only; literature and speech transcripts are not checked.
+level_meaning:
+  ja: 当てはまる言い回しが {limit} 箇所あれば指摘
+  en: reported once there are {limit}
+sources: [write-good, proselint]
+rewrite:
+  depth: light
+  en:
+    direction: Replace the cliché with what it stood for in this document, following the lexicon's note for the phrase. If the text does not say what that is, ask the writer rather than invent it.
+    pairs:
+      - before: At the end of the day, the new cache is faster.
+        after: The new cache is faster.
+      - before: Fixing the login page is low-hanging fruit.
+        after: Fixing the login page takes an hour.
+      - before: Let's touch base next week.
+        after: Let's talk next week.
+    keep:
+      - the claim the sentence makes
+      - numbers, names and dates in the sentence
+    avoid:
+      - swapping one cliché for another
+      - inventing a figure or a date the text does not give

package/rules/closing-cliche.yaml

@@ -29,6 +29,12 @@ levels:
   relaxed: 2
 
 use_for: [blog, 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: "A speech opens with greetings and closes with thanks: that is its form, not padding."
 
 group: wording
 summary:
@@ -63,6 +69,7 @@ level_meaning:
   ja: 当てはまる結びが {limit} 箇所あれば指摘
   en: reported once there are {limit}
 rewrite:
+  depth: light
   ja:
     direction: 決まり文句の結びを消してください。本文の結論がすでに最後にあれば、そこで終えます。無ければ、本文で分かったことのうち持ち帰ってほしい一つを一文で書きます。
     pairs:

package/rules/code-fence-language-mix.yaml

@@ -0,0 +1,176 @@
+id: code-fence-language-mix
+layer: L1
+status: stable
+how_to_find: code-fence-language
+requires: [markdown]
+severity: info
+
+name:
+  ja: 言語名の無いコードブロックが混ざっている
+  en: Code blocks with and without a language
+
+why:
+  ja: コードブロックに言語名（```bash、```json）を付けると、読み手の画面で色が付き、何の言語かがひと目で分かります。ほとんどのブロックに付けているのに一部だけ無いと、そのブロックだけ色が付かず、付け忘れに見えます。どちらに揃えるかは決めず、少ないほうを指します（markdownlint の MD040 は、すべてのブロックに言語名を求めます）。
+  en: "A language on a code block (```bash, ```json) gives it highlighting on the reader's screen and says at a glance what it is. When most blocks name their language and a few do not, those few show plain and look forgotten. chaff does not decide which way to go; it points at the fewer (markdownlint's MD040 asks for a language on every block)."
+
+message:
+  ja: このコードブロックだけ言語名がありません（言語名のあるブロック {tagged} 個）
+  en: This code block names no language, unlike the others ({tagged} blocks name one)
+
+how_to_fix:
+  ja: 「```」の後ろに言語名を書いてください。出力や平文なら「text」と書きます。
+  en: Add the language after the opening ```. For output or plain text, write "text".
+
+levels: { strict: 3, normal: 2, relaxed: 1 }
+
+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: consistency
+summary:
+  ja: ほとんどのコードブロックに言語名があるのに、一部だけ無い所
+  en: A code block without a language among blocks that name theirs
+example:
+  ja:
+    config: { genre: docs/manual }
+    before: |
+      # 使い方
+
+      インストールします。
+
+      ```bash
+      npm install chaffjs
+      ```
+
+      設定を書きます。
+
+      ```yaml
+      genre: technical/readme
+      ```
+
+      確かめます。
+
+      ```
+      npx chaffjs README.md
+      ```
+    after: |
+      # 使い方
+
+      インストールします。
+
+      ```bash
+      npm install chaffjs
+      ```
+
+      設定を書きます。
+
+      ```yaml
+      genre: technical/readme
+      ```
+
+      確かめます。
+
+      ```bash
+      npx chaffjs README.md
+      ```
+  en:
+    config: { genre: docs/manual }
+    before: |
+      # Usage
+
+      Install it.
+
+      ```bash
+      npm install chaffjs
+      ```
+
+      Write the settings.
+
+      ```yaml
+      genre: technical/readme
+      ```
+
+      Check a file.
+
+      ```
+      npx chaffjs README.md
+      ```
+    after: |
+      # Usage
+
+      Install it.
+
+      ```bash
+      npm install chaffjs
+      ```
+
+      Write the settings.
+
+      ```yaml
+      genre: technical/readme
+      ```
+
+      Check a file.
+
+      ```bash
+      npx chaffjs README.md
+      ```
+
+not_flagged:
+  ja: 字下げだけのコードブロック、引用の中のブロックは見ません。言語名の無いブロックが {limit} 個を超えるとき、または言語名のあるブロックより多いときは、使い分けとみなして指しません。
+  en: Indented code blocks and blocks inside a quotation are not read. When more than {limit} blocks lack a language, or they are as many as those with one, it is taken as a choice and not reported.
+level_meaning:
+  ja: 言語名の無いブロックが {limit} 個以下で、ある方より少ないとき指摘
+  en: reported when {limit} or fewer blocks lack a language and they are fewer than those with one
+rewrite:
+  depth: light
+  ja:
+    direction: 言語名の無いブロックに、中身の言語名を付けてください。コマンドなら bash、設定なら yaml や json、出力や平文なら text です。中身から言語が決められなければ text にします。コードは変えません。
+    pairs:
+      - before: |
+          ```
+          npx chaffjs README.md
+          ```
+        after: |
+          ```bash
+          npx chaffjs README.md
+          ```
+      - before: |
+          ```
+          3 findings
+          ```
+        after: |
+          ```text
+          3 findings
+          ```
+    keep:
+      - ブロックの中身
+    avoid:
+      - 中身と違う言語名を付ける
+  en:
+    direction: Give each block without a language the language of its content. Commands are bash, settings yaml or json, output or plain text text. If the content does not settle it, use text. Do not change the code.
+    pairs:
+      - before: |
+          ```
+          npx chaffjs README.md
+          ```
+        after: |
+          ```bash
+          npx chaffjs README.md
+          ```
+      - before: |
+          ```
+          3 findings
+          ```
+        after: |
+          ```text
+          3 findings
+          ```
+    keep:
+      - the block's content
+    avoid:
+      - naming a language the content is not in

package/rules/colloquial-opener.yaml

@@ -0,0 +1,62 @@
+id: colloquial-opener
+layer: L2
+status: stable
+how_to_find: opener-pile
+word_list: colloquial-opener
+requires: [pos]
+languages: [ja]
+severity: info
+
+name:
+  ja: 文頭の話し言葉の接続詞
+  en: A spoken conjunction opening a sentence
+
+why:
+  ja: 文の頭の「なので」「でも」「だけど」は話し言葉の接続詞です。報告書や案内の中にあると、そこだけ口調が砕けて聞こえます。書き言葉には同じ働きの語（そのため、したがって、しかし）があります。文の途中の「〜なので」は普通の書き方なので見ません。
+  en: In Japanese, なので, でも and だけど at the head of a sentence are spoken conjunctions. In a report or a notice they make that sentence sound casual. Written Japanese has words that do the same job (そのため, しかし). なので inside a sentence is ordinary and not checked.
+
+message:
+  ja: 「{matched}」で始まる文が {count} 個あります（{limit} 個から）
+  en: '{count} {count|sentence opens|sentences open} with "{matched}" ({limit} needed)'
+
+how_to_fix:
+  ja: 書き言葉の接続詞に替えてください（なので → そのため、でも → しかし）。
+  en: Use the written conjunction (なので → そのため, でも → しかし).
+
+levels: { strict: 1, normal: 1, relaxed: 2 }
+
+use_for: [business, technical, legal, docs, academic, literature, speech]
+off_for:
+  literature: "Spoken 全然大丈夫, なので and より in a character's voice; classical verse has a たり that does not list."
+  speech: "Spoken Japanese says 全然大丈夫, opens with なので and greets with より参りました."
+
+group: wording
+summary:
+  ja: 「なので、」「でも、」のような話し言葉の接続詞で始まる文
+  en: A Japanese sentence opening with a spoken conjunction (なので, でも)
+example:
+  ja:
+    before: |
+      在庫が足りません。なので、出荷は来週になります。
+    after: |
+      在庫が足りません。そのため、出荷は来週になります。
+
+not_flagged:
+  ja: 文の途中の「〜なので」「〜でも」と、書き言葉の接続詞（そのため、しかし、したがって）は指しません。ブログ、文芸、話し言葉のジャンルでは動きません。
+  en: なので and でも inside a sentence, and written conjunctions (そのため, しかし), are not reported. Off for blogs, literature and speech.
+level_meaning:
+  ja: 話し言葉の接続詞で始まる文が {limit} 個あれば指摘
+  en: reported from {limit} sentences opening with a spoken conjunction
+rewrite:
+  depth: light
+  ja:
+    direction: 文頭の話し言葉の接続詞を、同じ働きの書き言葉に替えてください（なので → そのため、でも → しかし、だけど → しかし）。
+    pairs:
+      - before: 在庫が足りません。なので、出荷は来週になります。
+        after: 在庫が足りません。そのため、出荷は来週になります。
+      - before: 費用は増えます。でも、作業は半分になります。
+        after: 費用は増えます。しかし、作業は半分になります。
+    keep:
+      - 前の文とのつながりの向き（理由、逆接）
+    avoid:
+      - 接続詞を消して、つながりの向きを読み手に推させる