eslint-plugin-eslint-config/lib/rules/no-invalid-config.js

ESLint rules for ESLint config files

"use strict";

var _experimentalUtils = require("@typescript-eslint/experimental-utils");

var _utils = require("./utils");

function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); keys.push.apply(keys, symbols); } return keys; }

function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }

function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }

const getNodeValue = node => {
  var _node$value$toString, _node$value;

  switch (node.type) {
    case _experimentalUtils.AST_NODE_TYPES.Identifier:
      return node.name;

    case _experimentalUtils.AST_NODE_TYPES.TemplateLiteral:
      return node.quasis[0].value.raw;

    default:
      return (_node$value$toString = (_node$value = node.value) === null || _node$value === void 0 ? void 0 : _node$value.toString()) !== null && _node$value$toString !== void 0 ? _node$value$toString : 'null';
  }
};

module.exports = _experimentalUtils.ESLintUtils.RuleCreator(name => name)({
  name: __filename,
  meta: {
    type: 'problem',
    docs: {
      description: 'Checks that the config exported by a file is valid',
      category: 'Best Practices',
      recommended: 'error'
    },
    messages: {
      FailedToLoadModule: "Cannot load {{ kind }} '{{ name }}' - is the package installed?",
      InvalidRuleConfig: "The config for '{{ ruleId }}' is invalid: {{ reason }}",
      ProcessorNotFound: "Cannot load processor '{{ name }}'",
      FailedToExtend: "Cannot extend '{{ name }}' - ensure file exists and exports a valid config",
      InvalidConfig: 'This config is invalid: {{ reason }}',
      UnknownError: 'An unknown error occurred: {{ message }}'
    },
    schema: []
  },
  defaultOptions: [],

  create(context) {
    const reportedErrors = new Set();

    const createErrorReporter = node => {
      const errorsReportedForNode = new Set();
      return error => {
        reportedErrors.add(error);
        const stringifiedError = JSON.stringify(_objectSpread(_objectSpread({}, error), {}, {
          path: undefined
        }));

        if (errorsReportedForNode.has(stringifiedError)) {
          return;
        }

        errorsReportedForNode.add(stringifiedError);
        context.report({
          messageId: error.type,
          data: _objectSpread({}, error),
          node,
          loc: node.loc
        });
      };
    };

    try {
      const {
        errors
      } = (0, _utils.getConfigInfo)(context.getSourceCode().getText());

      if (errors.length === 0) {
        return {};
      }

      return {
        [[_experimentalUtils.AST_NODE_TYPES.Identifier, _experimentalUtils.AST_NODE_TYPES.TemplateLiteral, _experimentalUtils.AST_NODE_TYPES.Literal].join()](node) {
          const reportError = createErrorReporter(node);
          const value = getNodeValue(node);
          errors.filter(error => {
            switch (error.type) {
              case _utils.ESLintErrorType.InvalidRuleConfig:
                return error.ruleId === value;

              case _utils.ESLintErrorType.FailedToExtend:
              case _utils.ESLintErrorType.FailedToLoadModule:
              case _utils.ESLintErrorType.ProcessorNotFound:
                return error.name === value;

              case _utils.ESLintErrorType.InvalidConfig:
              default:
                return false;
            }
          }).forEach(reportError);
        },

        [`${_experimentalUtils.AST_NODE_TYPES.Program}:exit`](node) {
          const reportError = createErrorReporter(node);
          errors.filter(error => !reportedErrors.has(error)).forEach(reportError);
        }

      };
    } catch (error) {
      return {
        Program(node) {
          context.report({
            messageId: 'UnknownError',
            data: {
              message: error.message
            },
            node
          });
        }

      };
    }
  }

});