Skip to content

Commit a07653e

Browse files
authored
Tweak violation message in prefer-message-ids rule (#355)
1 parent 2fedf1e commit a07653e

File tree

3 files changed

+11
-10
lines changed

3 files changed

+11
-10
lines changed

Diff for: README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ module.exports = [
9191
| [no-unused-message-ids](docs/rules/no-unused-message-ids.md) | disallow unused `messageId`s in `meta.messages` || | |
9292
| [no-unused-placeholders](docs/rules/no-unused-placeholders.md) | disallow unused placeholders in rule report messages || | |
9393
| [no-useless-token-range](docs/rules/no-useless-token-range.md) | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` || 🔧 | |
94-
| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` to report rule violations || | |
94+
| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` or `desc` to report rule violations || | |
9595
| [prefer-object-rule](docs/rules/prefer-object-rule.md) | disallow function-style rules || 🔧 | |
9696
| [prefer-placeholders](docs/rules/prefer-placeholders.md) | require using placeholders for dynamic report messages | | | |
9797
| [prefer-replace-text](docs/rules/prefer-replace-text.md) | require using `replaceText()` instead of `replaceTextRange()` | | | |
@@ -118,14 +118,14 @@ module.exports = [
118118

119119
## <a name='Presets'></a>Presets
120120

121-
| | Name | Description |
122-
|:--|:-----|:------------|
123-
|| `recommended` | enables all recommended rules in this plugin |
121+
| | Name | Description |
122+
|:--|:--------------------|:--------------------------------------------------------------------------|
123+
|| `recommended` | enables all recommended rules in this plugin |
124124
| | `rules-recommended` | enables all recommended rules that are aimed at linting ESLint rule files |
125125
| | `tests-recommended` | enables all recommended rules that are aimed at linting ESLint test files |
126-
| | `all` | enables all rules in this plugin |
127-
| | `rules` | enables all rules that are aimed at linting ESLint rule files |
128-
| | `tests` | enables all rules that are aimed at linting ESLint test files |
126+
| | `all` | enables all rules in this plugin |
127+
| | `rules` | enables all rules that are aimed at linting ESLint rule files |
128+
| | `tests` | enables all rules that are aimed at linting ESLint test files |
129129

130130
### <a name='Semanticversioningpolicy'></a>Semantic versioning policy
131131

Diff for: docs/rules/prefer-message-ids.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Require using `messageId` instead of `message` to report rule violations (`eslint-plugin/prefer-message-ids`)
1+
# Require using `messageId` instead of `message` or `desc` to report rule violations (`eslint-plugin/prefer-message-ids`)
22

33
💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
44

Diff for: lib/rules/prefer-message-ids.js

+3-2
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ module.exports = {
1313
type: 'problem',
1414
docs: {
1515
description:
16-
'require using `messageId` instead of `message` to report rule violations',
16+
'require using `messageId` instead of `message` or `desc` to report rule violations',
1717
category: 'Rules',
1818
recommended: true,
1919
url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-message-ids.md',
@@ -23,7 +23,8 @@ module.exports = {
2323
messages: {
2424
messagesMissing:
2525
'`meta.messages` must contain at least one violation message.',
26-
foundMessage: 'Use `messageId` instead of `message`.',
26+
foundMessage:
27+
'Use `messageId` instead of `message` (for violations) or `desc` (for suggestions).',
2728
},
2829
},
2930

0 commit comments

Comments
 (0)