chaffjs 0.28.0 → 0.30.0

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,86 @@
+id: undefined-term
+layer: L3
+status: stable
+how_to_find: undefined-term
+requires: [structure, pos]
+languages: [ja, en]
+severity: info
+
+name:
+  ja: 定義した語の形で書いたのに、どこにも定義が無い
+  en: A term written like a defined term but defined nowhere
+
+why:
+  ja: 契約や規約は、「本業務」「本サービス」のように、頭に「本」を付けた語を定義して使います。同じ形の「本成果物」を定義せずに書くと、読み手は、どこかで定義した語なのか、何を指すのかが分かりません。定義が抜けたのか、別の定義した語（本業務）を書き違えたのかのどちらかです。文書が「本」を付けた語を一つ以上定義しているときだけ、その形で書いたのに定義も言い換えの形（本件業務）も無い語を、最初の一か所だけ指します。英語の契約は、定義した語を大文字で始めて書きます（the Services）。"X" means や (the "X") の形の定義が二つ以上ある文書で、文の途中に大文字で始めて書いたのに、どこにも定義が無い語（its Affiliates）も同じく指します。
+  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. An English contract capitalises its defined terms (the Services); in a document with at least two definitions written with a defining word (“X” means, (the “X”)), a capitalised term inside a sentence that is defined nowhere (its Affiliates) is reported the same way."
+
+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: 「本業務」のように定義した語と同じ形の「本成果物」や、英語の契約で大文字で始めた語（its Affiliates）を、定義しないまま使っている所
+  en: A term in the defined form (本成果物, its Affiliates) that the document never defines
+example:
+  ja:
+    config: { genre: legal/contract }
+    before: |
+      # 業務委託契約書
+
+      第1条　甲は、ウェブサイトの保守の業務（以下「本業務」という。）を乙に委託する。
+
+      第2条　乙は、本成果物を甲に提出する。
+    after: |
+      # 業務委託契約書
+
+      第1条　甲は、ウェブサイトの保守の業務（以下「本業務」という。）を乙に委託する。
+
+      第2条　乙は、本業務の報告書を甲に提出する。
+  en:
+    config: { genre: legal/contract }
+    before: |
+      # Services Agreement
+
+      This Services Agreement (this "Agreement") is made between Harbour Works Ltd (the "Supplier") and Northwind Retail Inc. (the "Customer").
+
+      1. The Supplier shall provide the hosting services (the "Services") to the Customer and its Affiliates.
+    after: |
+      # Services Agreement
+
+      This Services Agreement (this "Agreement") is made between Harbour Works Ltd (the "Supplier") and Northwind Retail Inc. (the "Customer").
+
+      1. The Supplier shall provide the hosting services (the "Services") to the Customer.
+
+not_flagged:
+  ja: 文書が「本」を付けた語を一つも定義していなければ見ません。定義した語とその言い換え（本件業務、defined-term-form が見ます）、定義した語で始まる語（本サービス上）、この文書やその一部を指す語（本条、本項、本書、本契約、本利用規約、本サイト）、どこかでかぎ括弧に入れた語（定義の書き方を chaff が読めなかったもの）、一語の言葉（本人、本日、本社）は見ません。同じ語は最初の一か所だけ指します。英語は、大文字は法令・組織・方針の名前（the Federal Trade Commission Act、Acceptable Use Policies）にも使うので、狭く読みます。"X" means や (the "X") の形の定義が二つ未満の文書は見ません。文の頭や記号の後ろの語、小文字の名詞の前に付けた語（the Premium plan）、名前の一覧（proper-name-word、地名、曜日と月、会社の形、当事者の役割）の語を含むもの、条の参照（Section 4、Schedule A）、見出し・リンク・太字・HTML の要素・表・箇条書きの見出しの中、どこかで引用符か太字に入れた語、定義した語を含むもの（大文字小文字を問いません）、文書のどこかで小文字でも書いた語（your Account と your account。普通の語か画面の名前）は見ません。法令・判決・特許は見ません。契約書・規約のジャンルで見ます。
+  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 read narrowly, since capitals also name laws, organisations and policies (the Federal Trade Commission Act, Acceptable Use Policies): a document with fewer than two definitions written with a defining word (“X” means, (the “X”)) is not read; and a word at the start of a sentence or after a mark, a modifier of a lower-case noun (the Premium plan), a run holding a word of the name lists (proper-name-word, places, weekdays and months, company forms, party roles), a reference to a part (Section 4, Schedule A), anything inside a heading, a link, bold, an HTML element, a table or a list item's label, a word set in quotes or bold anywhere, a run holding a defined term in any case, and a word the document also writes in lower case (your Account and your account: an ordinary word or a screen's name) are not reported. 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.'

