ember-template-lint/lib/rules/no-action-modifiers.js

Linter for Ember or Handlebars templates.

import createErrorMessage from '../helpers/create-error-message.js';
import Rule from './_base.js';
import { builders as b } from 'ember-template-recast';

const ERROR_MESSAGE = 'Do not use the `action` modifier. Instead, use the `on` modifier.';

export default class NoActionModifiers extends Rule {
  parseConfig(config) {
    switch (typeof config) {
      case 'boolean': {
        if (config) {
          return { allowlist: [] };
        } else {
          return false;
        }
      }
      case 'object': {
        if (Array.isArray(config)) {
          return { allowlist: config };
        }
        break;
      }
      case 'undefined': {
        return false;
      }
    }

    let errorMessage = createErrorMessage(
      this.ruleName,
      ['  * array of strings - tag names of elements that can accept {{action}} modifiers'],
      config
    );

    throw new Error(errorMessage);
  }

  /**
   * @returns {import('./types.js').VisitorReturnType<NoActionModifiers>}
   */
  visitor() {
    return {
      ElementModifierStatement(node, { parentNode }) {
        let modifierName = node.path.original;
        if (modifierName !== 'action') {
          return;
        }

        if (this.config.allowlist.includes(parentNode.tag)) {
          return;
        }

        let [maybePath, ...args] = node.params;
        let couldFix = maybePath && maybePath.type === 'PathExpression';

        if (this.mode === 'fix') {
          node.path.original = 'on';
          if (args.length === 0) {
            node.params.unshift(b.string('click'));
          } else {
            node.params = [b.string('click'), b.sexpr(b.path('fn'), [maybePath, ...args])];
          }
        } else {
          this.log({
            message: ERROR_MESSAGE,
            node,
            source: this.sourceForNode(parentNode),
            isFixable: couldFix,
          });
        }
      },
    };
  }
}