Version 1.0.2

@stackline/remark-message-control

remark plugin to enable, disable, and ignore messages with remark

Independent maintenance of remark-message-control 7.1.1. Original authors and licenses are retained.

Installation

# Preserve existing imports with an npm alias
npm install remark-message-control@npm:@stackline/remark-message-control@1.0.2
# Or use the scoped package name in your imports
npm install @stackline/remark-message-control@1.0.2

Node.js: See compatibility notes. Read the compatibility and maintenance notes before migrating.

Usage and API

@stackline/remark-message-control

remark plugin to enable, disable, and ignore messages with remark.

Documentation | npm | Issues | Repository

Current package version: 1.0.2

Why this package?

@stackline/remark-message-control is the Stackline-maintained distribution of remark-message-control@7.1.1. It is an independent continuation of remark-message-control; original authors and licenses remain credited below.

Compatibility

Item	Value
Package	`@stackline/remark-message-control@1.0.2`
API target	`remark-message-control@7.1.1`
Supported Node.js	`See supported framework requirements`
License	`MIT`
Module type	`module`
Main entry	`index.js`
Types	`index.d.ts`
Runtime dependencies	`vfile, unified, @types/mdast, mdast-comment-marker, unified-message-control`

Installation

npm install @stackline/remark-message-control

Preserve existing imports and plugin resolution with an npm alias:

npm install remark-message-control@npm:@stackline/remark-message-control

Usage and API reference

remark-message-control

remark plugin to enable, disable, and ignore messages.

What is this?

This package is a unified (remark) plugin that lets authors write comments in markdown to show and hide messages.

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. remark plugins can inspect the tree and emit warnings and other messages. This is a remark plugin that gives authors the ability to configure those messages from markdown.

When should I use this?

You can use this package when you’re building a linter such as remark-lint. But you probably don’t need to, because remark-lint already exists and it uses 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-message-control

In Deno with Skypack:

import remarkMessageControl from 'https://cdn.skypack.dev/remark-message-control@7?dts'

In browsers with Skypack:

<script type="module">
  import remarkMessageControl from 'https://cdn.skypack.dev/remark-message-control@7?min'
</script>

Use

Say we have the following file example.md:



## Heading

And our module example.js looks as follows:

import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
import {remark} from 'remark'
import remarkMessageControl from '@stackline/remark-message-control'

main()

async function main() {
  const file = await remark()
    .use(() => (tree, file) => {
      file.message('Whoops!', tree.children[1], 'foo:thing')
    })
    .use(remarkMessageControl, {name: 'foo'})
    .process(await read('example.md'))

  console.error(reporter(file))
}

Now running node example.js yields:

example.md: no issues found

API

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

`unified().use(remarkMessageControl, options)`

Plugin to enable, disable, and ignore messages.

`options`

Configuration (required).

`options.name`

Name of markers that can control the message sources (string).

For example, {name: 'alpha'} controls alpha markers:

`options.known`

List of allowed ruleIds (Array<string>, optional). When given, a warning is shown when someone tries to control an unknown rule.

For example, {name: 'alpha', known: ['bravo']} results in a warning if charlie is configured:

`options.reset`

Whether to treat all messages as turned off initially (boolean, default: false).

`options.enable`

List of ruleIds to initially turn on if reset: true (Array<string>, optional). All rules are turned on by default (reset: false).

`options.disable`

List of ruleIds to turn on if reset: false (Array<string>, optional).

`options.sources`

Sources that can be controlled with name markers (string or Array<string>, default: options.name).

Syntax

This plugin looks for comments in markdown (MDX is also supported). If the first word in those comments does not match options.name, the comment is skipped. The second word is expected to be disable, enable, or ignore. Further words are rule identifiers of messages which are configurated.

In EBNF, the grammar looks as follows:

marker ::= identifier whitespace+ keyword ruleIdentifiers?
identifier ::= word+ /* restriction: must match `options.name` */
keyword ::= 'enable' | 'disable' | 'ignore'
ruleIdentifiers ::= word+ (whitespace+ word+)*
whitespace ::= ' ' | '\t' | '\r' | '\n' | '\f'
word ::= letter | digit | punctuation
letter ::= letterLowercase | letterUppercase
punctuation ::= '-' | '_'
letterLowercase ::= 'a' | 'b' | 'c' | 'd' | 'e' | 'f' | 'g' | 'h' | 'i' | 'j' | 'k' | 'l' | 'm' | 'n' | 'o' | 'p' | 'q' | 'r' | 's' | 't' | 'u' | 'v' | 'w' | 'x' | 'y' | 'z'
letterUppercase ::= 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P' | 'Q' | 'R' | 'S' | 'T' | 'U' | 'V' | 'W' | 'X' | 'Y' | 'Z'
digit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'

