no-missing-placeholders.js

/**
 * @fileoverview Disallow missing placeholders in rule report messages
 * @author Teddy Katz
 */

'use strict';

const utils = require('../utils');
const { getStaticValue } = require('eslint-utils');

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

module.exports = {
  meta: {
    type: 'problem',
    docs: {
      description: 'disallow missing placeholders in rule report messages',
      category: 'Rules',
      recommended: true,
    },
    fixable: null,
    schema: [],
    messages: {
      placeholderDoesNotExist: 'The placeholder {{{{missingKey}}}} does not exist.',
    },
  },

  create (context) {
    let contextIdentifiers;

    // ----------------------------------------------------------------------
    // Public
    // ----------------------------------------------------------------------

    return {
      Program (ast) {
        contextIdentifiers = utils.getContextIdentifiers(context, ast);
      },
      CallExpression (node) {
        if (
          node.callee.type === 'MemberExpression' &&
          contextIdentifiers.has(node.callee.object) &&
          node.callee.property.type === 'Identifier' && node.callee.property.name === 'report'
        ) {
          const reportInfo = utils.getReportInfo(node.arguments, context);
          if (!reportInfo || !reportInfo.message) {
            return;
          }

          const messageStaticValue = getStaticValue(reportInfo.message, context.getScope());
          if (
            (
              (reportInfo.message.type === 'Literal' && typeof reportInfo.message.value === 'string') ||
              (messageStaticValue && typeof messageStaticValue.value === 'string')
            ) &&
            (!reportInfo.data || reportInfo.data.type === 'ObjectExpression')
          ) {
            // Same regex as the one ESLint uses
            // https://github.com/eslint/eslint/blob/e5446449d93668ccbdb79d78cc69f165ce4fde07/lib/eslint.js#L990
            const PLACEHOLDER_MATCHER = /{{\s*([^{}]+?)\s*}}/g;
            let match;

            while ((match = PLACEHOLDER_MATCHER.exec(reportInfo.message.value || messageStaticValue.value))) { // eslint-disable-line no-extra-parens
              const matchingProperty = reportInfo.data &&
                reportInfo.data.properties.find(prop => utils.getKeyName(prop) === match[1]);

              if (!matchingProperty) {
                context.report({
                  node: reportInfo.message,
                  messageId: 'placeholderDoesNotExist',
                  data: { missingKey: match[1] },
                });
              }
            }
          }
        }
      },
    };
  },
};