Skip to content

Commit bc526be

Browse files
committed
Chore: Switch rule doc URLs to use HEAD instead of a version tag
1 parent a77fd11 commit bc526be

27 files changed

+27
-30
lines changed

.eslintrc.js

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
'use strict';
22

3-
const version = require('./package.json').version;
4-
53
module.exports = {
64
root: true,
75
plugins: ['node'],
@@ -41,7 +39,7 @@ module.exports = {
4139
'error',
4240
{
4341
pattern:
44-
`https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v${version}/docs/rules/{{name}}.md`,
42+
'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/{{name}}.md',
4543
},
4644
],
4745
},

lib/rules/consistent-output.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'enforce consistent use of `output` assertions in rule tests',
1919
category: 'Tests',
2020
recommended: true,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/consistent-output.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/consistent-output.md',
2222
},
2323
fixable: null, // or "code" or "whitespace"
2424
schema: [

lib/rules/fixer-return.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = {
2323
description: 'require fixer functions to return a fix',
2424
category: 'Rules',
2525
recommended: true,
26-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/fixer-return.md',
26+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/fixer-return.md',
2727
},
2828
fixable: null,
2929
schema: [],

lib/rules/meta-property-ordering.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ module.exports = {
1717
description: 'enforce the order of meta properties',
1818
category: 'Rules',
1919
recommended: false,
20-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/meta-property-ordering.md',
20+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/meta-property-ordering.md',
2121
},
2222
fixable: 'code',
2323
schema: [{

lib/rules/no-deprecated-context-methods.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ module.exports = {
4141
description: 'disallow usage of deprecated methods on rule context objects',
4242
category: 'Rules',
4343
recommended: true,
44-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-deprecated-context-methods.md',
44+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-context-methods.md',
4545
},
4646
fixable: 'code',
4747
schema: [],

lib/rules/no-deprecated-report-api.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'disallow the version of `context.report()` with multiple arguments',
1919
category: 'Rules',
2020
recommended: true,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-deprecated-report-api.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-deprecated-report-api.md',
2222
},
2323
fixable: 'code', // or "code" or "whitespace"
2424
schema: [],

lib/rules/no-identical-tests.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'disallow identical tests',
1919
category: 'Tests',
2020
recommended: true,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-identical-tests.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-identical-tests.md',
2222
},
2323
fixable: 'code',
2424
schema: [],

lib/rules/no-missing-placeholders.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
description: 'disallow missing placeholders in rule report messages',
2020
category: 'Rules',
2121
recommended: true,
22-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-missing-placeholders.md',
22+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-missing-placeholders.md',
2323
},
2424
fixable: null,
2525
schema: [],

lib/rules/no-only-tests.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ module.exports = {
1010
description: 'disallow the test case property `only`',
1111
category: 'Tests',
1212
recommended: true,
13-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-only-tests.md',
13+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-only-tests.md',
1414
},
1515
hasSuggestions: true,
1616
schema: [],

lib/rules/no-unused-placeholders.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
description: 'disallow unused placeholders in rule report messages',
2020
category: 'Rules',
2121
recommended: true,
22-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-unused-placeholders.md',
22+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-unused-placeholders.md',
2323
},
2424
fixable: null,
2525
schema: [],

