非推奨と書いた名前をコード例で使っている
deprecated-option-used既定で動く日本語 / 英語
非推奨と書いたオプションを、同じ文書のコード例がまだ使っている所
例
直し方
例を、非推奨の名前の代わりになるものを使う書き方に直してください。古い書き方を見せる例なら、その行に非推奨とコメントしてください。
なぜ指摘するのか
「`indent` は非推奨です」と書いた同じ文書のコード例が `{ indent: 2 }` を使っていると、読み手は例をそのまま写して、やがて動かなくなる書き方を覚えます。オプションを非推奨にしたときに、説明だけを直して例を直し忘れると起きます。文の中で「非推奨」「deprecated」にいちばん近いコードの名前と、それらの語のある表の行の最初の列の名前を非推奨の名前として読み、コードブロックの中でその名前をキー（indent:）、引数（indent=）、フラグ（--indent）として使っている行を指します。
指摘しないもの
「非推奨ではない」のように打ち消した語、API を宣言するコードブロック（interface、class、type）、その行に非推奨と書いたコード（古い書き方を見せる例）、名前をキー・引数・フラグ以外で書いたもの（文字列の中、メンバーの読み出し obj.indent）、コードの外の文、コードで書いていない名前は見ません。
止める・ゆるめる
技術的な情報
- 層
- L1
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- technical, docs, blog, legal, academic, literature, speech
- 文書から読み取るもの
- markdown
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | エラー |
|---|---|
| normal | 注意 |
| relaxed | 情報 |
このルールには数える上限がありません。段階は指摘の重さを変えます。relaxed にすると指摘は消えずに一段軽く出ます。
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
非推奨と書いた「{name}」を、コード例で使っています
このページはルールの定義ファイルから作られています:packages/chaff/rules/deprecated-option-used.yaml