eslint-plugin-ember/lib/rules/no-invalid-debug-function-arguments.js

Eslint plugin for Ember.js apps

'use strict';

const types = require('../utils/types');
const emberUtils = require('../utils/ember');

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

function getErrorMessage(debugFunction) {
  return `Usage of Ember's \`${debugFunction}\` function has its arguments passed in the wrong order. \`String description\` should come before \`Boolean condition\`.`;
}

const DEBUG_FUNCTIONS = ['assert', 'deprecate', 'warn'];

module.exports = {
  meta: {
    docs: {
      description:
        "Catch usages of Ember's `assert()` / `warn()` / `deprecate()` functions that have the arguments passed in the wrong order.",
      category: 'Possible Errors',
      recommended: true,
    },
    fixable: null,
  },

  getErrorMessage,
  DEBUG_FUNCTIONS,

  create(context) {
    return {
      CallExpression(node) {
        if (isDebugFunctionWithReversedArgs(node)) {
          context.report({
            node,
            message: getErrorMessage(getDebugFunction(node)),
          });
        }
      },
    };
  },
};

function isDebugFunctionWithReversedArgs(node) {
  return (
    isDebugFunction(node) &&
    node.arguments.length >= 2 &&
    !types.isString(node.arguments[0]) &&
    types.isString(node.arguments[1])
  );
}

function isDebugFunction(node) {
  return getDebugFunction(node) !== undefined;
}

function getDebugFunction(node) {
  return DEBUG_FUNCTIONS.find(
    debugFunction =>
      emberUtils.isModule(node, debugFunction) &&
      (!node.callee.property || node.callee.property.name === debugFunction)
  );
}