Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 13, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6759dc1
style: format tables
nopeless Jun 13, 2023
f2ed62d
docs: update `prefer-message-ids` to include `desc`
nopeless Jun 13, 2023
8ae277e
fix: misleading `foundMessage` (#354)
nopeless Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()` | | | |
Expand All @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/prefer-message-ids.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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).

Expand Down
5 changes: 3 additions & 2 deletions lib/rules/prefer-message-ids.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand All @@ -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).',
},
},

Expand Down