中身の無い箇条書きの項目
empty-list-item既定で動く日本語 / 英語
「担当:」のように見出しの語だけで値の無い項目と、記号だけの項目
例
指摘される文
- 日時:10月14日 10時
- 場所:第2会議室
- 担当:
chaff の出力
3:1 「担当」の後に値がありません(同じ箇条書きのほかの項目には書いてあります)
直した文
- 日時:10月14日 10時
- 場所:第2会議室
- 担当:山田
chaff の出力
指摘なし
直し方
値を書いてください。まだ決まっていないなら「未定(いつ決めるか)」と書きます。要らない項目なら消します。
なぜ指摘するのか
「担当:」のように見出しの語だけを書いて値の無い項目や、記号だけの項目です。同じ箇条書きのほかの項目には値が書いてあるので、書き忘れか、まだ決まっていないことが読み手には分かりません。
指摘しないもの
見出しの語だけの項目は、同じ箇条書きのほかの項目に「見出し:値」の形が一つも無ければ指しません(記入用の書式)。下に入れ子の箇条書きや段落が続く項目(「手順:」の下に手順を並べたもの)も指しません。Markdown の箇条書きでだけ動きます。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: empty-list-item — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax empty-list-item --why "理由"
チームで止める(chaff.yaml)
rules:
empty-list-item: 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
指摘の文
「{name}」の後に値がありません(同じ箇条書きのほかの項目には書いてあります)
中身の無い箇条書きの項目です
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/empty-list-item.yaml