Skip to documentation
ALEXANDRONET

package

@stackline/remark-lint 1.0.2 — installation and API

remark plugin to lint Markdown code style

Install @stackline/remark-lint

npm install @stackline/[email protected]

Package version: 1.0.2. Metadata verified: 2026-11-12. This is separate from the framework version and demonstration runtime.

Node.js requirement
{}
Accepted peer dependencies (declared ranges)
{}

Tested environments are described in the versioned README and linked source checks. A declared peer range is not evidence that every version in it was tested.

Versioned reference

This reference comes from the published @stackline/[email protected] README. Its upstream attribution and license remain with the source. Benchmark and security statements describe the cited tests and advisories, not a guarantee for every application.

@stackline/remark-lint

remark plugin to lint Markdown code style.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/remark-lint is the Stackline-maintained distribution of [email protected]. It is an independent continuation of remark-lint; original authors and licenses remain credited below.

Compatibility

Item Value
Package @stackline/[email protected]
API target [email protected]
Supported Node.js See supported framework requirements
License MIT
Module type module
Main entry index.js
Types index.d.ts
Runtime dependencies unified, @types/mdast, remark-message-control

Installation

npm install @stackline/remark-lint

Preserve existing imports and plugin resolution with an npm alias:

npm install remark-lint@npm:@stackline/remark-lint

Usage and API reference

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 @stackline/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 '@stackline/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": [
     …
+    "@stackline/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

Credits and original authors

Original copyright, license notices and contributor acknowledgements remain part of this distribution. Stackline maintenance does not replace authorship of the original work.

Use this repository's issue tracker for reproducible bugs and feature requests. Join r/Stackline for examples, usage questions and release discussions.