.. | ||
.npmrc | ||
index.js | ||
package.json | ||
readme.md | ||
tsconfig.json |
remark-lint-link-title-style
remark-lint
rule to warn when link title markers violate a given style.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Fix
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks the style of link (and image and definition) title markers.
When should I use this?
You can use this package to check that the style of link title markers is consistent.
Presets
This plugin is included in the following presets:
Preset | Options |
---|---|
remark-preset-lint-consistent |
'consistent' |
remark-preset-lint-markdown-style-guide |
'"' |
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-link-title-style
In Deno with esm.sh
:
import remarkLintLinkTitleStyle from 'https://esm.sh/remark-lint-link-title-style@3'
In browsers with esm.sh
:
<script type="module">
import remarkLintLinkTitleStyle from 'https://esm.sh/remark-lint-link-title-style@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintLinkTitleStyle from 'remark-lint-link-title-style'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintLinkTitleStyle)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-link-title-style .
On the CLI in a config file (here a package.json
):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-link-title-style",
…
]
}
…
API
This package exports no identifiers.
It exports the TypeScript types
Options
and
Style
.
The default export is
remarkLintLinkTitleStyle
.
unified().use(remarkLintLinkTitleStyle[, options])
Warn when link title markers violate a given style.
Parameters
options
(Options
, default:'consistent'
) — preferred style or whether to detect the first style and warn for further differences
Returns
Transform (Transformer
from unified
).
Options
Configuration (TypeScript type).
Type
type Options = Style | 'consistent'
Style
Style (TypeScript type).
Type
type Style = '"' | '\'' | '()'
Recommendation
Before CommonMark, parens for titles were not supported in markdown.
They should now work in most places.
Parens do look a bit weird as they’re inside more parens:
[text](url (title))
.
In HTML, attributes are commonly written with double quotes.
Due to this, titles are almost exclusively wrapped in double quotes in
markdown, so it’s recommended to configure this rule with '"'
.
Fix
remark-stringify
formats titles with double
quotes by default.
Pass quote: "'"
to use single quotes.
There is no option to use parens.
Examples
ok-consistent.md
In
[Mercury](http://example.com/mercury/),
[Venus](http://example.com/venus/ "Go to Venus"), and
![Earth](http://example.com/earth/ "Go to Earth").
[Mars]: http://example.com/mars/ "Go to Mars"
Out
No messages.
not-ok-consistent.md
In
[Mercury](http://example.com/mercury/ "Go to Mercury") and
![Venus](http://example.com/venus/ 'Go to Venus').
[Earth]: http://example.com/earth/ (Go to Earth)
Out
2:1-2:50: Unexpected title markers `'`, expected `"`
4:1-4:49: Unexpected title markers `'('` and `')'`, expected `"`
ok-double.md
When configured with '"'
.
In
[Mercury](http://example.com/mercury/ "Go to Mercury").
Out
No messages.
not-ok-double.md
When configured with '"'
.
In
[Mercury](http://example.com/mercury/ 'Go to Mercury').
Out
1:1-1:55: Unexpected title markers `'`, expected `"`
ok-single.md
When configured with "'"
.
In
[Mercury](http://example.com/mercury/ 'Go to Mercury').
Out
No messages.
not-ok-single.md
When configured with "'"
.
In
[Mercury](http://example.com/mercury/ "Go to Mercury").
Out
1:1-1:55: Unexpected title markers `"`, expected `'`
ok-paren.md
When configured with '()'
.
In
[Mercury](http://example.com/mercury/ (Go to Mercury)).
Out
No messages.
not-ok-paren.md
When configured with '()'
.
In
[Mercury](http://example.com/mercury/ "Go to Mercury").
Out
1:1-1:55: Unexpected title markers `"`, expected `'('` and `')'`
not-ok.md
When configured with '🌍'
.
Out
1:1: Unexpected value `🌍` for `options`, expected `'"'`, `"'"`, `'()'`, or `'consistent'`
ok-parens-in-url.md
When configured with '"'
.
In
Parens in URLs work correctly:
[Mercury](http://example.com/(mercury) "Go to Mercury") and
[Venus](http://example.com/(venus)).
Out
No messages.
ok-whitespace.md
When configured with '"'
.
In
Trailing whitespace works correctly:
[Mercury](http://example.com/mercury/␠"Go to Mercury"␠).
Out
No messages.
Compatibility
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-link-title-style@3
,
compatible with Node.js 12.
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.