Skip to content

feat(eslint-plugin): [consistent-type-assertions] add suggestions for objectLiteralTypeAssertions #6642

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 7 commits into from
Mar 21, 2023
Merged

feat(eslint-plugin): [consistent-type-assertions] add suggestions for objectLiteralTypeAssertions #6642

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2d55ffa
Add suggestions for objectLiteralTypeAssertions
NotWoods Mar 15, 2023
99a7e03
Merge branch 'main' into suggest-object-type-assertions
NotWoods Mar 15, 2023
0806103
Add additional test cases
NotWoods Mar 20, 2023
a81e39f
Capture parentheses
NotWoods Mar 20, 2023
0fdac48
Use changes from other PR
NotWoods Mar 20, 2023
e3fd84a
Merge branch 'main' into suggest-object-type-assertions
JoshuaKGoldberg Mar 21, 2023
25b710d
Merge branch 'main'
JoshuaKGoldberg Mar 21, 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
42 changes: 41 additions & 1 deletion packages/eslint-plugin/src/rules/consistent-type-assertions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,9 @@ type MessageIds =
| 'as'
| 'angle-bracket'
| 'never'
| 'unexpectedObjectTypeAssertion';
| 'unexpectedObjectTypeAssertion'
| 'replaceObjectTypeAssertionWithAnnotation'
| 'replaceObjectTypeAssertionWithSatisfies';
type OptUnion =
| {
assertionStyle: 'as' | 'angle-bracket';
Expand All @@ -24,6 +26,7 @@ export default util.createRule<Options, MessageIds>({
meta: {
type: 'suggestion',
fixable: 'code',
hasSuggestions: true,
docs: {
description: 'Enforce consistent usage of type assertions',
recommended: 'strict',
Expand All @@ -33,6 +36,10 @@ export default util.createRule<Options, MessageIds>({
'angle-bracket': "Use '<{{cast}}>' instead of 'as {{cast}}'.",
never: 'Do not use any type assertions.',
unexpectedObjectTypeAssertion: 'Always prefer const x: T = { ... }.',
replaceObjectTypeAssertionWithAnnotation:
'Use const x: {{cast}} = { ... } instead.',
replaceObjectTypeAssertionWithSatisfies:
'Use const x = { ... } satisfies {{cast}} instead.',
},
schema: [
{
Expand Down Expand Up @@ -184,9 +191,42 @@ export default util.createRule<Options, MessageIds>({
checkType(node.typeAnnotation) &&
node.expression.type === AST_NODE_TYPES.ObjectExpression
) {
const suggest: TSESLint.ReportSuggestionArray<MessageIds> = [];
if (
node.parent?.type === AST_NODE_TYPES.VariableDeclarator &&
!node.parent.id.typeAnnotation
) {
const { parent } = node;
suggest.push({
messageId: 'replaceObjectTypeAssertionWithAnnotation',
data: { cast: sourceCode.getText(node.typeAnnotation) },
fix: fixer => [
fixer.insertTextAfter(
parent.id,
`: ${sourceCode.getText(node.typeAnnotation)}`,
),
fixer.replaceText(node, getTextWithParentheses(node.expression)),
],
});
}
suggest.push({
messageId: 'replaceObjectTypeAssertionWithSatisfies',
data: { cast: sourceCode.getText(node.typeAnnotation) },
fix: fixer => [
fixer.replaceText(node, getTextWithParentheses(node.expression)),
fixer.insertTextAfter(
node,
` satisfies ${context
.getSourceCode()
.getText(node.typeAnnotation)}`,
),
],
});

context.report({
node,
messageId: 'unexpectedObjectTypeAssertion',
suggest,
});
}
}
Expand Down
Loading