remark-lint
!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-urlremarkgithub-remark plugin to support configuration comments for
remark-lint
github-remark-lint rules.Contents
unified().use(remarkLint)
What is this?
This plugin adds support for configuration comments to control remark lint rule messages.When should I use this?
This project is useful when you’re using remark lint rules and want to let authors ignore messages in certain cases. This package is already included in all our presets. If you’re building a preset yourself, you should include this package.Presets
This plugin is included in the following presets:| Preset | Options | | - | - | |
remark-preset-lint-consistent
| |
| remark-preset-lint-markdown-style-guide
| |
| remark-preset-lint-recommended
| |Install
This package is ESM onlygithub-gist-esm. In Node.js (version 16+), install with npmnpm-install:npm install remark-lint
In Deno with
esm.sh
esm-sh:import remarkLint from 'https://esm.sh/remark-lint@10'
In browsers with
esm.sh
esm-sh:<script type="module">
import remarkLint from 'https://esm.sh/remark-lint@10?bundle'
</script>
Use
On the API:import remarkLint from 'remark-lint'
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(remarkStringify)
.process(file)
console.error(reporter(file))
On the CLI:
remark --frail --use remark-lint .
On the CLI in a config file (here a
package.json
):…
"remarkConfig": {
"plugins": [
…
+ "remark-lint",
…
]
}
…
API
This package exports no identifiers. It exports no additional TypeScripttypescript types. The default export isremarkLint
api-remark-lint.unified().use(remarkLint)
Add support for configuration comments.See Ignore warningsmono-ignore in the monorepo readme for how to use it.
Returns
Transform (Transformer
from unified
github-unified-transformer).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@10
,
compatible with Node.js 16.Contribute
Seecontributing.md
github-dotfiles-contributing in remarkjs/.github
github-dotfiles-health for ways
to get started.
See support.md
github-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.