Tweak violation message in prefer-message-ids rule (#355)

eslint-community · Jun 13, 2023 · a07653e · a07653e
1 parent 2fedf1e
commit a07653e
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -91,7 +91,7 @@ module.exports = [
 | [no-unused-message-ids](docs/rules/no-unused-message-ids.md)                 | disallow unused `messageId`s in `meta.messages`                                            | ✅  |    |    |
 | [no-unused-placeholders](docs/rules/no-unused-placeholders.md)               | disallow unused placeholders in rule report messages                                       | ✅  |    |    |
 | [no-useless-token-range](docs/rules/no-useless-token-range.md)               | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` | ✅  | 🔧 |    |
-| [prefer-message-ids](docs/rules/prefer-message-ids.md)                       | require using `messageId` instead of `message` to report rule violations                   | ✅  |    |    |
+| [prefer-message-ids](docs/rules/prefer-message-ids.md)                       | require using `messageId` instead of `message` or `desc` to report rule violations         | ✅  |    |    |
 | [prefer-object-rule](docs/rules/prefer-object-rule.md)                       | disallow function-style rules                                                              | ✅  | 🔧 |    |
 | [prefer-placeholders](docs/rules/prefer-placeholders.md)                     | require using placeholders for dynamic report messages                                     |    |    |    |
 | [prefer-replace-text](docs/rules/prefer-replace-text.md)                     | require using `replaceText()` instead of `replaceTextRange()`                              |    |    |    |
@@ -118,14 +118,14 @@ module.exports = [
 
 ## <a name='Presets'></a>Presets
 
-|   | Name | Description |
-|:--|:-----|:------------|
-| ✅ | `recommended` | enables all recommended rules in this plugin |
+|   | Name                | Description                                                               |
+|:--|:--------------------|:--------------------------------------------------------------------------|
+| ✅ | `recommended`       | enables all recommended rules in this plugin                              |
 |   | `rules-recommended` | enables all recommended rules that are aimed at linting ESLint rule files |
 |   | `tests-recommended` | enables all recommended rules that are aimed at linting ESLint test files |
-|   | `all` | enables all rules in this plugin |
-|   | `rules` | enables all rules that are aimed at linting ESLint rule files |
-|   | `tests` | enables all rules that are aimed at linting ESLint test files |
+|   | `all`               | enables all rules in this plugin                                          |
+|   | `rules`             | enables all rules that are aimed at linting ESLint rule files             |
+|   | `tests`             | enables all rules that are aimed at linting ESLint test files             |
 
 ### <a name='Semanticversioningpolicy'></a>Semantic versioning policy
 

diff --git a/docs/rules/prefer-message-ids.md b/docs/rules/prefer-message-ids.md
@@ -1,4 +1,4 @@
-# Require using `messageId` instead of `message` to report rule violations (`eslint-plugin/prefer-message-ids`)
+# Require using `messageId` instead of `message` or `desc` to report rule violations (`eslint-plugin/prefer-message-ids`)
 
 💼 This rule is enabled in the ✅ `recommended` [config](https://github.com/eslint-community/eslint-plugin-eslint-plugin#presets).
 

diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js
@@ -13,7 +13,7 @@ module.exports = {
     type: 'problem',
     docs: {
       description:
-        'require using `messageId` instead of `message` to report rule violations',
+        'require using `messageId` instead of `message` or `desc` to report rule violations',
       category: 'Rules',
       recommended: true,
       url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/prefer-message-ids.md',
@@ -23,7 +23,8 @@ module.exports = {
     messages: {
       messagesMissing:
         '`meta.messages` must contain at least one violation message.',
-      foundMessage: 'Use `messageId` instead of `message`.',
+      foundMessage:
+        'Use `messageId` instead of `message` (for violations) or `desc` (for suggestions).',
     },
   },