remark-lint-final-definition
!Buildbadge-build-imagebadge-build-url
!Coveragebadge-coverage-imagebadge-coverage-url
!Downloadsbadge-downloads-imagebadge-downloads-url
!Sizebadge-size-imagebadge-size-url
!Sponsorsbadge-funding-sponsors-imagebadge-funding-url
!Backersbadge-funding-backers-imagebadge-funding-url
!Chatbadge-chat-imagebadge-chat-urlremark-lintgithub-remark-lint rule to warn when definitions are used in the
document instead of at the end.Contents
unified().use(remarkLintFinalDefinition)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 onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint-final-definitionIn Deno with
esm.shesm-sh:import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@4'In browsers with
esm.shesm-sh:<script type="module">
import remarkLintFinalDefinition from 'https://esm.sh/remark-lint-final-definition@4?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 TypeScripttypescript types. The default export isremarkLintFinalDefinitionapi-remark-lint-final-definition.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 unifiedgithub-unified-transformer).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
Mercury.Out
No messages.ok.md
In
Out
No messages.ok-html-comments.md
In
Mercury.
<!-- HTML comments in markdown are ignored. -->Out
No messages.ok-mdx-comments.mdx
In
👉 Note: this example uses
MDX (remark-mdxgithub-remark-mdx).Mercury.
{/* Comments in expressions in MDX are ignored. */}Out
No messages.not-ok.md
In
Mercury.
Earth.Out
3:1-3:36: Unexpected definition before last content, expected definitions after line `5`gfm-nok.md
In
👉 Note: this example uses
GFM (remark-gfmgithub-remark-gfm).Mercury.
the Sun.
Earth.Out
3:1-5:13: Unexpected footnote definition before last content, expected definitions after line `7`gfm-ok.md
In
👉 Note: this example uses
GFM (remark-gfmgithub-remark-gfm).Mercury.
Earth.
the Sun.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@4,
compatible with Node.js 16.Contribute
Seecontributing.mdgithub-dotfiles-contributing in remarkjs/.githubgithub-dotfiles-health for ways
to get started.
See support.mdgithub-dotfiles-support for ways to get help.This project has a code of conductgithub-dotfiles-coc. By interacting with this repository, organization, or community you agree to abide by its terms.
