eslint-plugin-ember/lib/rules/template-no-mut-helper.js

ESLint plugin for Ember.js apps

/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
  meta: {
    type: 'suggestion',
    docs: {
      description: 'disallow usage of (mut) helper',
      category: 'Best Practices',
      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-mut-helper.md',
      templateMode: 'both',
    },
    fixable: null,
    schema: [
      {
        type: 'object',
        properties: {
          setterAlternative: { type: 'string' },
        },
        additionalProperties: false,
      },
    ],
    messages: {
      noMutHelper: '{{message}}',
    },
    originallyFrom: {
      name: 'ember-template-lint',
      rule: 'lib/rules/no-mut-helper.js',
      docs: 'docs/rule/no-mut-helper.md',
      tests: 'test/unit/rules/no-mut-helper-test.js',
    },
  },

  create(context) {
    const options = context.options[0] || {};
    const rawSetterAlternative = options.setterAlternative;
    // If the user already wrapped their expression in `{{...}}`, strip it so we
    // don't end up with `{{{{...}}}}` in the error message.
    const setterAlternative =
      typeof rawSetterAlternative === 'string'
        ? rawSetterAlternative.replace(/^{{([\S\s]*)}}$/, '$1').trim()
        : rawSetterAlternative;
    const message = setterAlternative
      ? `Do not use the (mut) helper. Consider using a JS action or {{${setterAlternative}}} instead.`
      : 'Do not use the (mut) helper. Use regular setters or actions instead.';

    function checkNode(node) {
      if (node.path?.type === 'GlimmerPathExpression' && node.path.original === 'mut') {
        context.report({
          node,
          messageId: 'noMutHelper',
          data: { message },
        });
      }
    }

    return {
      GlimmerSubExpression: checkNode,
      GlimmerMustacheStatement: checkNode,
    };
  },
};