Support ignoring blocks by special comments (#78)

Co-authored-by: Sindre Sorhus <[email protected]>

Author: chinesedfan

readme.md

@@ -38,6 +38,59 @@ $ npm install --global awesome-lint
   3 errors
 ```
 
+### Special comments
+
+You can enable, disable, and ignore rules using special comments. This is based on [remark-message-control](https://github.com/remarkjs/remark-message-control#markers).
+
+By default, all rules are turned on. For example, 4 errors (2 of `no-dead-urls` and 2 of `awesome-list-item`) will be generated for following code snippets.
+
+```md
+- [foo](https://foo.com) - an invalid description.
+- [foo](https://foo.com) - invalid description.
+```
+
+###### `disable`
+
+The `disable` keyword turns off all messages of the given rule identifiers. If no identifiers are specified, all messages are turned off.
+
+**Don't leave spaces after the last rule identifier.**
+
+For example, only the 2 `no-dead-urls` errors are left:
+
+```md
+<!--lint disable awesome-list-item-->
+- [foo](https://foo.com) - an invalid description.
+- [foo](https://foo.com) - invalid description.
+```
+
+###### `enable`
+
+The `enable` keyword turns on all messages of the given rule identifiers. If no identifiers are specified, all messages are turned on.
+
+For example, only the second line reports a `awesome-list-item` rule violation:
+
+```md
+<!--lint disable awesome-list-item-->
+- [foo](https://foo.com) - an invalid description.
+<!--lint enable awesome-list-item-->
+- [foo](https://foo.com) - invalid description.
+```
+
+###### `ignore`
+
+The `ignore` keyword turns off all messages of the given rule identifiers occurring in the following node. If no identifiers are specified, all messages are turned ignored. After the end of the following node, messages are turned on again. This is the main difference with `disable`.
+
+For example, to turn off certain messages for the next node:
+
+```md
+<!--lint ignore awesome-list-item-->
+- [foo](https://foo.com) - an invalid description.
+
+List items share the same parent node. So let's create a new list.
+
+- [foo](https://foo.com) - invalid description.
+```
+
 ### Tip
 
 Add it as a `test` script in package.json and activate Travis CI to lint on new commits and pull requests.

rules/badge.js

@@ -16,7 +16,7 @@ const badgeSrcUrlWhitelist = new Set([
 const isValidBadgeUrl = url => badgeUrlWhitelist.has(url);
 const isValidBadgeSrcUrl = url => badgeSrcUrlWhitelist.has(url);
 
-module.exports = rule('remark-lint:awesome/badge', (ast, file) => {
+module.exports = rule('remark-lint:awesome-badge', (ast, file) => {
 	visit(ast, 'heading', (node, index) => {
 		if (index > 0) {
 			return;

rules/code-of-conduct.js

@@ -6,7 +6,7 @@ const findAuthorName = require('../lib/find-author-name');
 const authorName = 'sindresorhus';
 const authorEmail = '[email protected]';
 
-module.exports = rule('remark-lint:awesome/code-of-conduct', (ast, file) => {
+module.exports = rule('remark-lint:awesome-code-of-conduct', (ast, file) => {
 	if (ast.children.length === 0) {
 		file.message('code-of-conduct.md file must not be empty');
 		return;

rules/contributing.js

@@ -4,7 +4,7 @@ const path = require('path');
 const globby = require('globby');
 const rule = require('unified-lint-rule');
 
-module.exports = rule('remark-lint:awesome/contributing', (ast, file) => {
+module.exports = rule('remark-lint:awesome-contributing', (ast, file) => {
 	const {dirname} = file;
 
 	const contributingFile = globby.sync(['contributing.md', 'CONTRIBUTING.md'], {cwd: dirname})[0];

rules/git-repo-age.js

@@ -7,7 +7,7 @@ const oneDay = 24 * 60 * 60 * 1000;
 const minGitRepoAgeDays = 30;
 const minGitRepoAgeMs = minGitRepoAgeDays * oneDay;
 
-module.exports = rule('remark-lint:awesome/git-repo-age', async (ast, file) => {
+module.exports = rule('remark-lint:awesome-git-repo-age', async (ast, file) => {
 	const {dirname} = file;
 
 	try {

rules/github.js

@@ -4,7 +4,7 @@ const got = require('got');
 const gh = require('github-url-to-object');
 const rule = require('unified-lint-rule');
 
-module.exports = rule('remark-lint:awesome/github', async (ast, file) => {
+module.exports = rule('remark-lint:awesome-github', async (ast, file) => {
 	const {dirname} = file;
 
 	try {

rules/heading.js

@@ -8,7 +8,7 @@ const listHeadingCaseWhitelist = new Set([
 	'capital'
 ]);
 
-module.exports = rule('remark-lint:awesome/heading', (ast, file) => {
+module.exports = rule('remark-lint:awesome-heading', (ast, file) => {
 	let headings = 0;
 
 	visit(ast, (node, index) => {

rules/license.js

@@ -5,7 +5,7 @@ const rule = require('unified-lint-rule');
 const toString = require('mdast-util-to-string');
 const visit = require('unist-util-visit');
 
-module.exports = rule('remark-lint:awesome/license', (ast, file) => {
+module.exports = rule('remark-lint:awesome-license', (ast, file) => {
 	const license = find(ast, node => (
 		node.type === 'heading' &&
 		(toString(node) === 'Licence' || toString(node) === 'License')

rules/list-item.js

@@ -47,7 +47,7 @@ const listItemDescriptionSuffixNodeWhitelist = new Set([
 	'text'
 ]);
 
-module.exports = rule('remark-lint:awesome/list-item', (ast, file) => {
+module.exports = rule('remark-lint:awesome-list-item', (ast, file) => {
 	let lists = findAllLists(ast);
 
 	const toc = find(ast, node => (

rules/no-ci-badge.js

@@ -2,7 +2,7 @@
 const rule = require('unified-lint-rule');
 const visit = require('unist-util-visit');
 
-module.exports = rule('remark-lint:awesome/no-ci-badge', (ast, file) => {
+module.exports = rule('remark-lint:awesome-no-ci-badge', (ast, file) => {
 	visit(ast, 'image', node => {
 		if (/build status|travis|circleci/i.test(node.title)) {
 			file.message('Readme must not contain CI badge', node);