チームの表記と違う
preferred-termchaff.yaml に書いたとき日本語 / 英語
チームで決めた表記と違う書き方（「サーバー」と決めたのに「サーバ」）。chaff.yaml の prefer で決めます
例
指摘される文
新しいサーバを来週入れます。
chaff の出力
1:4 「サーバ」は「サーバー」と書きます
直した文
新しいサーバーを来週入れます。
chaff の出力
指摘なし
この例で使った chaff.yaml
prefer:
サーバ: サーバー
直し方
「prefer に並べた使う書き方」に直してください。固有名詞など、そのままにすべき箇所なら stet で理由を添えて黙らせます。
なぜ指摘するのか
同じものを「サーバー」とも「サーバ」とも書くと、読み手は別のものかと迷い、検索でも片方を取りこぼします。どちらに寄せるかはチームごとに違うので、chaff.yaml の prefer に「使わない書き方」と「使う書き方」の組を自分で並べてください。並べていなければ何も言いません。
指摘しないもの
chaff.yaml の prefer に書いた組だけを見ます。何も書かなければ何も言いません。
止める・ゆるめる
この一か所だけ黙らせる（文書に書く）
<!-- stet: preferred-term — 理由 -->
チームでゆるめる（理由は chaff.yaml にコメントで残ります）
npx chaffjs relax preferred-term --why "理由"
チームで止める（chaff.yaml）
rules:
preferred-term: off
技術的な情報
- 層
- L2
- 状態
- 安定
- 重さ
- 注意
- 対象の言語
- 日本語と英語
- 向いている文章
- business, blog, technical, legal, docs, academic, literature, speech
強さ（段階）
chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます（どのジャンルで動くかは下の「ジャンルごとの動き」にあります）。
| strict | 当てはまる語が 1 箇所あれば指摘 |
|---|---|
| normal | 当てはまる語が 1 箇所あれば指摘 |
| relaxed | 当てはまる語が 3 箇所あれば指摘 |
ジャンルごとの動き
- 既定で動くジャンル
- 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
指摘の文
「{matched}」は「{preferred}」と書きます
根拠にした文献
このページはルールの定義ファイルから作られています:packages/chaff/rules/preferred-term.yaml