nodejs/tools/eslint-rules/inspector-check.js

/**
 * @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 skipped when Node is built \'--without-inspector\'.';

module.exports = {
  meta: {
    fixable: 'code',
  },
  create(context) {
    const missingCheckNodes = [];
    let commonModuleNode = null;
    let hasInspectorCheck = false;

    function testInspectorUsage(context, node) {
      if (utils.isRequired(node, ['inspector'])) {
        missingCheckNodes.push(node);
      }

      if (utils.isCommonModule(node)) {
        commonModuleNode = node;
      }
    }

    function checkMemberExpression(context, node) {
      if (utils.usesCommonProperty(node, ['skipIfInspectorDisabled'])) {
        hasInspectorCheck = true;
      }
    }

    function reportIfMissing(context) {
      if (!hasInspectorCheck) {
        missingCheckNodes.forEach((node) => {
          context.report({
            node,
            message: msg,
            fix: (fixer) => {
              if (commonModuleNode) {
                return fixer.insertTextAfter(
                  commonModuleNode,
                  '\ncommon.skipIfInspectorDisabled();',
                );
              }
            },
          });
        });
      }
    }

    return {
      'CallExpression': (node) => testInspectorUsage(context, node),
      'MemberExpression': (node) => checkMemberExpression(context, node),
      'Program:exit': () => reportIfMissing(context),
    };
  },
};