ページに無い関数をコード例で呼んでいる

undefined-function-call既定で動く日本語 / 英語

コード例が、ページで説明している関数と違う、どこにも無い名前の関数を呼んでいる所

例

指摘される文

## wrap 文章を決まった幅で折り返します。 ```js const lines = wrapText("折り返したい長い文です。", 10); ```

chaff の出力

6:15 「wrapText」を呼んでいますが、このページが説明しているのは「wrap」です

直した文

## wrap 文章を決まった幅で折り返します。 ```js const lines = wrap("折り返したい長い文です。", 10); ```

chaff の出力

指摘なし

この例で使った chaff.yaml

genre: technical/readme

直し方

例の関数の名前を、説明している関数の名前に直してください。別の関数なら、その関数をページで説明してください。

なぜ指摘するのか

API リファレンスや README が「wrap」を説明しているのに、例が「wrapText(...)」を呼んでいると、読み手が例を写したとたんに「関数がありません」で止まります。関数の名前を変えたあとに例だけ古い名前のまま残ったときや、書き間違えたときに起きます。見出しの最初の語（## wrap）と import した名前を、このページが説明する関数として読み、コードブロックの中で、その名前を頭に持つより長い名前を呼んでいて、その名前がページのほかのどこにも無いときに指します。

指摘しないもの

宣言（function wrapText(）、コメントの中の呼び出し、プログラミング言語が用意する関数（parseInt、語彙表 code-global）、ページのほかの所にも出てくる名前（例の中で定義した関数、二度呼んだ関数、文で説明した関数）、メンバーの呼び出し（console.log(、obj.wrapText(）、説明している名前で始まらない名前、4 文字より短い名前を頭に持つものは見ません。

止める・ゆるめる

この一か所だけ黙らせる（文書に書く）

チームでゆるめる（理由は chaff.yaml にコメントで残ります）

npx chaffjs relax undefined-function-call --why "理由"

チームで止める（chaff.yaml）

rules: undefined-function-call: off

技術的な情報

層: 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}」を呼んでいますが、このページが説明しているのは「{documented}」です

このページはルールの定義ファイルから作られています:packages/chaff/rules/undefined-function-call.yaml