diff --git a/index.js b/index.js index a35d56d..955b535 100644 --- a/index.js +++ b/index.js @@ -19,6 +19,7 @@ var VFile = require('vfile'); var remark = require('remark'); var retext = require('retext'); +var control = require('remark-message-control'); var english = require('retext-english'); var equality = require('retext-equality'); var remark2retext = require('remark-retext'); @@ -29,7 +30,10 @@ var sort = require('vfile-sort'); */ var text = retext().use(english).use(equality); -var markdown = remark().use(remark2retext, text); +var markdown = remark().use(remark2retext, text).use(control, { + 'name': 'alex', + 'source': 'retext-equality' +}); /** * Wrap the given processor. diff --git a/package.json b/package.json index 9af8360..0d45033 100644 --- a/package.json +++ b/package.json @@ -41,9 +41,10 @@ "get-stdin": "^5.0.0", "glob": "^6.0.1", "globby": "^4.0.0", - "remark": "^3.0.0", "meow": "^3.3.0", "minimatch": "^3.0.0", + "remark": "^3.0.0", + "remark-message-control": "^1.0.1", "remark-retext": "^1.1.0", "retext": "^1.0.0", "retext-english": "^1.0.0", diff --git a/readme.md b/readme.md index bfaeb98..47c5bb9 100644 --- a/readme.md +++ b/readme.md @@ -55,6 +55,8 @@ $ npm install alex --global * [.alexignore](#alexignore) +* [Ignoring messages](#ignoring-messages) + * [Workflow](#workflow) * [FAQ](#faq) @@ -219,6 +221,75 @@ components/ example.md ``` +## Ignoring messages + +Sometimes, **alex** makes mistakes: + +```md +A window will pop up. +``` + +Yields: + +```txt +readme.md + 1:15-1:18 warning `pop` may be insensitive, use `parent` instead dad-mom + +⚠ 1 warning +``` + +**alex** can silence message through HTML comments in markdown: + +```md + + +A window will **not** pop up. +``` + +Yields: + +```txt +readme.md: no issues found +``` + +`ignore` turns off messages for the thing after the comment (in this +case, the paragraph). +It’s also possible to turn off messages after a comment by using +`disable`, and, turn those messages back on using `enable`: + +```md + + +A window will **not** pop up. + +A window will **not** pop up. + + + +A window will pop up. +``` + +Yields: + +```txt +readme.md + 9:15-9:18 warning `pop` may be insensitive, use `parent` instead dad-mom + +⚠ 1 warning +``` + +Multiple messages can be controlled in one go: + +```md + +``` + +...and all messages can be controlled by omitting all rule identifiers: + +```md + +``` + ## Workflow The recommended workflow is to add **alex** locally and to run it with your