package/rules/version-order.yaml

@@ -0,0 +1,85 @@
+id: version-order
+layer: L1
+status: stable
+how_to_find: version-order
+requires: [markdown]
+severity: warning
+
+name:
+  ja: 版の並びが前後している
+  en: A version out of order in a changelog
+
+why:
+  ja: 変更履歴は新しい版から順に（または古い版から順に）並べるのが決まりです。一つだけ並びから外れた版があると、読み手はどれが最新か、どの変更がどの版に入ったかを取り違えます。版を書き間違えたときや、項目を違う場所に足したときに起きます。見出しや箇条書き、表の行の先頭に書いた版（3.2.0、v3.2.0、[3.2.0]）を並びとして読み、並びの向きは多いほうで決めて、その向きの最も長い並びに入らない版を指します。
+  en: A changelog lists its versions newest first (or oldest first). One version out of that order makes the reader mistake which release is the latest, or which change went into which release. It happens when a version is mistyped or an entry is added in the wrong place. The versions at the start of headings, list items or table rows (3.2.0, v3.2.0, [3.2.0]) are read as a sequence; its direction is taken from most of its steps, and a version that fits in no longest run along that direction is pointed out.
+
+message:
+  ja: 「{version}」が、前後の版の並びから外れています（前は「{previous}」）
+  en: "{version} breaks the order of the versions around it (after {previous})"
+
+how_to_fix:
+  ja: 版の番号を確かめて、書き間違いなら直し、置き場所が違うなら正しい位置へ移してください。
+  en: Check the version number. Correct it if it is a typo, or move the entry to where it belongs.
+
+levels: { strict: error, normal: warning, relaxed: info }
+
+use_for: [technical, docs, blog, legal, academic, literature, speech]
+off_for:
+  legal: "Changelogs and release lists belong to technical writing."
+  academic: "Changelogs and release lists belong to technical writing."
+  literature: "Changelogs and release lists belong to technical writing."
+  speech: "Changelogs and release lists belong to technical writing."
+
+group: facts
+summary:
+  ja: 変更履歴の見出しや版の一覧で、一つだけ順番から外れた版
+  en: One version out of order in a changelog or a list of releases
+example:
+  ja:
+    config: { genre: technical/readme }
+    before: |
+      # 変更履歴
+
+      ## 3.2.0 - 2026-09-14
+
+      ## 3.1.1 - 2026-07-08
+
+      ## 3.3.0 - 2026-06-02
+
+      ## 3.0.0 - 2026-03-20
+    after: |
+      # 変更履歴
+
+      ## 3.2.0 - 2026-09-14
+
+      ## 3.1.1 - 2026-07-08
+
+      ## 3.1.0 - 2026-06-02
+
+      ## 3.0.0 - 2026-03-20
+  en:
+    config: { genre: technical/readme }
+    before: |
+      # Changelog
+
+      ## 3.2.0 - 2026-09-14
+
+      ## 3.1.1 - 2026-07-08
+
+      ## 3.3.0 - 2026-06-02
+
+      ## 3.0.0 - 2026-03-20
+    after: |
+      # Changelog
+
+      ## 3.2.0 - 2026-09-14
+
+      ## 3.1.1 - 2026-07-08
+
+      ## 3.1.0 - 2026-06-02
+
+      ## 3.0.0 - 2026-03-20
+
+not_flagged:
+  ja: 並べた版が三つ未満のもの、上がりと下がりが同じ数で向きが決まらないもの、向きに沿う版が半分以下の一覧（名前順の一覧）、同じ版の繰り返し、文の中の版、コードブロックの中の例、点で三つに区切っていない番号（3.1、22.04）は見ません。末尾が 0 の版（3.1.0）が無く上がっていく並び（1.2.1、1.2.2）は節の番号として numbering-gap が見ます。見出しは同じ深さどうし、箇条書きと表は続いた行どうしを比べます。
+  en: "Fewer than three versions, a sequence with as many steps up as down, a list where no more than half of the versions follow one direction (sorted by name), a repeated version, versions in running text, examples in a code block, and numbers not in three dotted parts (3.1, 22.04) are not checked. A sequence that goes up with no version ending in zero (1.2.1, 1.2.2) is read as section numbers, which numbering-gap checks. Headings are compared with headings of the same depth, and list items and table rows with the lines they run on from."

