All rules

A bare URL among worded links

bare-url-mixon by default (info)Japanese / English

A URL written bare in a document whose other links are words

Example

Flagged
Setup is in [the setup guide](https://example.com/setup), and the options are in [the settings list](https://example.com/settings). Prices are on [the pricing page](https://example.com/pricing). Send questions through https://example.com/contact today.
What chaff prints
3:87 The URL "https://example.com/contact" is written bare (3 worded links in this document)
Fixed
Setup is in [the setup guide](https://example.com/setup), and the options are in [the settings list](https://example.com/settings). Prices are on [the pricing page](https://example.com/pricing). Send questions through [the contact form](https://example.com/contact) today.
What chaff prints
no finding

How to fix

Make the target's name the link text ("[the setup guide](https://…)"). If the URL itself should show, wrap it in angle brackets ("<https://…>").

Why it matters

When a document's links are mostly words ("[the setup guide](https://…)"), a URL left bare in the text ("https://…") makes the reader read a string of symbols there and guess the target from it. A spot that does not match the worded links is usually one that was not rewritten. Neither style is called right; a document that writes its URLs bare (few worded links, or more bare URLs than worded ones) is not reported.

What it does not flag

A URL in angle brackets ("<https://…>"), a link whose text is the URL, URLs in code or quotations, a URL that is a field's value alone on its line ("**Licence text** https://…"), and one that is a value in an example payload written in the text (`{"home":"https://…"}`) are not reported; reference-style links ("[text][1]") are not counted as worded links; nor is a document with fewer worded links than the level needs, or one where bare URLs are not the few.

Turning it off or relaxing it

Silence this one spot (in the document)
<!-- stet: bare-url-mix — reason -->
Relax it for the team (the reason is kept as a comment in chaff.yaml)
npx chaffjs relax bare-url-mix --why "reason"
Turn it off for the team (chaff.yaml)
rules: bare-url-mix: off
Technical details
Layer
L3
Status
stable
Severity
info
Languages
Japanese and English
Suited to
business, technical, blog, legal, docs, academic, literature, speech
Reads from the document
markdown

Levels

Set a level for this rule under rules in chaff.yaml. With nothing set, it runs at the level its genre gives it (see By genre below).

strictreported in a document with 2 or more worded links
normalreported in a document with 3 or more worded links
relaxedreported in a document with 5 or more worded links

By genre

Runs by default in
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

Genres

Message

The URL "{url}" is written bare ({count} worded links in this document)

Rewrite depth (chaff fix-plan --depth): light — words and sentences; the structure and the voice stay

This page is built from the rule's definition file:packages/chaff/rules/bare-url-mix.yaml