no-magic-numbers.js
4.39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/**
* @fileoverview Rule to flag statements that use magic numbers (adapted from https://github.com/danielstjules/buddy.js)
* @author Vincent Lemeunier
* @copyright 2015 Vincent Lemeunier. All rights reserved.
*
* This rule was adapted from danielstjules/buddy.js
* The MIT License (MIT)
*
* Copyright (c) 2014 Daniel St. Jules
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* See LICENSE file in root directory for full license.
*/
"use strict";
//------------------------------------------------------------------------------
// Rule Definition
//------------------------------------------------------------------------------
module.exports = function(context) {
var config = context.options[0] || {},
ignore = config.ignore || [0, 1, 2],
detectObjects = !!config.detectObjects,
enforceConst = !!config.enforceConst;
/**
* Returns whether the node is number literal
* @param {Node} node - the node literal being evaluated
* @returns {boolean} true if the node is a number literal
*/
function isNumber(node) {
return typeof node.value === "number";
}
/**
* Returns whether the number should be ignored
* @param {number} num - the number
* @returns {boolean} true if the number should be ignored
*/
function shouldIgnoreNumber(num) {
return ignore.indexOf(num) !== -1;
}
return {
"Literal": function(node) {
var parent = node.parent,
value = node.value,
raw = node.raw,
okTypes = detectObjects ? [] : ["ObjectExpression", "Property", "AssignmentExpression"];
if (!isNumber(node)) {
return;
}
if (parent.type === "UnaryExpression" && parent.operator === "-") {
node = parent;
parent = node.parent;
value = -value;
raw = "-" + raw;
}
if (shouldIgnoreNumber(value)) {
return;
}
// don't warn on parseInt() or Number.parseInt() radix
if (parent.type === "CallExpression" && node === parent.arguments[1] &&
(parent.callee.name === "parseInt" ||
parent.callee.type === "MemberExpression" &&
parent.callee.object.name === "Number" &&
parent.callee.property.name === "parseInt")
) {
return;
}
if (parent.type === "VariableDeclarator") {
if (enforceConst && parent.parent.kind !== "const") {
context.report({
node: node,
message: "Number constants declarations must use 'const'"
});
}
} else if (okTypes.indexOf(parent.type) === -1) {
context.report({
node: node,
message: "No magic number: " + raw
});
}
}
};
};
module.exports.schema = [{
"type": "object",
"properties": {
"detectObjects": {
"type": "boolean"
},
"enforceConst": {
"type": "boolean"
},
"ignore": {
"type": "array",
"items": {
"type": "number"
},
"uniqueItems": true
}
},
"additionalProperties": false
}];