package/rules/very-adjective.yaml

@@ -3,26 +3,26 @@ layer: L2
 status: stable
 how_to_find: intensified-adjective
 word_list: very-intensifier
-extra_word_lists: [very-exception]
+extra_word_lists: [very-exception, very-copula]
 requires: [pos]
-languages: [en]
+languages: [ja, en]
 severity: info
 
 name:
-  ja: 「very + 形容詞」の多用
+  ja: 「とても + 形容詞」（very + 形容詞）の多用
   en: Too many "very" + adjective
 
 why:
-  ja: 英語の「very important」「very good」は、強い一語（critical、excellent）か、何がどうなのかを言えば要らない語です。一つ二つなら普通ですが、文書の長さのわりに多いと、どの「very」も効かなくなります。「the very first」「very few」のように意味の決まった言い方は語彙表で除いています。
-  en: '"Very important" and "very good" lean on "very" where a stronger word (critical, excellent), or saying what and how much, would do. One or two are ordinary; many for the length make every "very" weightless. Set phrases such as "the very first" and "very few" are excepted in the lexicon.'
+  ja: 「とても便利」「非常に危険」（英語の very important、very good）の強めは、何がどう便利なのか、どの程度危険なのかを書けば要らない語です。一つ二つなら普通ですが、文書の長さのわりに多いと、どの強めも効かなくなります。強めの語と、数えない言い方（the very first、very few）は言語ごとの語彙表にあります。
+  en: '"Very important" and "very good" (とても便利, 非常に危険) lean on "very" where a stronger word (critical, excellent), or saying what and how much, would do. One or two are ordinary; many for the length make every "very" weightless. The intensifiers, and set phrases not counted such as "the very first" and "very few", are listed in the lexicon.'
 
 message:
-  ja: 「{matched}」など、very + 形容詞が 1000 語あたり {density} 個あります（{limit} 個まで）
+  ja: 「{matched}」など、強め + 形容詞が 1000 字あたり {density} 個あります（{limit} 個まで）
   en: '"{matched}" and other "very" + adjective: {density} per 1000 words (limit {limit})'
 
 how_to_fix:
-  ja: 強い一語に替えるか、何がどの程度なのかを書いてください（very important → critical、very fast → under a second）。
-  en: Use a stronger word, or say what and how much ("very important" → "critical", "very fast" → "under a second").
+  ja: 強めを外して、何がどの程度なのかを書いてください（とても速い → 1 秒以内に開く、very important → critical）。
+  en: Use a stronger word, or say what and how much ("very important" → "critical", "very fast" → "under a second"; とても速い → 1 秒以内に開く).
 
 levels: { strict: 1, normal: 2, relaxed: 4 }
 
@@ -33,9 +33,15 @@ off_for:
 
 group: wording
 summary:
-  ja: 英語で、「very important」「very good」のような very + 形容詞が、文書の長さのわりに多い所
-  en: '"Very" + adjective, such as "very important", dense for the document''s length'
+  ja: 「とても便利」「非常に危険」（very important）のような強め + 形容詞が、文書の長さのわりに多い所
+  en: '"Very" + adjective, such as "very important" (とても便利), dense for the document''s length'
 example:
