Skip to content

Commit 57cbe73

Browse files
StyleShitCopilot
StyleShit
and
Copilot
authored
feat: add new rule no-matching-violation-suggest-message-ids (#567)
* feat: add new rule `no-matching-violation-suggest-message-ids` Closes #368 * Update docs/rules/no-matching-violation-suggest-message-ids.md Co-authored-by: Copilot <[email protected]> * refactor: use sourceCode.ast directly --------- Co-authored-by: Copilot <[email protected]>
1 parent 0d86ffd commit 57cbe73

File tree

7 files changed

+488
-28
lines changed

7 files changed

+488
-28
lines changed

‎README.md‎

Lines changed: 29 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -68,34 +68,35 @@ export default [
6868

6969
### Rules
7070

71-
| Name                            | Description | 💼 | 🔧 | 💡 | 💭 |
72-
| :------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- |
73-
| [fixer-return](docs/rules/fixer-return.md) | require fixer functions to return a fix | ✅ | | | |
74-
| [meta-property-ordering](docs/rules/meta-property-ordering.md) | enforce the order of meta properties | | 🔧 | | |
75-
| [no-deprecated-context-methods](docs/rules/no-deprecated-context-methods.md) | disallow usage of deprecated methods on rule context objects | ✅ | 🔧 | | |
76-
| [no-deprecated-report-api](docs/rules/no-deprecated-report-api.md) | disallow the version of `context.report()` with multiple arguments | ✅ | 🔧 | | |
77-
| [no-meta-replaced-by](docs/rules/no-meta-replaced-by.md) | disallow using the `meta.replacedBy` rule property | ✅ | | | |
78-
| [no-meta-schema-default](docs/rules/no-meta-schema-default.md) | disallow rules `meta.schema` properties to include defaults | ✅ | | | |
79-
| [no-missing-message-ids](docs/rules/no-missing-message-ids.md) | disallow `messageId`s that are missing from `meta.messages` | ✅ | | | |
80-
| [no-missing-placeholders](docs/rules/no-missing-placeholders.md) | disallow missing placeholders in rule report messages | ✅ | | | |
81-
| [no-property-in-node](docs/rules/no-property-in-node.md) | disallow using `in` to narrow node types instead of looking at properties | | | | 💭 |
82-
| [no-unused-message-ids](docs/rules/no-unused-message-ids.md) | disallow unused `messageId`s in `meta.messages` | ✅ | | | |
83-
| [no-unused-placeholders](docs/rules/no-unused-placeholders.md) | disallow unused placeholders in rule report messages | ✅ | | | |
84-
| [no-useless-token-range](docs/rules/no-useless-token-range.md) | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` | ✅ | 🔧 | | |
85-
| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` or `desc` to report rule violations | ✅ | | | |
86-
| [prefer-object-rule](docs/rules/prefer-object-rule.md) | disallow function-style rules | ✅ | 🔧 | | |
87-
| [prefer-placeholders](docs/rules/prefer-placeholders.md) | require using placeholders for dynamic report messages | | | | |
88-
| [prefer-replace-text](docs/rules/prefer-replace-text.md) | require using `replaceText()` instead of `replaceTextRange()` | | | | |
89-
| [report-message-format](docs/rules/report-message-format.md) | enforce a consistent format for rule report messages | | | | |
90-
| [require-meta-default-options](docs/rules/require-meta-default-options.md) | require only rules with options to implement a `meta.defaultOptions` property | ✅ | 🔧 | | |
91-
| [require-meta-docs-description](docs/rules/require-meta-docs-description.md) | require rules to implement a `meta.docs.description` property with the correct format | | | | |
92-
| [require-meta-docs-recommended](docs/rules/require-meta-docs-recommended.md) | require rules to implement a `meta.docs.recommended` property | | | 💡 | |
93-
| [require-meta-docs-url](docs/rules/require-meta-docs-url.md) | require rules to implement a `meta.docs.url` property | | 🔧 | | |
94-
| [require-meta-fixable](docs/rules/require-meta-fixable.md) | require rules to implement a `meta.fixable` property | ✅ | | | |
95-
| [require-meta-has-suggestions](docs/rules/require-meta-has-suggestions.md) | require suggestable rules to implement a `meta.hasSuggestions` property | ✅ | 🔧 | | |
96-
| [require-meta-schema](docs/rules/require-meta-schema.md) | require rules to implement a `meta.schema` property | ✅ | | 💡 | |
97-
| [require-meta-schema-description](docs/rules/require-meta-schema-description.md) | require rules `meta.schema` properties to include descriptions | ✅ | | | |
98-
| [require-meta-type](docs/rules/require-meta-type.md) | require rules to implement a `meta.type` property | ✅ | | | |
71+
| Name                                      | Description | 💼 | 🔧 | 💡 | 💭 |
72+
| :--------------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :-- | :-- | :-- | :-- |
73+
| [fixer-return](docs/rules/fixer-return.md) | require fixer functions to return a fix | ✅ | | | |
74+
| [meta-property-ordering](docs/rules/meta-property-ordering.md) | enforce the order of meta properties | | 🔧 | | |
75+
| [no-deprecated-context-methods](docs/rules/no-deprecated-context-methods.md) | disallow usage of deprecated methods on rule context objects | ✅ | 🔧 | | |
76+
| [no-deprecated-report-api](docs/rules/no-deprecated-report-api.md) | disallow the version of `context.report()` with multiple arguments | ✅ | 🔧 | | |
77+
| [no-matching-violation-suggest-message-ids](docs/rules/no-matching-violation-suggest-message-ids.md) | require suggestions to have different `messageId` than their parent report | | | | |
78+
| [no-meta-replaced-by](docs/rules/no-meta-replaced-by.md) | disallow using the `meta.replacedBy` rule property | ✅ | | | |
79+
| [no-meta-schema-default](docs/rules/no-meta-schema-default.md) | disallow rules `meta.schema` properties to include defaults | ✅ | | | |
80+
| [no-missing-message-ids](docs/rules/no-missing-message-ids.md) | disallow `messageId`s that are missing from `meta.messages` | ✅ | | | |
81+
| [no-missing-placeholders](docs/rules/no-missing-placeholders.md) | disallow missing placeholders in rule report messages | ✅ | | | |
82+
| [no-property-in-node](docs/rules/no-property-in-node.md) | disallow using `in` to narrow node types instead of looking at properties | | | | 💭 |
83+
| [no-unused-message-ids](docs/rules/no-unused-message-ids.md) | disallow unused `messageId`s in `meta.messages` | ✅ | | | |
84+
| [no-unused-placeholders](docs/rules/no-unused-placeholders.md) | disallow unused placeholders in rule report messages | ✅ | | | |
85+
| [no-useless-token-range](docs/rules/no-useless-token-range.md) | disallow unnecessary calls to `sourceCode.getFirstToken()` and `sourceCode.getLastToken()` | ✅ | 🔧 | | |
86+
| [prefer-message-ids](docs/rules/prefer-message-ids.md) | require using `messageId` instead of `message` or `desc` to report rule violations | ✅ | | | |
87+
| [prefer-object-rule](docs/rules/prefer-object-rule.md) | disallow function-style rules | ✅ | 🔧 | | |
88+
| [prefer-placeholders](docs/rules/prefer-placeholders.md) | require using placeholders for dynamic report messages | | | | |
89+
| [prefer-replace-text](docs/rules/prefer-replace-text.md) | require using `replaceText()` instead of `replaceTextRange()` | | | | |
90+
| [report-message-format](docs/rules/report-message-format.md) | enforce a consistent format for rule report messages | | | | |
91+
| [require-meta-default-options](docs/rules/require-meta-default-options.md) | require only rules with options to implement a `meta.defaultOptions` property | ✅ | 🔧 | | |
92+
| [require-meta-docs-description](docs/rules/require-meta-docs-description.md) | require rules to implement a `meta.docs.description` property with the correct format | | | | |
93+
| [require-meta-docs-recommended](docs/rules/require-meta-docs-recommended.md) | require rules to implement a `meta.docs.recommended` property | | | 💡 | |
94+
| [require-meta-docs-url](docs/rules/require-meta-docs-url.md) | require rules to implement a `meta.docs.url` property | | 🔧 | | |
95+
| [require-meta-fixable](docs/rules/require-meta-fixable.md) | require rules to implement a `meta.fixable` property | ✅ | | | |
96+
| [require-meta-has-suggestions](docs/rules/require-meta-has-suggestions.md) | require suggestable rules to implement a `meta.hasSuggestions` property | ✅ | 🔧 | | |
97+
| [require-meta-schema](docs/rules/require-meta-schema.md) | require rules to implement a `meta.schema` property | ✅ | | 💡 | |
98+
| [require-meta-schema-description](docs/rules/require-meta-schema-description.md) | require rules `meta.schema` properties to include descriptions | ✅ | | | |
99+
| [require-meta-type](docs/rules/require-meta-type.md) | require rules to implement a `meta.type` property | ✅ | | | |
99100

100101
### Tests
101102

‎docs/rules/no-matching-violation-suggest-message-ids.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Require suggestions to have different `messageId` than their parent report (`eslint-plugin/no-matching-violation-suggest-message-ids`)
2+
3+
<!-- end auto-generated rule header -->
4+
5+
When providing fix suggestions to a reported problem, it's important to have an actionable `messageId` for each suggestion rather than reusing the same `messageId` as the main report.
6+
7+
## Rule Details
8+
9+
Examples of **incorrect** code for this rule:
10+
11+
```js
12+
/* eslint eslint-plugin/no-matching-violation-suggest-message-ids: error */
13+
14+
module.exports = {
15+
meta: { messages: { notAllowed: '`DebuggerStatement`s are not allowed' } },
16+
17+
create(context) {
18+
return {
19+
DebuggerStatement(node) {
20+
context.report({
21+
node,
22+
messageId: 'notAllowed',
23+
suggest: [{ messageId: 'notAllowed' }],
24+
});
25+
},
26+
};
27+
},
28+
};
29+
```
30+
31+
Examples of **correct** code for this rule:
32+
33+
```js
34+
/* eslint eslint-plugin/no-matching-violation-suggest-message-ids: error */
35+
36+
module.exports = {
37+
meta: {
38+
messages: {
39+
notAllowed: '`DebuggerStatement`s are not allowed',
40+
remove: 'Remove the debugger statement',
41+
},
42+
},
43+
44+
create(context) {
45+
return {
46+
DebuggerStatement(node) {
47+
context.report({
48+
node,
49+
messageId: 'notAllowed',
50+
suggest: [
51+
{
52+
messageId: 'remove',
53+
fix: (fixer) => fixer.remove(node),
54+
},
55+
],
56+
});
57+
},
58+
};
59+
},
60+
};
61+
```
62+
63+
## Further Reading
64+
65+
- [ESLint rule docs: Providing Suggestions](https://eslint.org/docs/latest/extend/custom-rules#providing-suggestions)
66+
- [ESLint rule docs: Suggestion `messageId`s](https://eslint.org/docs/latest/extend/custom-rules#suggestion-messageids)
67+
- [no-missing-message-ids](./no-missing-message-ids.md) rule
68+
- [no-unused-message-ids](./no-unused-message-ids.md) rule
69+
- [prefer-message-ids](./prefer-message-ids.md) rule

‎lib/index.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import metaPropertyOrdering from './rules/meta-property-ordering.ts';
1212
import noDeprecatedContextMethods from './rules/no-deprecated-context-methods.ts';
1313
import noDeprecatedReportApi from './rules/no-deprecated-report-api.ts';
1414
import noIdenticalTests from './rules/no-identical-tests.ts';
15+
import noMatchingViolationSuggestMessageIds from './rules/no-matching-violation-suggest-message-ids.ts';
1516
import noMetaReplacedBy from './rules/no-meta-replaced-by.ts';
1617
import noMetaSchemaDefault from './rules/no-meta-schema-default.ts';
1718
import noMissingMessageIds from './rules/no-missing-message-ids.ts';
@@ -92,6 +93,8 @@ const allRules = {
9293
'no-deprecated-context-methods': noDeprecatedContextMethods,
9394
'no-deprecated-report-api': noDeprecatedReportApi,
9495
'no-identical-tests': noIdenticalTests,
96+
'no-matching-violation-suggest-message-ids':
97+
noMatchingViolationSuggestMessageIds,
9598
'no-meta-replaced-by': noMetaReplacedBy,
9699
'no-meta-schema-default': noMetaSchemaDefault,
97100
'no-missing-message-ids': noMissingMessageIds,

‎lib/rules/no-matching-violation-suggest-message-ids.ts‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
import type { Rule, Scope } from 'eslint';
2+
import type { Node, CallExpression, MemberExpression } from 'estree';
3+
4+
import {
5+
collectReportViolationAndSuggestionData,
6+
findPossibleVariableValues,
7+
getContextIdentifiers,
8+
getReportInfo,
9+
getRuleInfo,
10+
isStringLiteral,
11+
} from '../utils.ts';
12+
import type { StringLiteral, ViolationAndSuppressionData } from '../types.ts';
13+
14+
const rule: Rule.RuleModule = {
15+
meta: {
16+
type: 'suggestion',
17+
docs: {
18+
recommended: false,
19+
description:
20+
'require suggestions to have different `messageId` than their parent report',
21+
category: 'Rules',
22+
url: 'https://github.com/eslint-community/eslint-plugin-eslint-plugin/tree/HEAD/docs/rules/no-matching-violation-suggest-message-ids.md',
23+
},
24+
schema: [],
25+
messages: {
26+
matchingMessageId:
27+
'Suggestion messageId "{{messageId}}" should not match its parent report messageId.',
28+
},
29+
},
30+
31+
create(context) {
32+
const sourceCode = context.sourceCode;
33+
const { scopeManager } = sourceCode;
34+
const ruleInfo = getRuleInfo(sourceCode);
35+
if (!ruleInfo) {
36+
return {};
37+
}
38+
39+
const contextIdentifiers: Set<Node> = getContextIdentifiers(
40+
scopeManager,
41+
sourceCode.ast,
42+
);
43+
44+
return {
45+
'CallExpression:has(>MemberExpression[property.name="report"])'(
46+
_node: Rule.Node,
47+
) {
48+
const node = _node as CallExpression & { callee: MemberExpression };
49+
50+
if (!contextIdentifiers.has(node.callee.object)) {
51+
return;
52+
}
53+
54+
const reportInfo = getReportInfo(node, context);
55+
56+
if (!reportInfo) {
57+
return;
58+
}
59+
60+
const [report, ...suggestions] =
61+
collectReportViolationAndSuggestionData(reportInfo).map((obj) => ({
62+
...obj,
63+
literalMessageIds: messageIdToLiteralValues(
64+
obj.messageId,
65+
scopeManager,
66+
),
67+
}));
68+
69+
if (report.literalMessageIds.length === 0 || suggestions.length === 0) {
70+
return;
71+
}
72+
73+
const reportContainsMessageId = (messageId: StringLiteral) => {
74+
return report.literalMessageIds.some(
75+
(reportMessageId) => messageId.value === reportMessageId.value,
76+
);
77+
};
78+
79+
suggestions.forEach((suggestion) => {
80+
const matchingMessageId = suggestion.literalMessageIds.find(
81+
reportContainsMessageId,
82+
);
83+
84+
if (matchingMessageId) {
85+
context.report({
86+
messageId: 'matchingMessageId',
87+
node: matchingMessageId,
88+
data: {
89+
messageId: matchingMessageId.value,
90+
},
91+
});
92+
}
93+
});
94+
},
95+
};
96+
},
97+
};
98+
99+
function messageIdToLiteralValues(
100+
messageId: ViolationAndSuppressionData['messageId'],
101+
scopeManager: Scope.ScopeManager,
102+
): StringLiteral[] {
103+
if (!messageId) {
104+
return [];
105+
}
106+
107+
if (isStringLiteral(messageId)) {
108+
return [messageId];
109+
}
110+
111+
if (messageId.type === 'ConditionalExpression') {
112+
return [
113+
...messageIdToLiteralValues(messageId.consequent, scopeManager),
114+
...messageIdToLiteralValues(messageId.alternate, scopeManager),
115+
];
116+
}
117+
118+
if (messageId.type === 'Identifier') {
119+
return findPossibleVariableValues(messageId, scopeManager).filter(
120+
isStringLiteral,
121+
);
122+
}
123+
124+
return [];
125+
}
126+
127+
export default rule;

‎lib/types.ts‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import type {
66
Expression,
77
FunctionDeclaration,
88
FunctionExpression,
9+
Literal,
910
MaybeNamedClassDeclaration,
1011
MaybeNamedFunctionDeclaration,
1112
Node,
@@ -81,3 +82,5 @@ export type MetaDocsProperty = {
8182
metaNode: Node | undefined;
8283
metaPropertyNode: Property | undefined;
8384
};
85+
86+
export type StringLiteral = Literal & { value: string };

‎lib/utils.ts‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ import type {
2929
MetaDocsProperty,
3030
PartialRuleInfo,
3131
RuleInfo,
32+
StringLiteral,
3233
TestInfo,
3334
ViolationAndSuppressionData,
3435
} from './types.ts';
@@ -1115,6 +1116,10 @@ export function isUndefinedIdentifier(node: Node): boolean {
11151116
return node.type === 'Identifier' && node.name === 'undefined';
11161117
}
11171118

1119+
export function isStringLiteral(node: Node): node is StringLiteral {
1120+
return node.type === 'Literal' && typeof node.value === 'string';
1121+
}
1122+
11181123
/**
11191124
* Check whether a variable's definition is from a function parameter.
11201125
* @param node - the Identifier node for the variable.

0 commit comments

Comments
 (0)