Skip to content

fix(eslint-plugin): [no-magic-numbers] Support negative numbers #1072

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 2 commits into from
Oct 16, 2019
Merged

fix(eslint-plugin): [no-magic-numbers] Support negative numbers #1072

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
278cb38
fix(eslint-plugin): ignore negative numbers for readonly properties
a-tarasyuk Oct 11, 2019
bb0e6a0
Merge branch 'master' into bug/1070-no-magic-numbers-false-positive-f…
bradzacher Oct 16, 2019
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
55 changes: 44 additions & 11 deletions packages/eslint-plugin/src/rules/no-magic-numbers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,11 +160,23 @@ export default util.createRule<Options, MessageIds>({
* @private
*/
function isParentTSReadonlyClassProperty(node: TSESTree.Node): boolean {
return (
!!node.parent &&
if (
node.parent &&
node.parent.type === AST_NODE_TYPES.UnaryExpression &&
['-', '+'].includes(node.parent.operator)
) {
node = node.parent;
}

if (
node.parent &&
node.parent.type === AST_NODE_TYPES.ClassProperty &&
!!node.parent.readonly
);
node.parent.readonly
) {
return true;
}

return false;
}

return {
Expand All @@ -174,13 +186,6 @@ export default util.createRule<Options, MessageIds>({
return;
}

if (
options.ignoreReadonlyClassProperties &&
isParentTSReadonlyClassProperty(node)
) {
return;
}

// Check TypeScript specific nodes for Numeric Literal
if (
options.ignoreNumericLiteralTypes &&
Expand All @@ -190,6 +195,34 @@ export default util.createRule<Options, MessageIds>({
return;
}

// Check if the node is a readonly class property
if (isNumber(node) && isParentTSReadonlyClassProperty(node)) {
if (options.ignoreReadonlyClassProperties) {
return;
}

let fullNumberNode:
| TSESTree.Literal
| TSESTree.UnaryExpression = node;
let raw = node.raw;

if (
node.parent &&
node.parent.type === AST_NODE_TYPES.UnaryExpression
) {
fullNumberNode = node.parent;
raw = `${node.parent.operator}${node.raw}`;
}

context.report({
messageId: 'noMagic',
node: fullNumberNode,
data: { raw },
});

return;
}

// Let the base rule deal with the rest
rules.Literal(node);
},
Expand Down
14 changes: 14 additions & 0 deletions packages/eslint-plugin/tests/rules/no-magic-numbers.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,8 @@ class Foo {
readonly B = 2;
public static readonly C = 1;
static readonly D = 1;
readonly E = -1;
readonly F = +1;
}
`,
options: [{ ignoreReadonlyClassProperties: true }],
Expand Down Expand Up @@ -184,6 +186,8 @@ class Foo {
readonly B = 2;
public static readonly C = 1;
static readonly D = 1;
readonly E = -1;
readonly F = +1;
}
`,
options: [{ ignoreReadonlyClassProperties: false }],
Expand All @@ -208,6 +212,16 @@ class Foo {
line: 6,
column: 23,
},
{
messageId: 'noMagic',
line: 7,
column: 16,
},
{
messageId: 'noMagic',
line: 8,
column: 16,
},
],
},
],
Expand Down