ルールの一覧へ

見出しのコマンドやオプションが、その節のコードに無い

heading-command-missing既定で動く(情報)日本語 / 英語

見出しが名指すコマンドやオプションが、その節のコード例のどこにも無い所

例

指摘される文
# 使い方 ## `--dry-run` 直さずに、直す所だけを見せます。 ```bash npx chaffjs fix --dryrun README.md ```
chaff の出力
3:1 見出しの「--dry-run」が、この節のコードにありません
直した文
# 使い方 ## `--dry-run` 直さずに、直す所だけを見せます。 ```bash npx chaffjs fix --dry-run README.md ```
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: docs/manual

直し方

見出しとコード例のどちらが今の名前かを確かめて、もう一方を直してください。

なぜ指摘するのか

「## `--dry-run`」の節のコード例が「--dryrun」を使っていると、読み手はどちらが正しいか分かりません。コマンドやオプションの名前を変えたときに、見出しかコード例の片方だけを直すと起きます。見出しのコードの部分(`npm install`、`--force`、`init`)が、その節(次の同じ深さか浅い見出しまで)のコードブロックにもコードの部分にも無いとき指します。節にコードが一つも無ければ見ません。

指摘しないもの

コードの無い節、ファイル名や関数名(`config.yaml`、`useEffect`)を書いた見出し、コードの部分の無い見出しは見ません。`--force` は `--force-with-lease` の中にあっても、あったとは数えません。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: heading-command-missing — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax heading-command-missing --why "理由"
チームで止める(chaff.yaml)
rules: heading-command-missing: off
技術的な情報
層
L1
状態
安定
重さ
情報
対象の言語
日本語と英語
向いている文章
technical, docs, blog, legal, academic, literature, speech
文書から読み取るもの
markdown

強さ(段階)

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。

strict注意
normal情報
relaxed情報

このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。

ジャンルごとの動き

既定で動くジャンル
technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, docs/manual, docs/faq, docs/glossary
このルールを止めるジャンル
legal/contract, legal/statute, legal/judgment, legal/patent, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
このルールが向かず、見ないジャンル
business/proposal, business/report, business/email, business/press-release, business/meeting-notes

ジャンル

指摘の文

見出しの「{command}」が、この節のコードにありません

書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す

このページはルールの定義ファイルから作られています:packages/chaff/rules/heading-command-missing.yaml