ルールの一覧へ

言葉のリンクの中に URL がそのまま混ざっている

bare-url-mix既定で動く(情報)日本語 / 英語

言葉でリンクを書く文書の中に、「https://…」がそのまま書かれている所

例

指摘される文
導入は[導入の手引き](https://example.com/setup)に、設定は[設定の一覧](https://example.com/settings)にあります。 料金は[料金表](https://example.com/pricing)を見てください。問い合わせは https://example.com/contact から送れます。
chaff の出力
3:53 URL「https://example.com/contact」がそのまま書かれています(言葉のリンクが 3 個ある文書)
直した文
導入は[導入の手引き](https://example.com/setup)に、設定は[設定の一覧](https://example.com/settings)にあります。 料金は[料金表](https://example.com/pricing)を見てください。問い合わせは[問い合わせの窓口](https://example.com/contact)から送れます。
chaff の出力
指摘なし

直し方

行き先の名前を言葉にしてリンクにしてください([導入の手引き](https://…))。URL そのものを見せたいときは、山括弧で囲んでリンクにします(<https://…>)。

なぜ指摘するのか

文書のリンクがほとんど「[導入の手引き](https://…)」のように言葉で書かれているのに、一部だけ「https://…」がそのまま本文に出ていると、そこだけ読み手は長い記号の列を読まされ、行き先が何かを URL から推し量ることになります。言葉のリンクに揃っていない所は、書き直し忘れのことが多い形です。どちらの書き方が正しいかは決めません。URL をそのまま書く文書(言葉のリンクが少ない文書、URL のほうが多い文書)は指しません。

指摘しないもの

山括弧で囲んだ URL(<https://…>)、言葉が URL のリンク、コードと引用の中の URL、項目の値として行に一つだけ書いた URL(**ライセンス本文** https://…)、本文に書いたデータの例の値({"home":"https://…"})は指しません。参照の形のリンク([言葉][1])は言葉のリンクに数えません。言葉のリンクが指摘に要る数に届かない文書と、URL をそのまま書くほうが多い文書も指しません。

止める・ゆるめる

この一か所だけ黙らせる(文書に書く)
<!-- stet: bare-url-mix — 理由 -->
チームでゆるめる(理由は chaff.yaml にコメントで残ります)
npx chaffjs relax bare-url-mix --why "理由"
チームで止める(chaff.yaml)
rules: bare-url-mix: off
技術的な情報
層
L3
状態
安定
重さ
情報
対象の言語
日本語と英語
向いている文章
business, technical, blog, legal, docs, academic, literature, speech
文書から読み取るもの
markdown

強さ(段階)

chaff.yaml の rules にこの名前と段階を書くと変わります。書かなければ、ジャンルが決めた段階で動きます(どのジャンルで動くかは下の「ジャンルごとの動き」にあります)。

strict言葉のリンクが 2 個以上ある文書で指摘
normal言葉のリンクが 3 個以上ある文書で指摘
relaxed言葉のリンクが 5 個以上ある文書で指摘

ジャンルごとの動き

既定で動くジャンル
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

ジャンル

指摘の文

URL「{url}」がそのまま書かれています(言葉のリンクが {count} 個ある文書)

書き直しの深さ(chaff fix-plan --depth): light — 語と文を直す。構成と文体は残す

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