remark-lint-final-definition
remark-lint rule to warn when definitions are used in the document instead of at the end.
Contents
- What is this?
- When should I use this?
- Presets
- Install
- Use
- API
- Recommendation
- Examples
- Compatibility
- Contribute
- License
What is this?
This package checks where definitions are placed.
When should I use this?
You can use this package to check that definitions are consistently at the end of the document.
Presets
This plugin is included in the following presets:
| Preset | Options |
|---|---|
remark-preset-lint-markdown-style-guide |
Install
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-lint-final-definition
In Deno with esm.sh:
import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@3'
In browsers with esm.sh:
<script type="module">
import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@3?bundle'
</script>
Use
On the API:
import remarkLint from 'remark-lint'
import remarkLintFinalDefinition from 'remark-lint-final-definition'
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(remarkLintFinalDefinition)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint --use remark-lint-final-definition .
On the CLI in a config file (here a package.json):
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-final-definition",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScript types. The default export is remarkLintFinalDefinition.
unified().use(remarkLintFinalDefinition)
Warn when definitions are used in the document instead of at the end.
Parameters
There are no options.
Returns
Transform (Transformer from unified).
Recommendation
There are different strategies for placing definitions. The simplest is perhaps to place them all at the bottem of documents. If you prefer that, turn on this rule.
Examples
ok.md
In
Paragraph.
[example]: http://example.com "Example Domain"
Out
No messages.
not-ok.md
In
Paragraph.
[example]: http://example.com "Example Domain"
Another paragraph.
Out
3:1-3:47: Move definitions to the end of the file (after `5:19`)
ok-html-comments.md
In
Paragraph.
[example-1]: http://example.com/one/
<!-- Comments are fine between and after definitions. -->
[example-2]: http://example.com/two/
Out
No messages.
ok-mdx-comments.mdx
In
👉 Note: this example uses MDX (
remark-mdx).
Paragraph.
[example-1]: http://example.com/one/
{/* Comments are fine in MDX. */}
[example-2]: http://example.com/two/
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-final-definition@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.