閉じていないコードブロック
unclosed-code-fence既定で動く日本語 / 英語
「```」で始めたまま閉じていないコードブロック(後ろがすべてコードになる)
例
指摘される文
手順は次のとおりです。
```sh
npm install
## 確認
動くことを確かめます。
chaff の出力
3:1 「```sh」で始めたコードブロックが閉じていません
直した文
手順は次のとおりです。
```sh
npm install
```
## 確認
動くことを確かめます。
chaff の出力
指摘なし
直し方
コードの終わりに、始めと同じ記号を同じ数以上並べた行(「```」)を足してください。
なぜ指摘するのか
「```」で始めたコードブロックを閉じ忘れると、Markdown は文書の終わり(リストの項目の中ならその項目の終わり)までをすべてコードとして表示します。後ろの見出しも本文も等幅の字の塊になり、読み手には文書が壊れて見えます。
指摘しないもの
閉じたコードブロック、字下げで書いたコードブロック、引用の中のコードブロックは指しません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: unclosed-code-fence — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax unclosed-code-fence --why "理由"
チームで止める(chaff.yaml)
rules:
unclosed-code-fence: 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
指摘の文
「{fence}」で始めたコードブロックが閉じていません
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/unclosed-code-fence.yaml