From 21b8b87852f40e7f1deba077ec7729da3cacdca7 Mon Sep 17 00:00:00 2001
From: Daniel Bevenius <daniel.bevenius@gmail.com>
Date: Tue, 20 Jun 2017 08:30:47 +0200
Subject: [PATCH] tools: add eslint rule for inspector checking

The motivation for this commit is to pick up early on missing checks for
inspector support (when Node is built --without-inspector).

PR-URL: https://github.com/nodejs/node/pull/13813
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Teddy Katz <teddy.katz@gmail.com>
---
 test/.eslintrc.yaml                   |  1 +
 tools/eslint-rules/inspector-check.js | 43 +++++++++++++++++++++++++++
 2 files changed, 44 insertions(+)
 create mode 100644 tools/eslint-rules/inspector-check.js

diff --git a/test/.eslintrc.yaml b/test/.eslintrc.yaml
index b571d3a1b6..58e072c195 100644
--- a/test/.eslintrc.yaml
+++ b/test/.eslintrc.yaml
@@ -11,5 +11,6 @@ rules:
   prefer-assert-methods: error
   prefer-common-mustnotcall: error
   crypto-check: error
+  inspector-check: error
   ## common module is mandatory in tests
   required-modules: [error, common]
diff --git a/tools/eslint-rules/inspector-check.js b/tools/eslint-rules/inspector-check.js
new file mode 100644
index 0000000000..f225b34cb6
--- /dev/null
+++ b/tools/eslint-rules/inspector-check.js
@@ -0,0 +1,43 @@
+/**
+ * @fileoverview Check that common.skipIfInspectorDisabled is used if
+ *               the inspector module is required.
+ * @author Daniel Bevenius <daniel.bevenius@gmail.com>
+ */
+'use strict';
+
+const utils = require('./rules-utils.js');
+
+//------------------------------------------------------------------------------
+// Rule Definition
+//------------------------------------------------------------------------------
+const msg = 'Please add a skipIfInspectorDisabled() call to allow this ' +
+            'test to be skippped when Node is built \'--without-inspector\'.';
+
+module.exports = function(context) {
+  var usesInspector = false;
+  var hasInspectorCheck = false;
+
+  function testInspectorUsage(context, node) {
+    if (utils.isRequired(node, ['inspector'])) {
+      usesInspector = true;
+    }
+  }
+
+  function checkMemberExpression(context, node) {
+    if (utils.usesCommonProperty(node, ['skipIfInspectorDisabled'])) {
+      hasInspectorCheck = true;
+    }
+  }
+
+  function reportIfMissing(context, node) {
+    if (usesInspector && !hasInspectorCheck) {
+      context.report(node, msg);
+    }
+  }
+
+  return {
+    'CallExpression': (node) => testInspectorUsage(context, node),
+    'MemberExpression': (node) => checkMemberExpression(context, node),
+    'Program:exit': (node) => reportIfMissing(context, node)
+  };
+};