tools: add rule prefering common.mustNotCall()

Prefer using `common.mustNotCall()` over `common.mustCall(fn, 0)` PR-URL: #12027 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]> Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]>
nodejs · Aug 16, 2017 · 7bb200f · 7bb200f
1 parent a7b9450
commit 7bb200f
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/test/.eslintrc.yaml b/test/.eslintrc.yaml
@@ -6,6 +6,9 @@ rules:
   no-var: 2
   prefer-const: 2
 
+  # Custom rules in tools/eslint-rules
+  prefer-common-mustnotcall: 2
+
   ## common module is mandatory in tests
   required-modules: [2, common]
   prefer-assert-methods: 2
diff --git a/tools/eslint-rules/prefer-common-mustnotcall.js 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 <[email protected]>
+ */
+'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);
+      }
+    }
+  };
+};