+  ja:
+    pad: true
+    before: |
+      新しい画面はとても便利です。読み込みもすごく速いです。ただ、設定は非常に複雑です。
+    after: |
+      新しい画面では、よく使う三つの操作が一か所にまとまりました。読み込みは 1 秒以内です。ただ、設定の項目は 40 あります。
   en:
     pad: true
     before: |
@@ -44,13 +50,25 @@ example:
       The launch was critical. The team was stretched, and the plan held.
 
 not_flagged:
-  ja: 「very」の後ろが形容詞のときだけ数えます（very well は数えない）。「the very first」「very few」「very much」は数えません。短い文書は密度を測りません。小説と話し言葉では既定で止めています（会話の言葉のため）。
-  en: Only "very" before an adjective ("very well" is not counted), and not "the very first", "very few" or "very much". Short documents are not measured. The fiction and speech presets turn it off, since dialogue speaks that way.
+  ja: 強めの後ろが形容詞のときだけ数えます（very well、とても助かる は数えない）。日本語の「便利」「静か」のような語は、後ろに「な」「で」「だ」「です」が続くときだけ形容詞と見ます。「the very first」「very few」「very much」と、empty-intensifier が見る「とても重要」は数えません。「大変」は決まった挨拶（大変お世話になりました）に使うので数えません。短い文書は密度を測りません。小説と話し言葉では既定で止めています（会話の言葉のため）。
+  en: Only "very" before an adjective ("very well" is not counted), and not "the very first", "very few" or "very much". In Japanese, a word such as 便利 counts as an adjective only before な, で, だ or です; とても重要 is left to empty-intensifier, and 大変, used in set courtesies (大変お世話になりました), is not counted. Short documents are not measured. The fiction and speech presets turn it off, since dialogue speaks that way.
 level_meaning:
-  ja: very + 形容詞が 1000 語あたり {limit} 個まで
+  ja: 強め + 形容詞が 1000 字あたり {limit} 個まで
   en: up to {limit} "very" + adjective per 1000 words
 rewrite:
   depth: light
+  ja:
+    direction: 強め（とても、すごく、非常に）を外し、本文や出典が言う具体（数、何がどうなのか）に置き換えてください。本文が何も言っていなければ、強めを外した形容詞だけにします。
+    pairs:
+      - before: 新しい画面はとても便利です。
+        after: 新しい画面では、よく使う三つの操作が一か所にまとまりました。
+      - before: 読み込みがすごく速いです。
+        after: 読み込みは 1 秒以内です。
+    keep:
+      - 各文の主張
+    avoid:
+      - 強めを別の強め（本当に、極めて）に替えるだけ
+      - 本文に無い数を作る
   en:
     direction: Replace "very" + adjective with a stronger single word, or with what the text says about how much. If the text says nothing more, a plain adjective without "very" will do.
     pairs:

package/rules/warning-without-action.yaml

