` or `string`, default: `options.name`)\n — [sources][vfile-message-fields] that can be controlled with markers\n\n\n\n\n\n## Syntax\n\nThis plugin looks for comments in markdown (MDX is also supported).\nIf the first word in those comments does not match `options.name`, the comment\nis skipped.\nThe second word is expected to be `disable`, `enable`, or `ignore`.\nFurther words are rule identifiers of messages which are configurated.\n\nIn EBNF, the grammar looks as follows:\n\nmarker ::= identifier whitespace+ keyword ruleIdentifiers?\nidentifier ::= word+ /* restriction: must match `options.name` */\nkeyword ::= 'enable' | 'disable' | 'ignore'\nruleIdentifiers ::= word+ (whitespace+ word+)*\nwhitespace ::= ' ' | '\\t' | '\\r' | '\\n' | '\\f'\nword ::= letter | digit | punctuation\nletter ::= letterLowercase | letterUppercase\npunctuation ::= '-' | '_'\nletterLowercase ::= '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'\nletterUppercase ::= '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'\ndigit ::= '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9'\n
\n\nWhich keyword is used defines how messages with those rule identifiers are\nhandled:\n\n###### `disable`\n\nThe **disable** keyword turns off all messages of the given rule identifiers.\nWhen without identifiers, all messages are turned off.\n\nFor example, to turn off certain messages:\n\n```markdown\n\n\n* **foo**\n\nA paragraph, and now another list.\n\n * __bar__\n```\n\n###### `enable`\n\nThe **enable** keyword turns on all messages of the given rule identifiers.\nWhen without identifiers, all messages are turned on.\n\nFor example, to enable certain messages:\n\n```markdown\n\n\n**foo** and __bar__.\n```\n\n###### `ignore`\n\nThe **ignore** keyword turns off all messages of the given `ruleId`s occurring\nin the following node.\nWhen without `ruleId`s, all messages are ignored.\n\nMessages are turned on again after the end of the following node.\n\nFor example, to turn off certain messages for the next node:\n\n```markdown\n\n\n* **foo**\n * __bar__\n```\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports the additional type [`Options`][api-options].\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line, `remark-message-control@^8`,\ncompatible with Node.js 16.\n\nThis plugin works with `unified` version 6+ and `remark` version 7+.\n\n## Security\n\nUse of `remark-message-control` does not involve **[rehype][]** (**[hast][]**)\nor user content so there are no openings for [cross-site scripting\n(XSS)][wiki-xss] attacks.\nMessages may be hidden from user content though, causing builds to fail or pass,\nor changing a report.\n\n## Related\n\n* [`remark-lint`][remark-lint]\n — plugin to lint code style\n* [`mdast-comment-marker`](https://github.com/syntax-tree/mdast-comment-marker)\n — mdast utility to parse comment markers\n\n## Contribute\n\nSee [`contributing.md`][contributing] in [`remarkjs/.github`][health] for ways\nto get started.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\n\n[build-badge]: https://github.com/remarkjs/remark-message-control/workflows/main/badge.svg\n\n[build]: https://github.com/remarkjs/remark-message-control/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/remarkjs/remark-message-control.svg\n\n[coverage]: https://codecov.io/github/remarkjs/remark-message-control\n\n[downloads-badge]: https://img.shields.io/npm/dm/remark-message-control.svg\n\n[downloads]: https://www.npmjs.com/package/remark-message-control\n\n[size-badge]: https://img.shields.io/bundlejs/size/remark-message-control\n\n[size]: https://bundlejs.com/?q=remark-message-control\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/remarkjs/remark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[esmsh]: https://esm.sh\n\n[health]: https://github.com/remarkjs/.github\n\n[contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md\n\n[support]: https://github.com/remarkjs/.github/blob/main/support.md\n\n[coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[hast]: https://github.com/syntax-tree/hast\n\n[rehype]: https://github.com/rehypejs/rehype\n\n[remark]: https://github.com/remarkjs/remark\n\n[remark-lint]: https://github.com/remarkjs/remark-lint\n\n[typescript]: https://www.typescriptlang.org\n\n[unified]: https://github.com/unifiedjs/unified\n\n[unified-transformer]: https://github.com/unifiedjs/unified#transformer\n\n[vfile-message-fields]: https://github.com/vfile/vfile-message#fields\n\n[wiki-xss]: https://en.wikipedia.org/wiki/Cross-site_scripting\n\n[api-options]: #options\n\n[api-remark-message-control]: #unifieduseremarkmessagecontrol-options\n","_attachments":{},"homepage":"https://github.com/remarkjs/remark-message-control#readme","bugs":{"url":"https://github.com/remarkjs/remark-message-control/issues"},"license":"MIT"}