From 6759dc1901dc7f056432107f113f9c425b08392b Mon Sep 17 00:00:00 2001 From: nopeless <38830903+nopeless@users.noreply.github.com> Date: Wed, 14 Jun 2023 06:35:07 +0900 Subject: [PATCH 1/3] style: format tables --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 9e240627..6eee829f 100644 --- a/README.md +++ b/README.md @@ -118,14 +118,14 @@ module.exports = [ ## 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 | ### Semantic versioning policy From f2ed62d0de062d3d0e83b09fbe3aa4a48a526bda Mon Sep 17 00:00:00 2001 From: nopeless <38830903+nopeless@users.noreply.github.com> Date: Wed, 14 Jun 2023 06:43:17 +0900 Subject: [PATCH 2/3] docs: update `prefer-message-ids` to include `desc` --- README.md | 2 +- docs/rules/prefer-message-ids.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6eee829f..18728fed 100644 --- 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()` | | | | diff --git a/docs/rules/prefer-message-ids.md b/docs/rules/prefer-message-ids.md index a0d52c01..9dc6f91f 100644 --- 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). From 8ae277eec0957c50eb7f85d762f7517fed69fcd8 Mon Sep 17 00:00:00 2001 From: nopeless <38830903+nopeless@users.noreply.github.com> Date: Wed, 14 Jun 2023 06:43:48 +0900 Subject: [PATCH 3/3] fix: misleading `foundMessage` (#354) --- lib/rules/prefer-message-ids.js | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lib/rules/prefer-message-ids.js b/lib/rules/prefer-message-ids.js index 1eb65bdd..539d7104 100644 --- 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).', }, },