@@ -0,0 +1,64 @@
+id: warning-without-action
+layer: L3
+status: stable
+how_to_find: warning-action
+# The labels and the words of an action come from the language's warning-label and warning-action lexicons; an English
+# sentence that opens with its verb is read from the parts of speech when they are available.
+uses: [pos]
+languages: [ja, en]
+severity: info
+
+name:
+  ja: することの書かれていない注意書き
+  en: Warning that gives no action
+
+why:
+  ja: 「注意：復元すると、今のデータベースは置き換わります。」のように危険だけを書いた注意書きは、読み手を不安にするだけで、何をすれば防げるのかを教えません。手順書の注意書きは、何が起きるかと、それを防ぐために読み手がすること（先に書き出す、電源を切らない）を一緒に書くものです。「注意」「警告」「危険」で始まる段落の、どの文にも「〜してください」「〜しないこと」のような読み手のすることが無いとき指します。
+  en: 'A warning that only names a risk ("Warning: the restore replaces the current database.") alarms the reader without saying how to avoid it. A warning in a manual says what happens and what the reader does to prevent it (export first, do not unplug the drive). A paragraph that opens with Warning, Caution or Danger is reported when none of its sentences tells the reader what to do: no "do not", "make sure", "must" and no sentence that opens with its verb ("Export today''s orders first").'
+
+message:
+  ja: この注意書きは危険を述べるだけで、読み手がすることを書いていません
+  en: This warning names a risk but not what the reader should do
+
+how_to_fix:
+  ja: 危険を避けるために読み手がすることを、同じ段落に書き足してください（「先に〜を書き出してください」「〜の間は電源を切らないでください」）。
+  en: Add what the reader does to avoid the risk to the same paragraph ("Export today's orders first", "Do not unplug the drive while it runs").
+
+levels: { strict: warning, normal: info, relaxed: info }
+
+use_for: [technical, docs, blog, legal, academic, literature, speech]
+off_for:
+  legal: "Warnings with an action to take are a convention of manuals and technical writing."
+  academic: "Warnings with an action to take are a convention of manuals and technical writing."
+  literature: "Warnings with an action to take are a convention of manuals and technical writing."
+  speech: "Warnings with an action to take are a convention of manuals and technical writing."
+
+group: wording
+summary:
+  ja: 「注意」「警告」で始まる段落で、危険だけを書き、読み手のすること（〜してください、〜しないこと）が無いもの
+  en: A paragraph opening with Warning or Caution that names a risk and no action for the reader
+example:
+  ja:
+    config: { genre: docs/manual }
+    before: |
+      # バックアップを復元する
+
+      注意：復元すると、今のデータベースは置き換わります。
+    after: |
+      # バックアップを復元する
+
+      注意：復元すると、今のデータベースは置き換わります。先に、今日の注文を書き出してください。
+  en:
+    config: { genre: docs/manual }
+    before: |
+      # Restoring a backup
+
+      Warning: the restore replaces the current database.
+    after: |
+      # Restoring a backup
+
+      Warning: the restore replaces the current database. Export today's orders first.
+
+not_flagged:
+  ja: 「注意」「警告」「危険」をそれだけで頭に置いた段落（「注意：」「**警告**」「> [!WARNING]」）だけを読みます。GitHub の注意（> [!WARNING]）は引用の終わりまでを一つの注意書きとして読みます。箇条書きの項目の中の注意書き、「メモ」「ヒント」「重要」の段落、「注意深く」のように語の一部になったもの、どれかの文が読み手のすること（〜してください、〜しないこと、〜する必要があります）で終わる注意書きは指しません。技術文書・手順書・ブログでだけ動きます。
+  en: 'Only paragraphs opening with Warning, Caution or Danger standing alone ("Warning:", "**Caution**", "> [!WARNING]") are read. A GitHub alert (> [!WARNING]) is read to the end of its block quote. Warnings inside list items, notes, tips and "Important" paragraphs, words that merely start with the label ("Warnings are logged"), and warnings with any sentence that gives an action (do not, make sure, must, or a sentence opening with its verb) are not reported. Technical documents, manuals and blogs only.'

package/rules/wordy-phrase.yaml

@@ -4,7 +4,7 @@ status: stable
 how_to_find: phrase-match
 word_list: wordy-phrase
 requires: [pos]
-languages: [en]
+languages: [ja, en]
 severity: info
 
 name:
@@ -12,16 +12,16 @@ name:
   en: Wordy phrase
 
 why:
