All rules

Too many list items led by a bold label

bold-label-liston by default (info)Japanese

List items, one after another, that open with a bold label and a colon

Example

Flagged
# 新しい在庫システム - **速さ**:一覧が 1 秒で出ます。 - **正確さ**:数え間違いが減ります。 - **安さ**:月の費用が下がります。 - **使いやすさ**:画面が分かりやすくなりました。 - **安全**:権限を細かく分けられます。
What chaff prints
3:1 「速さ」など、太字の札で始まる項目が 5 個あります(5 個から)
Fixed
# 新しい在庫システム 一覧は 1 秒で出るようになり、数え間違いも減りました。 月の費用は下がり、権限も細かく分けられます。
What chaff prints
no finding
chaff.yaml used for this example
genre: blog/tech

How to fix

Drop the labels and write the items as sentences. If only one or two items matter, give them a paragraph and cut or merge the rest. A real glossary, where each label is the term being defined, can stay.

Why it matters

An item that opens with a bold label and a colon ("- **Speed**: ..."), item after item. The labels make every item look like a heading of equal weight, and the links between the items go unwritten. A shape common in generated text.

What it does not flag

An item whose label is only code (a list of options or fields) is not counted, nor is one without a colon after the label or without text after the colon. Specification (technical/spec), legal, documentation, academic and literary genres do not run this rule. Japanese documents only; English writers use this shape as a matter of course.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: bold-label-list — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax bold-label-list --why "reason"
Turn it off for the team (chaff.yaml)
rules: bold-label-list: off
Technical details
Layer
L1
Status
stable
Severity
info
Languages
ja
Suited to
technical/readme, blog, business, legal, docs, academic, literature, speech
Reads from the document
markdown

Levels

Set a level for this rule under rules in chaff.yaml. With nothing set, it runs at the level its genre gives it (see By genre below).

strictreported once 3 list items open with a bold label
normalreported once 5 list items open with a bold label
relaxedreported once 8 list items open with a bold label

By genre

Runs by default in
technical/readme, blog/tech, blog/essay, blog/owned-media, business/proposal, business/report, business/email, business/press-release, speech/address
Turned off by the genre in
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/transcript
Not suited to, and not run in
technical/spec

Genres

Message

"{label}" and other bold labels open {count} list items ({limit} needed)

Rewrite depth (chaff fix-plan --depth): structure — sections, headings and paragraphs are reorganised

Sources

This page is built from the rule's definition file:packages/chaff/rules/bold-label-list.yaml