lib/rules/no-useless-token-range.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()`',
1919
category: 'Rules',
2020
recommended: true,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/no-useless-token-range.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-useless-token-range.md',
2222
},
2323
fixable: 'code',
2424
schema: [],

lib/rules/prefer-message-ids.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = {
1414
description: 'require using `messageId` instead of `message` to report rule violations',
1515
category: 'Rules',
1616
recommended: false,
17-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/prefer-message-ids.md',
17+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-message-ids.md',
1818
},
1919
fixable: null,
2020
schema: [],

lib/rules/prefer-object-rule.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ module.exports = {
1717
description: 'disallow rule exports where the export is a function',
1818
category: 'Rules',
1919
recommended: true,
20-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/prefer-object-rule.md',
20+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-object-rule.md',
2121
},
2222
fixable: 'code',
2323
schema: [],

lib/rules/prefer-output-null.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'disallow invalid RuleTester test cases where the `output` matches the `code`',
1919
category: 'Tests',
2020
recommended: false,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/prefer-output-null.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-output-null.md',
2222
},
2323
fixable: 'code',
2424
schema: [],

lib/rules/prefer-placeholders.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
description: 'require using placeholders for dynamic report messages',
2020
category: 'Rules',
2121
recommended: false,
22-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/prefer-placeholders.md',
22+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-placeholders.md',
2323
},
2424
fixable: null,
2525
schema: [],

lib/rules/prefer-replace-text.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'require using `replaceText()` instead of `replaceTextRange()`',
1919
category: 'Rules',
2020
recommended: false,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/prefer-replace-text.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-replace-text.md',
2222
},
2323
fixable: null,
2424
schema: [],

lib/rules/report-message-format.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
description: 'enforce a consistent format for rule report messages',
2020
category: 'Rules',
2121
recommended: false,
22-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/report-message-format.md',
22+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/report-message-format.md',
2323
},
2424
fixable: null,
2525
schema: [

lib/rules/require-meta-docs-description.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ module.exports = {
1616
description: 'require rules to implement a `meta.docs.description` property with the correct format',
1717
category: 'Rules',
1818
recommended: false,
19-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-docs-description.md',
19+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-description.md',
2020
},
2121
fixable: null,
2222
schema: [

lib/rules/require-meta-docs-url.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ module.exports = {
2323
description: 'require rules to implement a `meta.docs.url` property',
2424
category: 'Rules',
2525
recommended: false,
26-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-docs-url.md',
26+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-docs-url.md',
2727
},
2828
fixable: 'code',
2929
schema: [{

lib/rules/require-meta-fixable.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ module.exports = {
1919
description: 'require rules to implement a `meta.fixable` property',
2020
category: 'Rules',
2121
recommended: true,
22-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-fixable.md',
22+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-fixable.md',
2323
},
2424
schema: [
2525
{

lib/rules/require-meta-has-suggestions.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = {
1414
description: 'require suggestable rules to implement a `meta.hasSuggestions` property',
1515
category: 'Rules',
1616
recommended: true,
17-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-has-suggestions.md',
17+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-has-suggestions.md',
1818
},
1919
fixable: 'code',
2020
schema: [],

lib/rules/require-meta-schema.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ module.exports = {
1414
description: 'require rules to implement a `meta.schema` property',
1515
category: 'Rules',
1616
recommended: true,
17-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-schema.md',
17+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-schema.md',
1818
},
1919
hasSuggestions: true,
2020
schema: [

lib/rules/require-meta-type.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ module.exports = {
2020
description: 'require rules to implement a `meta.type` property',
2121
category: 'Rules',
2222
recommended: true,
23-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/require-meta-type.md',
23+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/require-meta-type.md',
2424
},
2525
fixable: null,
2626
schema: [],

lib/rules/test-case-property-ordering.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'require the properties of a test case to be placed in a consistent order',
1919
category: 'Tests',
2020
recommended: false,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/test-case-property-ordering.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/test-case-property-ordering.md',
2222
},
2323
fixable: 'code',
2424
schema: [{

lib/rules/test-case-shorthand-strings.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ module.exports = {
1818
description: 'enforce consistent usage of shorthand strings for test cases with no options',
1919
category: 'Tests',
2020
recommended: false,
21-
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/v4.0.1/docs/rules/test-case-shorthand-strings.md',
21+
url: 'https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/test-case-shorthand-strings.md',
2222
},
2323
fixable: 'code',
2424
schema: [{ enum: ['as-needed', 'never', 'consistent', 'consistent-as-needed'] }],

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,7 @@
1111
"lint:js": "eslint .",
1212
"generate-readme-table": "node build/generate-readme-table.js",
1313
"generate-release": "release-it",
14-
"test": "nyc --all --check-coverage --include lib mocha tests --recursive",
15-
"version": "eslint --fix . && git add ."
14+
"test": "nyc --all --check-coverage --include lib mocha tests --recursive"
1615
},
1716
"files": [
1817
"lib/"

tests/lib/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ describe('exported plugin', () => {
1111
it(ruleName, () => {
1212
assert.match(
1313
plugin.rules[ruleName].meta.docs.url,
14-
/^https:\/\/github.com\/not-an-aardvark\/eslint-plugin-eslint-plugin\/tree\/v\d+\.\d+\.\d+(-\d+)?\/docs\/rules\/[\w-]+\.md$/
14+
/^https:\/\/github.com\/not-an-aardvark\/eslint-plugin-eslint-plugin\/tree\/HEAD\/docs\/rules\/[\w-]+\.md$/
1515
);
1616
});
1717
});

0 commit comments

Comments
 (0)