Skip to content

Support ignoring blocks by special comments #78

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Nov 13, 2019
Merged

Support ignoring blocks by special comments #78

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
c91b931
Rename ruleIds with colons
chinesedfan May 13, 2019
86e5280
Connected by dash
chinesedfan May 13, 2019
6c974d4
Add test
chinesedfan May 13, 2019
f3f2464
Update tests
chinesedfan May 13, 2019
e8fb9e8
Update test/fixtures/list-item/4.md
chinesedfan Jun 16, 2019
96bf4fb
Merge branch 'master' into support-ignore
chinesedfan Jun 16, 2019
9fb715a
Mention in readme
chinesedfan Jun 16, 2019
b07ec24
Update for the new heading rule
chinesedfan Jun 16, 2019
119765f
Fix tests
chinesedfan Jun 16, 2019
f713eed
Replace with markers section
chinesedfan Jun 21, 2019
ef38f57
Better tests and docs
chinesedfan Jul 4, 2019
3dadcb0
Merge branch 'master' into support-ignore
sindresorhus Nov 12, 2019
bac8346
Update list-item.js
sindresorhus Nov 12, 2019
70a168c
Update readme.md
sindresorhus Nov 12, 2019
15608f3
Change the new coc rule with dash and update snapshots
chinesedfan Nov 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Intended to make it easier to create and maintain Awesome lists.

