中身の無い節
empty-section既定で動く日本語 / 英語
見出しのすぐ後ろに同じ深さか浅い見出しが来て、何も書かれていない節
例
指摘される文
# 手順書
## 準備
## 作業
部品を取り付けます。
chaff の出力
3:1 見出し「準備」の下に中身がありません
直した文
# 手順書
## 準備
道具をそろえます。
## 作業
部品を取り付けます。
chaff の出力
指摘なし
直し方
節の中身を書くか、見出しを消してください。
なぜ指摘するのか
見出しのすぐ後ろに、同じ深さか浅い見出しが来ると、その節には何も書かれていません。書くつもりで見出しだけ立てたか、中身を消したときに見出しが残ったものです。目次には載るので、読み手は開いて何も無いことに気づきます。深い見出しが続く(節を小さな節に分けた)ときは中身があるので指摘しません。文書の最後の見出しも、後ろに何も無ければ指摘します。HTML のコメントだけの節は空と数えます。
指摘しないもの
すぐ後ろに深い見出しが来る節(小さな節に分けたもの)は指しません。Markdown の文書でだけ動きます。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: empty-section — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax empty-section --why "理由"
チームで止める(chaff.yaml)
rules:
empty-section: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, technical, blog, legal, docs, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | エラー |
|---|---|
| normal | 注意 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- technical/spec, technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, business/meeting-notes, legal/contract, legal/statute, legal/judgment, legal/patent, docs/manual, docs/faq, docs/glossary, academic/paper, literature/fiction, literature/essay, literature/poetry, literature/play, speech/address, speech/transcript
指摘の文
見出し「{heading}」の下に中身がありません
このページはルールの定義ファイルから作られています:packages/chaff/rules/empty-section.yaml