Skip to content

Commit c9f6164

Browse files
bmishbmish
committed
docs: update rule descriptions to begin with consistent prefixes
1 parent 21f6ad1 commit c9f6164

12 files changed

+22
-22
lines changed

‎README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -49,26 +49,26 @@ Then configure the rules you want to use under the rules section.
4949
<!-- __BEGIN AUTOGENERATED TABLE__ -->
5050
Name | ✔️ | 🛠 | Description
5151
----- | ----- | ----- | -----
52-
[consistent-output](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/consistent-output.md) | | | Enforce consistent use of output assertions in rule tests
53-
[fixer-return](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/fixer-return.md) | ✔️ | | Expected fixer function to always return a value.
54-
[meta-property-ordering](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/meta-property-ordering.md) | | 🛠 | Enforces the order of meta properties
55-
[no-deprecated-context-methods](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-context-methods.md) | | 🛠 | Disallows usage of deprecated methods on rule context objects
52+
[consistent-output](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/consistent-output.md) | | | enforce consistent use of output assertions in rule tests
53+
[fixer-return](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/fixer-return.md) | ✔️ | | require fixer function to always return a value.
54+
[meta-property-ordering](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/meta-property-ordering.md) | | 🛠 | enforce the order of meta properties
55+
[no-deprecated-context-methods](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-context-methods.md) | | 🛠 | disallow usage of deprecated methods on rule context objects
5656
[no-deprecated-report-api](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-deprecated-report-api.md) | ✔️ | 🛠 | disallow use of the deprecated context.report() API
5757
[no-identical-tests](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-identical-tests.md) | ✔️ | 🛠 | disallow identical tests
58-
[no-missing-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-missing-placeholders.md) | ✔️ | | Disallow missing placeholders in rule report messages
59-
[no-unused-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-unused-placeholders.md) | ✔️ | | Disallow unused placeholders in rule report messages
60-
[no-useless-token-range](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-useless-token-range.md) | ✔️ | 🛠 | Disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken
61-
[prefer-output-null](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-output-null.md) | | 🛠 | disallows invalid RuleTester test cases with the output the same as the code.
58+
[no-missing-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-missing-placeholders.md) | ✔️ | | disallow missing placeholders in rule report messages
59+
[no-unused-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-unused-placeholders.md) | ✔️ | | disallow unused placeholders in rule report messages
60+
[no-useless-token-range](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/no-useless-token-range.md) | ✔️ | 🛠 | disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken
61+
[prefer-output-null](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-output-null.md) | | 🛠 | disallow invalid RuleTester test cases with the output the same as the code.
6262
[prefer-placeholders](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-placeholders.md) | | | disallow template literals as report messages
63-
[prefer-replace-text](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-replace-text.md) | | | prefer using replaceText instead of replaceTextRange.
63+
[prefer-replace-text](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/prefer-replace-text.md) | | | require using replaceText instead of replaceTextRange.
6464
[report-message-format](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/report-message-format.md) | | | enforce a consistent format for rule report messages
6565
[require-meta-docs-description](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-description.md) | | | require rules to implement a meta.docs.description property with the correct format
6666
[require-meta-docs-url](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-docs-url.md) | | 🛠 | require rules to implement a meta.docs.url property
6767
[require-meta-fixable](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-fixable.md) | ✔️ | | require rules to implement a meta.fixable property
6868
[require-meta-schema](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-schema.md) | | 🛠 | require rules to implement a meta.schema property
6969
[require-meta-type](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/require-meta-type.md) | | | require rules to implement a meta.type property
70-
[test-case-property-ordering](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-property-ordering.md) | | 🛠 | Requires the properties of a test case to be placed in a consistent order
71-
[test-case-shorthand-strings](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-shorthand-strings.md) | | 🛠 | Enforce consistent usage of shorthand strings for test cases with no options
70+
[test-case-property-ordering](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-property-ordering.md) | | 🛠 | require the properties of a test case to be placed in a consistent order
71+
[test-case-shorthand-strings](https://github.com/not-an-aardvark/eslint-plugin-eslint-plugin/blob/master/docs/rules/test-case-shorthand-strings.md) | | 🛠 | enforce consistent usage of shorthand strings for test cases with no options
7272
<!-- __END AUTOGENERATED TABLE__ -->
7373

7474
## Supported Presets

‎lib/rules/consistent-output.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Enforce consistent use of output assertions in rule tests',
17+
description: 'enforce consistent use of output assertions in rule tests',
1818
category: 'Tests',
1919
recommended: false,
2020
},

‎lib/rules/fixer-return.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ const utils = require('../utils');
1818
module.exports = {
1919
meta: {
2020
docs: {
21-
description: 'Expected fixer function to always return a value.',
21+
description: 'require fixer function to always return a value.',
2222
category: 'Possible Errors',
2323
recommended: true,
2424
},

‎lib/rules/meta-property-ordering.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ const { getKeyName, getRuleInfo } = require('../utils');
1313
module.exports = {
1414
meta: {
1515
docs: {
16-
description: 'Enforces the order of meta properties',
16+
description: 'enforce the order of meta properties',
1717
category: 'Rules',
1818
recommended: false,
1919
},

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ const DEPRECATED_PASSTHROUGHS = {
3737
module.exports = {
3838
meta: {
3939
docs: {
40-
description: 'Disallows usage of deprecated methods on rule context objects',
40+
description: 'disallow usage of deprecated methods on rule context objects',
4141
category: 'Rules',
4242
recommended: false,
4343
},

‎lib/rules/no-missing-placeholders.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Disallow missing placeholders in rule report messages',
17+
description: 'disallow missing placeholders in rule report messages',
1818
category: 'Rules',
1919
recommended: true,
2020
},

‎lib/rules/no-unused-placeholders.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Disallow unused placeholders in rule report messages',
17+
description: 'disallow unused placeholders in rule report messages',
1818
category: 'Rules',
1919
recommended: true,
2020
},

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken',
17+
description: 'disallow unnecessary calls to sourceCode.getFirstToken and sourceCode.getLastToken',
1818
category: 'Rules',
1919
recommended: true,
2020
},

‎lib/rules/prefer-output-null.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'disallows invalid RuleTester test cases with the output the same as the code.',
17+
description: 'disallow invalid RuleTester test cases with the output the same as the code.',
1818
category: 'Tests',
1919
recommended: false,
2020
},

‎lib/rules/prefer-replace-text.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'prefer using replaceText instead of replaceTextRange.',
17+
description: 'require using replaceText instead of replaceTextRange.',
1818
category: 'Rules',
1919
recommended: false,
2020
},

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Requires the properties of a test case to be placed in a consistent order',
17+
description: 'require the properties of a test case to be placed in a consistent order',
1818
category: 'Tests',
1919
recommended: false,
2020
},

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const utils = require('../utils');
1414
module.exports = {
1515
meta: {
1616
docs: {
17-
description: 'Enforce consistent usage of shorthand strings for test cases with no options',
17+
description: 'enforce consistent usage of shorthand strings for test cases with no options',
1818
category: 'Tests',
1919
recommended: false,
2020
},

0 commit comments

Comments
 (0)