unified-message-control
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunified utility to enable, disable, and ignore messages.
Contents
* [`messageControl(tree, options)`](#messagecontroltree-options)
* [`Marker`](#marker)
* [`MarkerParser`](#markerparser)
* [`Options`](#options)
What is this?
This is a lego block that is meant to be extended, such as is done byremark-message-control
remark-message-control, so that lint messages can be
controlled from content.When should I use this?
You can use this if you’re building an ecosystem like remark for some different content type, and want to let authors control messages from that content.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unified-message-control
In Deno with
esm.sh
esmsh:import {messageControl} from 'https://esm.sh/unified-message-control@5'
In browsers with
esm.sh
esmsh:<script type="module">
import {messageControl} from 'https://esm.sh/unified-message-control@5?bundle'
</script>
Use
Say our documentexample.md
contains:<!--foo ignore-->
## Heading
…and our module
example.js
looks as follows:import {commentMarker} from 'mdast-comment-marker'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {messageControl} from 'unified-message-control'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkStringify)
.use(function () {
return function (tree, file) {
file.message('Whoops!', tree.children[1], 'foo:thing')
}
})
.use(messageControl, {
marker: commentMarker,
name: 'foo',
test: 'html'
})
.process(file)
console.error(reporter(file))
…now running
node example.js
yields:example.md: no issues found
API
This package exports no identifiers. It exports the identifiermessageControl
api-message-control.messageControl(tree, options)
Let comment markers control messages.Parameters
— tree
options
(Options
api-options)
— configuration (required)
Returns
Nothing (undefined
).Marker
Comment marker (TypeScript type).Notes
The disable keyword turns off messages. For example:<!--lint disable list-item-bullet-indent strong-marker-->
* **foo**
A paragraph, and now another list.
* __bar__
The enable keyword turns on messages. For example:
<!--lint enable strong-marker-->
**foo** and __bar__.
The ignore keyword turns off messages in the following node. After the end of the following node, messages are turned on again. For example:
<!--lint ignore list-item-bullet-indent strong-marker-->
* **foo**
* __bar__
Fields
name
(string
)
— name of marker
attributes
(string
)
— raw values (space-separated); the first should be `enable`, `disable`, or
`ignore`, the rest are optional rule identifiers
MarkerParser
Parse a possible comment marker (TypeScript type).Parameters
— potential marker
Returns
Marker
(Marker
marker, optional).Options
Configuration (TypeScript type).Notes
The givenname
defines which comments work.
Assuming there’s a marker
configured that parses HTML comments such as
<!--x y z-->
to a mark with name: 'x'
, then giving name: 'x'
will
use comments such as:<!--alpha ignore-->
When
known
is given, a warning is shown when unknown rules are controlled.
For example, {name: 'alpha', known: ['bravo']}
results in a warning (for
charlie
):<!--alpha ignore charlie-->
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
— corresponding file
marker
(MarkerParser
api-marker-parser, required)
— parse nodes to [`Marker`][api-marker] objects
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
test
(Test
unist-util-is-test, optional)
— test for possible markers
Types
This package is fully typed with TypeScript. It exports the additional typesMarker
api-marker,
MarkerParser
api-marker-parser, and
Options
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,
unified-message-control@^5
, compatible with Node.js 16.Contribute
Seecontributing.md
contributing in unifiedjs/.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.