remark-lint

remark plugin to lint Markdown code style

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-lint
851169.1.1a year ago7 years agoMinified + gzip package size for remark-lint in KB

Readme

!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
remark plugin to support configuration comments for remark lint rules.
See the monorepo readme
mono for more info on remark lint.

Contents

*   [`unified().use(remarkLint)`](#unifieduseremarklint)

What is this?

This package is a unified (remark) plugin to add 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.

Install

This package is ESM onlyesm. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:
npm install remark-lint

In Deno with Skypack:
import remarkLint from 'https://cdn.skypack.dev/remark-lint@9?dts'

In browsers with Skypack:
<script type="module">
  import remarkLint from 'https://cdn.skypack.dev/remark-lint@9?min'
</script>

Use

On the API:
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkLint from 'remark-lint'

main()

async function main() {
  const file = await remark()
    .use(remarkLint)
    .process(await read('example.md'))

  console.error(reporter(file))
}

On the CLI:
remark --use remark-lint example.md

On the CLI in a config file (here a package.json):
…
"remarkConfig": {
  "plugins": [
    …
+    "remark-lint",
    …
  ]
}
…

API

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

unified().use(remarkLint)

Add support for configuration comments. There are no options.
See Ignore warningsignore in the monorepo readme for how to use it.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.mdcontributing in remarkjs/.githubhealth for ways to get started. See support.mdsupport for ways to get help.
This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MITlicense © Titus Wormerauthor