Which keyword is used defines how messages with those rule identifiers are handled:

`disable`

The disable keyword turns off all messages of the given rule identifiers. When without identifiers, all messages are turned off.

For example, to turn off certain messages:



*   **foo**

A paragraph, and now another list.

  * __bar__

`enable`

The enable keyword turns on all messages of the given rule identifiers. When without identifiers, all messages are turned on.

For example, to enable certain messages:



**foo** and __bar__.

`ignore`

The ignore keyword turns off all messages of the given ruleIds occurring in the following node. When without ruleIds, all messages are ignored.

Messages are turned on again after the end of the following node.

For example, to turn off certain messages for the next node:



*   **foo**
  * __bar__

Types

This package is fully typed with TypeScript. An extra Options type is exported which models the interface of the accepted options.

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.

This plugin works with unified version 6+ and remark version 7+.

Security

Use of remark-message-control does not involve rehype (hast) or user content so there are no openings for cross-site scripting (XSS) attacks. Messages may be hidden from user content though, causing builds to fail or pass, or changing a report.

remark-lint — plugin to lint code style
mdast-comment-marker — mdast utility to parse comment markers

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

Credits and original authors

Original project: remark-message-control.
Titus Wormer.
Christian Murphy.
Stackline maintenance: Alexandro Paixao Marques and Stackline contributors.

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

Community and Links

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

Upstream issues and maintenance review

Upstream and maintenance review

This package maintains remark-message-control@7.1.1 under the independent @stackline/remark-message-control name.

Source: https://github.com/remarkjs/remark-message-control/tree/f89206d9937fdf4e533fcbb08b91cac746171dd7
Public npm artifact integrity: sha512-xKRWl1NTBOKed0oEtCd8BUfH5m4s8WXxFFSoo7uUwx6GW/qdCy4zov5LfPyw7emantDmhfWn5PdIZgcbVcWMDQ==.
Upstream issue evidence checked: 2026-09-29T00:22:06.198565+00:00.
Original license and author notices are retained.
The upstream published runtime files and declarations are hash-checked in .stackline/upstream.json. Any runtime fix is explicitly listed there.
Functional upstream suites run against the source and extracted final package. Development tools were reduced to those used by validation; full source and runtime audits must pass.
Only direct dependencies of the original Stackline portfolio are in this migration. This is not a claim that all transitive projects are maintained by Stackline.

Issue triage

The queried open-issue list contained no issue entries. This does not establish that the upstream is abandoned or bug-free. No runtime bug fix is claimed for this initial maintenance release.

The evidence query fetched the latest 100 open and 30 closed issue/PR entries and removed PRs. Closed entries were collected for context; this report does not claim an exhaustive historic review.

Release discipline

The source commit, passing CI and CodeQL, reviewed CI tarball hash, npm provenance, normal and aliased installs, and immutable GitHub release are checked before a release is complete. Published versions and tags are never replaced.

Release changes

Changelog

1.0.0

Start Stackline maintenance of the documented upstream API.
Preserve and verify published runtime files and TypeScript declarations.
Run upstream functional suites against both source and the final package.
Publish the reviewed CI artifact through GitHub Actions with provenance and immutable release evidence.

Release files and references

Package bytes, npm provenance and the immutable GitHub release were verified for this version. Security checks describe the reviewed release; documented compatibility risks and upstream reports are not blanket claims of resolution.

@stackline/remark-message-control

Installation

Usage and API

@stackline/remark-message-control

Why this package?

Compatibility

Installation

Usage and API reference

remark-message-control

Contents

What is this?

When should I use this?

Install

Use

API

unified().use(remarkMessageControl, options)

options

options.name

options.known

options.reset

options.enable

options.disable

options.sources

Syntax

disable

enable

ignore

Types

Compatibility

Security

Related

Contribute

License

Credits and original authors

Community and Links

Upstream issues and maintenance review

Upstream and maintenance review

Issue triage

Release discipline

Release changes

Changelog

1.0.0

Release files and references

`unified().use(remarkMessageControl, options)`

`options`

`options.name`

`options.known`

`options.reset`

`options.enable`

`options.disable`

`options.sources`

`disable`

`enable`

`ignore`