Includes a bunch of [general Markdown rules](https://github.com/sindresorhus/awesome-lint/blob/master/config.js) and some [Awesome specific rules](https://github.com/sindresorhus/awesome-lint/tree/master/rules).

Supports to enable, disable, and ignore rules by special comments, with the help of [remark-message-control](https://github.com/remarkjs/remark-message-control).

![](media/screenshot.png)


Expand Down
2 changes: 1 addition & 1 deletion rules/badge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
2 changes: 1 addition & 1 deletion rules/contributing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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];
Expand Down
2 changes: 1 addition & 1 deletion rules/git-repo-age.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion rules/github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion rules/license.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
2 changes: 1 addition & 1 deletion rules/list-item.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 => (
Expand Down
2 changes: 1 addition & 1 deletion rules/no-ci-badge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion rules/spell-check.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ const wordBreakCharacterWhitelist = new Set([
'-'
]);

module.exports = rule('remark-lint:awesome/spell-check', (ast, file) => {
module.exports = rule('remark-lint:awesome-spell-check', (ast, file) => {
visit(ast, 'text', node => {
if (!node.value) {
return;
Expand Down
2 changes: 1 addition & 1 deletion rules/toc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ const sectionHeadingBlacklist = new Set([
'License'
]);

module.exports = rule('remark-lint:awesome/toc', (ast, file) => {
module.exports = rule('remark-lint:awesome-toc', (ast, file) => {
slugger.reset();

// Heading links are order-dependent, so it's important to gather them up front
Expand Down
2 changes: 2 additions & 0 deletions test/fixtures/list-item/4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!--lint disable awesome-list-item -->
- [foo](https://foo.com) - an invalid description.
6 changes: 3 additions & 3 deletions test/rules/badge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ test('badge - missing', async t => {
const messages = await lint({config, filename: 'test/fixtures/badge/error0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/badge',
ruleId: 'awesome-badge',
message: 'Missing Awesome badge after the main heading'
}
]);
Expand All @@ -22,7 +22,7 @@ test('badge - incorrect source', async t => {
const messages = await lint({config, filename: 'test/fixtures/badge/error1.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/badge',
ruleId: 'awesome-badge',
message: 'Invalid badge source'
}
]);
Expand All @@ -32,7 +32,7 @@ test('badge - incorrect source raw git', async t => {
const messages = await lint({config, filename: 'test/fixtures/badge/error2.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/badge',
ruleId: 'awesome-badge',
message: 'Invalid badge source'
}
]);
Expand Down
4 changes: 2 additions & 2 deletions test/rules/contributing.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ test('contributing - missing', async t => {
const messages = await lint({config, filename: 'test/fixtures/contributing/error0/readme.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/contributing',
ruleId: 'awesome-contributing',
message: 'Missing file contributing.md'
}
]);
Expand All @@ -21,7 +21,7 @@ test('contributing - empty', async t => {
const messages = await lint({config, filename: 'test/fixtures/contributing/error1/readme.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/contributing',
ruleId: 'awesome-contributing',
message: 'contributing.md file must not be empty'
}
]);
Expand Down
4 changes: 2 additions & 2 deletions test/rules/git-repo-age.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ test.serial('git-repo-age - error invalid git repo', async t => {
const messages = await lint({config, filename: 'test/fixtures/git-repo-age/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/git-repo-age',
ruleId: 'awesome-git-repo-age',
message: 'Awesome list must reside in a valid deep-cloned Git repository (see https://github.com/sindresorhus/awesome-lint#tip for more information)'
}
]);
Expand All @@ -49,7 +49,7 @@ test.serial('git-repo-age - error repo is not old enough', async t => {
const messages = await lint({config, filename: 'test/fixtures/git-repo-age/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/git-repo-age',
ruleId: 'awesome-git-repo-age',
message: 'Git repository must be at least 30 days old'
}
]);
Expand Down
12 changes: 6 additions & 6 deletions test/rules/github.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ test.serial('github - error invalid git repo', async t => {
const messages = await lint({config, filename: 'test/fixtures/github/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'Awesome list must reside in a valid git repository'
}
]);
Expand All @@ -56,10 +56,10 @@ test.serial('github - repo without description and license', async t => {
const messages = await lint({config, filename: 'test/fixtures/github/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'The repository should have a description'
}, {
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'License was not detected by GitHub'
}
]);
Expand Down Expand Up @@ -88,7 +88,7 @@ test.serial('github - missing topic awesome-list', async t => {
const messages = await lint({config, filename: 'test/fixtures/github/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'The repository should have "awesome-list" as a GitHub topic'
}
]);
Expand Down Expand Up @@ -117,7 +117,7 @@ test.serial('github - missing topic awesome', async t => {
const messages = await lint({config, filename: 'test/fixtures/github/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'The repository should have "awesome" as a GitHub topic'
}
]);
Expand All @@ -133,7 +133,7 @@ test.serial('github - remote origin is an GitLab repo', async t => {
const messages = await lint({config, filename: 'test/fixtures/github/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/github',
ruleId: 'awesome-github',
message: 'Repository should be on GitHub'
}
]);
Expand Down
10 changes: 5 additions & 5 deletions test/rules/license.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ test('license - missing', async t => {
const messages = await lint({config, filename: 'test/fixtures/license/error0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/license',
ruleId: 'awesome-license',
message: 'Missing License section'
}
]);
Expand All @@ -27,7 +27,7 @@ test('license - empty', async t => {
message: 'Remove empty section: "License"'
},
{
ruleId: 'awesome/license',
ruleId: 'awesome-license',
message: 'License must not be empty'
}
]);
Expand All @@ -37,7 +37,7 @@ test('license - not last section', async t => {
const messages = await lint({config, filename: 'test/fixtures/license/error2.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/license',
ruleId: 'awesome-license',
message: 'License must be the last section'
}
]);
Expand All @@ -47,7 +47,7 @@ test('license - incorrect heading depth', async t => {
const messages = await lint({config, filename: 'test/fixtures/license/error3.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/license',
ruleId: 'awesome-license',
message: 'License section must be at heading depth 2'
}
]);
Expand All @@ -57,7 +57,7 @@ test('license - png image', async t => {
const messages = await lint({config, filename: 'test/fixtures/license/error4.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/license',
ruleId: 'awesome-license',
message: 'License image must be SVG'
}
]);
Expand Down
5 changes: 5 additions & 0 deletions test/rules/list-item.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,8 @@ test('list-item - valid ignoring Contents section', async t => {
const messages = await lint({config, filename: 'test/fixtures/list-item/2.md'});
t.deepEqual(messages, []);
});

test('list-item - disable by remark-message-control', async t => {
const messages = await lint({config, filename: 'test/fixtures/list-item/4.md'});
t.deepEqual(messages, []);
});
4 changes: 2 additions & 2 deletions test/rules/no-ci-badge.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ test('no-ci-badge - missing', async t => {
const messages = await lint({config, filename: 'test/fixtures/no-ci-badge/0.md'});
t.deepEqual(messages, [
{
ruleId: 'awesome/no-ci-badge',
ruleId: 'awesome-no-ci-badge',
message: 'Readme must not contain CI badge'
},
{
ruleId: 'awesome/no-ci-badge',
ruleId: 'awesome-no-ci-badge',
message: 'Readme must not contain CI badge'
}
]);
Expand Down
30 changes: 15 additions & 15 deletions test/rules/snapshots/list-item.js.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,55 +11,55 @@ Generated by [AVA](https://ava.li).
[
{
message: 'List item description must start with valid casing',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must start with valid casing',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item link and description must be separated with a dash',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must end with proper punctuation',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'Invalid list item link URL',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'Invalid list item link URL',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'Invalid list item link text',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item link and description separated by invalid whitespace',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item link and description separated by invalid en-dash',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must end with proper punctuation',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must end with proper punctuation',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must start with valid casing',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'List item description must start with valid casing',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
]

Expand All @@ -70,10 +70,10 @@ Generated by [AVA](https://ava.li).
[
{
message: 'List item description must end with proper punctuation',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
{
message: 'Invalid list item link URL',
ruleId: 'awesome/list-item',
ruleId: 'awesome-list-item',
},
]
Binary file modified test/rules/snapshots/list-item.js.snap
View file
Open in desktop
Binary file not shown.
Loading