言語名の無いコードブロックが混ざっている
code-fence-language-mix既定で動く(情報)日本語 / 英語
ほとんどのコードブロックに言語名があるのに、一部だけ無い所
例
指摘される文
# 使い方
インストールします。
```bash
npm install chaffjs
```
設定を書きます。
```yaml
genre: technical/readme
```
確かめます。
```
npx chaffjs README.md
```
chaff の出力
17:1 このコードブロックだけ言語名がありません(言語名のあるブロック 2 個)
直した文
# 使い方
インストールします。
```bash
npm install chaffjs
```
設定を書きます。
```yaml
genre: technical/readme
```
確かめます。
```bash
npx chaffjs README.md
```
chaff の出力
指摘なし
この例で使った chaff.yaml
genre: docs/manual
直し方
「```」の後ろに言語名を書いてください。出力や平文なら「text」と書きます。
なぜ指摘するのか
コードブロックに言語名(```bash、```json)を付けると、読み手の画面で色が付き、何の言語かがひと目で分かります。ほとんどのブロックに付けているのに一部だけ無いと、そのブロックだけ色が付かず、付け忘れに見えます。どちらに揃えるかは決めず、少ないほうを指します(markdownlint の MD040 は、すべてのブロックに言語名を求めます)。
指摘しないもの
字下げだけのコードブロック、引用の中のブロック、書式の型だけを書いたブロック(<MAJOR>.<MINOR>.<PATCH>)は見ません。言語名の無いブロックが {limit} 個を超えるとき、または言語名のあるブロックより多いときは、使い分けとみなして指しません。
止める・ゆるめる
この一か所だけ黙らせる(文書に書く)
<!-- stet: code-fence-language-mix — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax code-fence-language-mix --why "理由"
チームで止める(chaff.yaml)
rules:
code-fence-language-mix: off
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 情報
- 対象の言語
- 日本語と英語
- 向いている文章
- technical, docs, blog, legal, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ(段階)
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。
| strict | 言語名の無いブロックが 3 個以下で、ある方より少ないとき指摘 |
|---|---|
| normal | 言語名の無いブロックが 2 個以下で、ある方より少ないとき指摘 |
| relaxed | 言語名の無いブロックが 1 個以下で、ある方より少ないとき指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
このコードブロックだけ言語名がありません(言語名のあるブロック {tagged} 個)
書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す
このページはルールの定義ファイルから作られています:packages/chaff/rules/code-fence-language-mix.yaml