-  ja: 英語の「in order to」「due to the fact that」「at this point in time」は、「to」「because」「now」と同じことを何語もかけて言います。読み手は語を多く読むだけで、得るものは増えません。言い回しと短い形の組は言語ごとの語彙表にあります。契約や法令がわざと使う言い方（with regard to、prior to）は入れていません。
-  en: '"In order to", "due to the fact that" and "at this point in time" say in several words what "to", "because" and "now" say in one. The reader reads more and learns nothing more. The phrases and their short forms are listed in the lexicon. Phrases that contracts and statutes use on purpose ("with regard to", "prior to") are left out.'
+  ja: 「することが可能」「現時点において」（英語の in order to、at this point in time）は、「できる」「現在」と同じことを何語もかけて言います。読み手は語を多く読むだけで、得るものは増えません。言い回しと短い形の組は言語ごとの語彙表にあります。契約や法令がわざと使う言い方（with regard to、prior to）は入れていません。
+  en: '"In order to", "due to the fact that" and "at this point in time" (することが可能, 現時点において) say in several words what "to", "because" and "now" say in one. The reader reads more and learns nothing more. The phrases and their short forms are listed in the lexicon. Phrases that contracts and statutes use on purpose ("with regard to", "prior to") are left out.'
 
 message:
   ja: 「{matched}」は、もっと短く言えます
   en: '"{matched}" can be said in fewer words'
 
 how_to_fix:
-  ja: 短い形に置き換えてください（in order to → to、due to the fact that → because、in the event that → if）。
-  en: Use the short form ("in order to" → "to", "due to the fact that" → "because", "in the event that" → "if").
+  ja: 短い形に置き換えてください（することが可能です → できます、現時点において → 現在、in order to → to、due to the fact that → because）。
+  en: Use the short form ("in order to" → "to", "due to the fact that" → "because", "in the event that" → "if"; することが可能です → できます).
 
 # 指摘に要る文の数。1 つなら書き手の癖とは言えないので、2 つから。
 levels: { strict: 1, normal: 2, relaxed: 4 }
@@ -34,9 +34,14 @@ off_for:
 
 group: wording
 summary:
-  ja: 英語で、「in order to」「due to the fact that」のように、一語で言えることを何語もかけて言う所
-  en: Phrases such as "in order to" and "due to the fact that" that take several words to say what one says
+  ja: 「することが可能」「現時点において」（in order to、due to the fact that）のように、一語で言えることを何語もかけて言う所
+  en: Phrases such as "in order to" and "due to the fact that" (することが可能, 現時点において) that take several words to say what one says
 example:
+  ja:
+    before: |
+      資料は社内から閲覧することが可能です。現時点において、追加の予定はありません。
+    after: |
+      資料は社内から閲覧できます。現在、追加の予定はありません。
   en:
     before: |
       In order to save time, we met online. Due to the fact that the room was booked, we stayed home.
@@ -44,13 +49,26 @@ example:
       To save time, we met online. Because the room was booked, we stayed home.
 
 not_flagged:
-  ja: 一覧にある言い回しだけを見ます。英語の文書だけで動きます。契約や法令がわざと使う言い方（with regard to、prior to、in accordance with）は一覧に入れていません。
-  en: Only the phrases on chaff's list are checked, and only in English documents. Phrases that contracts and statutes use on purpose ("with regard to", "prior to", "in accordance with") are not on it.
+  ja: 一覧にある言い回しだけを見ます。契約や法令がわざと使う言い方（with regard to、prior to、in accordance with）は一覧に入れていません。日本語では、人の書いた文章でもふつうの「することができる」と、名詞として要る「必要性」は入れていません。翻訳調（を可能にする）は translationese-density が、「〜を行う」は nominalization が見ます。
+  en: Only the phrases on chaff's list are checked. Phrases that contracts and statutes use on purpose ("with regard to", "prior to", "in accordance with") are not on it. In Japanese, することができる, ordinary in human writing, and 必要性, which a noun phrase may need, are left out; translationese (を可能にする) is translationese-density's and 〜を行う is nominalization's.
 level_meaning:
   ja: 回りくどい言い回しを含む文が {limit} 文あれば指摘
   en: reported once {limit} sentences hold one
 rewrite:
   depth: light
