1. remark-lint
remark plugin to lint Markdown code style
remark-lint
Package: remark-lint
Created by: remarkjs
Last modified: Mon, 20 Nov 2023 10:43:06 GMT
Version: 9.1.2
License: MIT
Downloads: 543,081
Repository: https://github.com/remarkjs/remark-lint

Install

npm install remark-lint
yarn add remark-lint

remark-lint

Build
Coverage
Downloads
Size
Sponsors
Backers
Chat

remark plugin to support configuration comments for remark lint rules.

See the monorepo readme for more info on remark lint.

Contents

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 only.
In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

 npm install remark-lint

In Deno with esm.sh:

 import remarkLint from 'https://esm.sh/remark-lint@9'

In browsers with esm.sh:

 <script type="module">
  import remarkLint from 'https://esm.sh/remark-lint@9?build'
</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 warnings 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.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.

License

MIT © Titus Wormer

RELATED POST

10 Must-Know Windows Shortcuts That Will Save You Time

10 Must-Know Windows Shortcuts That Will Save You Time

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Arrays vs Linked Lists: Which is Better for Memory Management in Data Structures?

Navigating AWS Networking: Essential Hacks for Smooth Operation

Navigating AWS Networking: Essential Hacks for Smooth Operation

Achieving Stunning Visuals with Unity's Global Illumination

Achieving Stunning Visuals with Unity's Global Illumination

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code

Nim's Hidden Gems: Lesser-known Features for Writing Efficient Code