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.
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
feat(eslint-plugin): [no-magic-numbers] ignoreTypeIndexes option #4789
Changes from 1 commit
d0cabc2
d1e65be
8ec2104
af1ddb7
88bd7e4
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,6 +24,9 @@ const schema = util.deepMerge( | |
ignoreReadonlyClassProperties: { | ||
type: 'boolean', | ||
}, | ||
ignoreTypeIndexes: { | ||
type: 'boolean', | ||
}, | ||
}, | ||
}, | ||
); | ||
|
@@ -70,6 +73,15 @@ export default util.createRule<Options, MessageIds>({ | |
return; | ||
} | ||
|
||
// Check if the node is a type index | ||
if ( | ||
options.ignoreTypeIndexes && | ||
(typeof node.value === 'number' || typeof node.value === 'bigint') && | ||
isAncestorTSIndexedAccessType(node) | ||
) { | ||
return; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. FWIW, this looks good to me. Also, good catch for the union types - this was something that I overlooked. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @timdeschryver Thanks! I refactored things a little in d1e65be so if any of the four ignorable TypeScript rules are triggered it will report early. Is that better? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yea, this should work. Keep in mind that I'm not a member of typescript-eslint 😅 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @timdeschryver Realized I never responded to this, sorry - and thank you for the feedback.
I don’t think I can remove the Perhaps I should move the final
Looking at a few other rule definitions at random it does seem like they keep the core rule logic in the Feel free to push back if you (or @JoshuaKGoldberg?) disagree though, and I will happily take another look. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No problem @davecardwell ! |
||
} | ||
|
||
// Check if the node is a readonly class property | ||
if ( | ||
(typeof node.value === 'number' || typeof node.value === 'bigint') && | ||
|
@@ -216,3 +228,21 @@ function isParentTSReadonlyPropertyDefinition(node: TSESTree.Literal): boolean { | |
|
||
return false; | ||
} | ||
|
||
/** | ||
* Checks if the node is part of a type indexed access (eg. Foo[4]) | ||
* @param node the node to be validated. | ||
* @returns true if the node is part of an indexed access | ||
* @private | ||
*/ | ||
function isAncestorTSIndexedAccessType(node: TSESTree.Literal): boolean { | ||
// Handle unary expressions (eg. -4) | ||
let ancestor = getLiteralParent(node); | ||
|
||
// Go up another level if we’re part of a type union (eg. 1 | 2) | ||
if (ancestor?.parent?.type === AST_NODE_TYPES.TSUnionType) { | ||
ancestor = ancestor.parent; | ||
} | ||
|
||
return ancestor?.parent?.type === AST_NODE_TYPES.TSIndexedAccessType; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -58,6 +58,42 @@ class Foo { | |
`, | ||
options: [{ ignoreReadonlyClassProperties: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[0];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[-1];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[0xab];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[5.6e1];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[10n];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[1 | -2];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: 'type Foo = Parameters<Bar>[2];', | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: "type Foo = Bar['baz'];", | ||
options: [{ ignoreTypeIndexes: true }], | ||
}, | ||
{ | ||
code: "type Foo = Bar['baz'];", | ||
options: [{ ignoreTypeIndexes: false }], | ||
}, | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A few edge cases we'll also want to test for: type Foo = Bar[1 & number]; type Other = {
[0]: 3;
}
type Foo = {
[K in keyof Other]: `${K & number}`;
}; type Foo = {
[K in 0 | 1 | 2]: 0;
}; type Others = [ ['a'], ['b'] ];
type Foo = {
[K in keyof Others[0]]: Others[K];
}; There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @JoshuaKGoldberg couple of quick questions on those:
Sure, I check for union types so intersection should be covered too! Thanks.
Since the Also, the
As above,
I’ll add a test to ensure the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great questions!
I'm not requesting changes to logic, just that it be covered. Agreed that they're different things -- the tests should validate that
Yes. That's already covered though; I'm really more interested in the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @JoshuaKGoldberg Thank you for clarifying. In af1ddb7 I added support for intersection types, nesting of union/intersection types, and the additional invalid test cases you suggested. |
||
], | ||
|
||
invalid: [ | ||
|
@@ -268,5 +304,111 @@ class Foo { | |
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[0];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '0', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[-1];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '-1', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[0xab];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '0xab', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[5.6e1];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '5.6e1', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[10n];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '10n', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Bar[1 | -2];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '1', | ||
}, | ||
line: 1, | ||
column: 16, | ||
}, | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '-2', | ||
}, | ||
line: 1, | ||
column: 20, | ||
}, | ||
], | ||
}, | ||
{ | ||
code: 'type Foo = Parameters<Bar>[2];', | ||
options: [{ ignoreTypeIndexes: false }], | ||
errors: [ | ||
{ | ||
messageId: 'noMagic', | ||
data: { | ||
raw: '2', | ||
}, | ||
line: 1, | ||
column: 28, | ||
}, | ||
], | ||
}, | ||
], | ||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Heh, it's a pity this docs page doesn't use the newer tabbed format others do. No need to change in this PR though; I'm going to try to make docs a bit more automated soon.