remark-message-control
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatremark plugin to enable, disable, and ignore messages with comments.
Contents
* [`unified().use(remarkMessageControl, options)`](#unifieduseremarkmessagecontrol-options)
* [`Options`](#options)
What is this?
This package is a unified (remark) plugin that lets authors write comments in markdown to show and hide messages.When should I use this?
You can use this package when you’re building a linter such asremark-lint
remark-lint.
But you probably don’t need to, because remark-lint
already exists and it uses
this package.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install remark-message-control
In Deno with
esm.sh
esmsh:import remarkMessageControl from 'https://esm.sh/remark-message-control@8'
In browsers with
esm.sh
esmsh:<script type="module">
import remarkMessageControl from 'https://esm.sh/remark-message-control@8?bundle'
</script>
Use
Say we have the following fileexample.md
:<!--foo ignore-->
## Neptune
…and a module
example.js
:/**
* @typedef {import('mdast').Root} Root
*/
import {remark} from 'remark'
import remarkMessageControl from 'remark-message-control'
import {read} from 'to-vfile'
import {reporter} from 'vfile-reporter'
const file = await remark()
.use(function () {
/** @param {Root} tree */
return function (tree, file) {
file.message('Whoops!', {
place: tree.children[1]?.position,
ruleId: 'thing',
source: 'foo'
})
}
})
.use(remarkMessageControl, {name: 'foo'})
.process(await read('example.md'))
console.error(reporter(file))
…then running
node example.js
yields:example.md: no issues found
👉 Note: withoutremarkMessageControl
, we’d see:example.md 3:1-3:11 warning Whoops! thing foo ⚠ 1 warning
API
This package exports no identifiers. The default export isremarkMessageControl
api-remark-message-control.unified().use(remarkMessageControl, options)
Enable, disable, and ignore messages with comments.Parameters
options
(Options
api-options, required)
— configuration
Returns
Transform (Transformer
unified-transformer).Options
Configuration (TypeScript type).Fields
enable
(Array<string>
, optional)
— list of `ruleId`s to initially turn on;
used if `reset` is `true`
disable
(Array<string>
, optional)
— list of `ruleId`s to initially turn off;
used if `reset` is not `true`
known
(Array<string>
, optional)
— list of allowed `ruleId`s
name
(string
, required)
— name of markers that can control the message sources
reset
(boolean
, default:false
)
— whether to treat all messages as turned off initially
source
(Array<string>
orstring
, default:options.name
)
— [sources][vfile-message-fields] that can be controlled with markers
Syntax
This plugin looks for comments in markdown (MDX is also supported). If the first word in those comments does not matchoptions.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:
<!--lint disable list-item-bullet-indent strong-marker-->
* **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:
<!--lint enable strong-marker-->
**foo** and __bar__.
ignore
The ignore keyword turns off all messages of the given ruleId
s occurring
in the following node.
When without ruleId
s, 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:
<!--lint ignore list-item-bullet-indent strong-marker-->
* **foo**
* __bar__
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
api-options.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-message-control@^8
,
compatible with Node.js 16.This plugin works with
unified
version 6+ and remark
version 7+.Security
Use ofremark-message-control
does not involve rehype (hast)
or user content so there are no openings for cross-site scripting
(XSS)wiki-xss attacks.
Messages may be hidden from user content though, causing builds to fail or pass,
or changing a report.Related
— plugin to lint code style
— mdast utility to parse comment markers
Contribute
Seecontributing.md
contributing in remarkjs/.github
health for ways
to get started.
See support.md
support 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.