+  ja:
+    direction: 回りくどい言い回しを、語彙表の短い形に置き換えてください。文のほかの所は変えません。
+    pairs:
+      - before: 資料は社内から閲覧することが可能です。
+        after: 資料は社内から閲覧できます。
+      - before: 現時点において、追加の予定はありません。
+        after: 現在、追加の予定はありません。
+      - before: 今回の結果は成功であると言えます。
+        after: 今回の結果は成功です。
+    keep:
+      - 文のほかの所と、文が言っていること
+    avoid:
+      - 言い回しを縮めるついでに、文のほかの所を書き換える
   en:
     direction: Replace the wordy phrase with its short form from the lexicon. Leave the rest of the sentence alone.
     pairs:

package/src/ai-score/of-document.ts

@@ -7,7 +7,7 @@ import { MIN_DOCUMENT_LENGTH } from "../detectors/signals.ts";
 import { structureOf } from "../structure-shape/of-document.ts";
 import { HUMAN_SHARES } from "./human-shares.ts";
 import { aiScoreOf, type AiScore, type SignalRun } from "./score.ts";
-import { measuredLevelsOf, scoredSignalIds } from "./signals.ts";
+import { compositeSignalIds, measuredLevelsOf, scoredSignalIds } from "./signals.ts";
 
 const STRUCTURE_RULE = "ai-structure";
 
@@ -20,27 +20,37 @@ const structureApplies = (rules: readonly RuleDefinition[], genre: string): bool
   return rule !== undefined && standingIn(rule, genre, presetLevels(genre)).kind === "on";
 };
 
-/** The AI-shape rules run on the document at the levels the human shares were measured at, whatever chaff.yaml sets. */
-const signalRuns = (doc: ProseDocument, rules: readonly RuleDefinition[], genre: string): SignalRun[] => {
+type SignalResult = { readonly runs: SignalRun[]; readonly compositeFired: string[] };
+
+/**
+ * The AI-shape rules run on the document at the levels the human shares were measured at, whatever chaff.yaml sets,
+ * with ai-structure beside them: it is not counted as a signal, but it is one of the composite's.
+ */
+const signalRuns = (doc: ProseDocument, rules: readonly RuleDefinition[], genre: string): SignalResult => {
   const ofLanguage = rules.filter((rule) => rule.languages === undefined || rule.languages.includes(doc.language));
   const ids = scoredSignalIds(ofLanguage);
-  const signalRules = ofLanguage.filter((rule) => ids.includes(rule.id));
-  const result = runRulesWith(doc, signalRules, { settings: measuredLevelsOf(signalRules, presetLevels(genre)), experimental: true, genre });
-  return ids.map((rule) => {
+  const runRules = ofLanguage.filter((rule) => ids.includes(rule.id) || rule.id === STRUCTURE_RULE);
+  const result = runRulesWith(doc, runRules, { settings: measuredLevelsOf(runRules, presetLevels(genre)), experimental: true, genre });
+  const fired = (rule: string): boolean => result.findings.some((finding) => finding.rule === rule);
+  const runs = ids.map((rule) => {
     const notRun = result.skipped.find((skip) => skip.rule === rule)?.why;
     const count = result.findings.filter((finding) => finding.rule === rule).length;
     return notRun === undefined ? { rule, count } : { rule, count, notRun };
   });
+  return { runs, compositeFired: compositeSignalIds(ofLanguage).filter(fired) };
 };
 
 /** The quick score of a document read as lint reads it, against human documents of its genre group. */
-export const aiScoreOfDocument = (doc: ProseDocument, rules: readonly RuleDefinition[], genre: string): AiScore =>
-  aiScoreOf({
+export const aiScoreOfDocument = (doc: ProseDocument, rules: readonly RuleDefinition[], genre: string): AiScore => {
+  const { runs, compositeFired } = signalRuns(doc, rules, genre);
+  return aiScoreOf({
     group: genreGroupOf(genre),
     length: wordsOf(doc),
     minimum: MIN_DOCUMENT_LENGTH[doc.lengthUnit],
     unit: doc.lengthUnit,
-    signals: signalRuns(doc, rules, genre),
+    signals: runs,
     shares: HUMAN_SHARES,
     structure: structureApplies(rules, genre) ? structureOf(doc) : undefined,
+    compositeFired,
   });
+};