Skip to content
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

Jump to bottom

fix(eslint-plugin): [no-unsafe-enum-comparison] exempt bit shift operators #7074

Merged
merged 8 commits into from Jul 17, 2023
Merged

fix(eslint-plugin): [no-unsafe-enum-comparison] exempt bit shift operators #7074

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
fc2e58a
fix: exempt bit shift operators
Melandra May 29, 2023
73cc801
Merge branch 'main' into issue-7067-exempt-bit-shift-operator
Melandra May 29, 2023
1b61903
Add test for other bit shift operator
Melandra May 29, 2023
3d812c6
fix: extend regex to replace if statement
Melandra May 31, 2023
68938c5
fix: use more precise regex
Melandra May 31, 2023
4f60061
Merge branch 'main' into issue-7067-exempt-bit-shift-operator
Melandra Jun 6, 2023
160597e
Merge branch 'main' into issue-7067-exempt-bit-shift-operator
Melandra Jun 16, 2023
1d286cb
Merge branch 'main' into issue-7067-exempt-bit-shift-operator
JoshuaKGoldberg Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 13 additions & 0 deletions packages/eslint-plugin/src/rules/no-unsafe-enum-comparison.ts
View file
Open in desktop
Expand Up @@ -66,6 +66,19 @@ export default util.createRule({
'BinaryExpression[operator=/=|<|>/]'(
Copy link
Member

@Josh-Cena Josh-Cena May 31, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
'BinaryExpression[operator=/=|<|>/]'(
'BinaryExpression[operator=/^(<>!)?={0,2}$/]'(

...Much simpler? Otherwise you will also need to remember to deal with >>>.

Copy link
Contributor Author

@Melandra Melandra May 31, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the suggestion, please see 68938c5, I've replaced the regex with ^[<>!=]?={0,2}$ instead to also match ===

node: TSESTree.BinaryExpression,
): void {
// Exempt bit shift operators since they are not comparisons
//
// ```ts
// enum Fruit {
// Apple,
// }
//
// const myBitShift = 1 << Fruit.Apple;
// ```
Melandra marked this conversation as resolved.
Show resolved Hide resolved
if (node.operator === '>>' || node.operator === '<<') {
Melandra marked this conversation as resolved.
Show resolved Hide resolved
return;
}

const left = getTypeFromNode(node.left);
const right = getTypeFromNode(node.right);

Expand Down
14 changes: 14 additions & 0 deletions packages/eslint-plugin/tests/rules/no-unsafe-enum-comparison.test.ts
View file
Open in desktop
Expand Up @@ -290,6 +290,20 @@ ruleTester.run('strict-enums-comparison', rule, {
num === someFunction;
mixed === someFunction;
`,
`
enum Fruit {
Apple,
}

const bitShift = 1 << Fruit.Apple;
`,
`
enum Fruit {
Apple,
}

const bitShift = 1 >> Fruit.Apple;
`,
],
invalid: [
{
Expand Down