summaryrefslogtreecommitdiff
path: root/tools/eslint-rules/prefer-common-mustnotcall.js
diff options
context:
space:
mode:
Diffstat (limited to 'tools/eslint-rules/prefer-common-mustnotcall.js')
-rw-r--r--tools/eslint-rules/prefer-common-mustnotcall.js39
1 files changed, 39 insertions, 0 deletions
diff --git a/tools/eslint-rules/prefer-common-mustnotcall.js b/tools/eslint-rules/prefer-common-mustnotcall.js
new file mode 100644
index 0000000000..6bc428ed59
--- /dev/null
+++ b/tools/eslint-rules/prefer-common-mustnotcall.js
@@ -0,0 +1,39 @@
+/**
+ * @fileoverview Prefer common.mustNotCall(msg) over common.mustCall(fn, 0)
+ * @author James M Snell <jasnell@gmail.com>
+ */
+'use strict';
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+
+const msg = 'Please use common.mustNotCall(msg) instead of ' +
+ 'common.mustCall(fn, 0) or common.mustCall(0).';
+
+function isCommonMustCall(node) {
+ return node &&
+ node.callee &&
+ node.callee.object &&
+ node.callee.object.name === 'common' &&
+ node.callee.property &&
+ node.callee.property.name === 'mustCall';
+}
+
+function isArgZero(argument) {
+ return argument &&
+ typeof argument.value === 'number' &&
+ argument.value === 0;
+}
+
+module.exports = function(context) {
+ return {
+ CallExpression(node) {
+ if (isCommonMustCall(node) &&
+ (isArgZero(node.arguments[0]) || // catch common.mustCall(0)
+ isArgZero(node.arguments[1]))) { // catch common.mustCall(fn, 0)
+ context.report(node, msg);
+ }
+ }
+ };
+};