remark-message-control

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

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-message-control
707.1.1a year ago7 years agoMinified + gzip package size for remark-message-control in KB

Readme

remark-message-control
!Buildbuild-badgebuild !Coveragecoverage-badgecoverage !Downloadsdownloads-badgedownloads !Sizesize-badgesize !Sponsorssponsors-badgecollective !Backersbackers-badgecollective !Chatchat-badgechat
remark plugin to enable, disable, and ignore messages.

Contents

*   [`unified().use(remarkMessageControl, options)`](#unifieduseremarkmessagecontrol-options)

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-lintremark-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 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:
<!--foo ignore-->

## 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 '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:
<!--alpha ignore-->
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:
<!--alpha ignore charlie-->
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:
<!--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 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:
<!--lint ignore list-item-bullet-indent strong-marker-->

*   **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)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

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