unified

Project: remarkjs/remark-lint

Package: remark-lint-link-title-style@3.1.0

  1. Dependents: 17
  2. remark-lint rule to warn when link and definition titles occur with incorrect quotes
  1. remark 196
  2. lint 77
  3. rule 72
  4. remark-lint-rule 65
  5. link 15
  6. definition 15
  7. image 12
  8. style 10

remark-lint-link-title-style

Build Coverage Downloads Size Sponsors Backers Chat

Warn when link and definition titles occur with incorrect quotes.

Options: 'consistent', '"', '\'', or '()', default: 'consistent'.

'consistent' detects the first used quote style and warns when subsequent titles use different styles.

Fix

remark-stringify uses ' (single quote) for titles if they contain a double quote, and " (double quotes) otherwise.

See Using remark to fix your Markdown on how to automatically fix warnings for this rule.

Presets

This rule is included in the following presets:

PresetSetting
remark-preset-lint-consistent'consistent'
remark-preset-lint-markdown-style-guide'"'

Example

ok.md

When configured with '"'.

In
[Example](http://example.com#without-title)
[Example](http://example.com "Example Domain")
![Example](http://example.com "Example Domain")

[Example]: http://example.com "Example Domain"

You can use parens in URLs if they’re not a title (see GH-166):

[Example](#Heading-(optional))
Out

No messages.

not-ok.md

When configured with '"'.

In
[Example]: http://example.com 'Example Domain'
Out
1:31-1:47: Titles should use `"` as a quote
ok.md

When configured with "'".

In
[Example](http://example.com#without-title)
[Example](http://example.com 'Example Domain')
![Example](http://example.com 'Example Domain')

[Example]: http://example.com 'Example Domain'
Out

No messages.

not-ok.md

When configured with "'".

In
[Example]: http://example.com "Example Domain"
Out
1:31-1:47: Titles should use `'` as a quote
ok.md

When configured with '()'.

In
[Example](http://example.com#without-title)
[Example](http://example.com (Example Domain))
![Example](http://example.com (Example Domain))

[Example]: http://example.com (Example Domain)
Out

No messages.

not-ok.md

When configured with '()'.

In
[Example](http://example.com 'Example Domain')
Out
1:30-1:46: Titles should use `()` as a quote
not-ok.md
In
[Example](http://example.com "Example Domain")
[Example](http://example.com 'Example Domain')
Out
2:30-2:46: Titles should use `"` as a quote
not-ok.md

When configured with '💩'.

Out
1:1: Incorrect link title style marker `💩`: use either `'consistent'`, `'"'`, `'\''`, or `'()'`

Install

This package is ESM only: Node 12+ is needed to use it and it must be importeded instead of requiredd.

npm:

npm install remark-lint-link-title-style

This package exports no identifiers. The default export is remarkLintLinkTitleStyle.

Use

You probably want to use it on the CLI through a config file:

 …
 "remarkConfig": {
   "plugins": [
     …
     "lint",
+    "lint-link-title-style",
     …
   ]
 }
 …

Or use it on the CLI directly

remark -u lint -u lint-link-title-style readme.md

Or use this on the API:

 import {remark} from 'remark'
 import {reporter} from 'vfile-reporter'
 import remarkLint from 'remark-lint'
 import remarkLintLinkTitleStyle from 'remark-lint-link-title-style'

 remark()
   .use(remarkLint)
+  .use(remarkLintLinkTitleStyle)
   .process('_Emphasis_ and **importance**')
   .then((file) => {
     console.error(reporter(file))
   })

Contribute

See contributing.md in remarkjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer