Extract rule: template-no-extra-mut-helper-argument

Author: NullVoxPopuli

README.md

@@ -344,9 +344,10 @@ rules in templates can be disabled with eslint directives with mustache or html
 
 ### Possible Errors
 
-| Name                                                                   | Description                             | 💼 | 🔧 | 💡 |
-| :--------------------------------------------------------------------- | :-------------------------------------- | :- | :- | :- |
-| [template-no-jsx-attributes](docs/rules/template-no-jsx-attributes.md) | disallow JSX-style camelCase attributes |    | 🔧 |    |
+| Name                                                                                         | Description                                               | 💼 | 🔧 | 💡 |
+| :------------------------------------------------------------------------------------------- | :-------------------------------------------------------- | :- | :- | :- |
+| [template-no-extra-mut-helper-argument](docs/rules/template-no-extra-mut-helper-argument.md) | disallow passing more than one argument to the mut helper |    |    |    |
+| [template-no-jsx-attributes](docs/rules/template-no-jsx-attributes.md)                       | disallow JSX-style camelCase attributes                   |    | 🔧 |    |
 
 ### Routes
 

docs/rules/template-no-extra-mut-helper-argument.md

@@ -0,0 +1,31 @@
+# ember/template-no-extra-mut-helper-argument
+
+> **HBS Only**: This rule applies to classic `.hbs` template files only (loose mode). It is not relevant for `gjs`/`gts` files (strict mode), where these patterns cannot occur.
+
+<!-- end auto-generated rule header -->
+
+Disallows passing more than one argument to the `mut` helper.
+
+A common mistake when using the Ember handlebars template `mut(attr)` helper is to pass an extra `value` parameter to it when only `attr` should be passed. Instead, the `value` should be passed outside of `mut`.
+
+## Examples
+
+This rule **forbids** the following:
+
+```hbs
+{{my-component click=(action (mut isClicked true))}}
+```
+
+This rule **allows** the following:
+
+```hbs
+{{my-component click=(action (mut isClicked) true)}}
+```
+
+## Related Rules
+
+- [template-no-mut-helper](template-no-mut-helper.md)
+
+## References
+
+- See the [documentation](https://emberjs.com/api/ember/release/classes/Ember.Templates.helpers/methods/mut?anchor=mut) for the Ember handlebars template `mut` helper

lib/rules/template-no-extra-mut-helper-argument.js

@@ -0,0 +1,44 @@
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: {
+      description: 'disallow passing more than one argument to the mut helper',
+      category: 'Possible Errors',
+      recommended: false,
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-extra-mut-helper-argument.md',
+      templateMode: 'loose',
+    },
+    fixable: null,
+    schema: [],
+    messages: {},
+    originallyFrom: {
+      name: 'ember-template-lint',
+      rule: 'lib/rules/no-extra-mut-helper-argument.js',
+      docs: 'docs/rule/no-extra-mut-helper-argument.md',
+      tests: 'test/unit/rules/no-extra-mut-helper-argument-test.js',
+    },
+  },
+
+  create(context) {
+    const ERROR_MESSAGE =
+      'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.';
+
+    return {
+      GlimmerSubExpression(node) {
+        if (
+          node.path &&
+          node.path.type === 'GlimmerPathExpression' &&
+          node.path.original === 'mut'
+        ) {
+          if (node.params && node.params.length > 1) {
+            context.report({
+              node,
+              message: ERROR_MESSAGE,
+            });
+          }
+        }
+      },
+    };
+  },
+};

tests/lib/rules/template-no-extra-mut-helper-argument.js

@@ -0,0 +1,99 @@
+const rule = require('../../../lib/rules/template-no-extra-mut-helper-argument');
+const RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-no-extra-mut-helper-argument', rule, {
+  valid: [
+    '<template>{{my-component click=(action (mut isClicked))}}</template>',
+    '<template>{{my-component click=(action (mut isClicked) true)}}</template>',
+    '<template>{{my-component isClickedMutable=(mut isClicked)}}</template>',
+    '<template><button {{action (mut isClicked)}}></button></template>',
+    '<template><button {{action (mut isClicked) true}}></button></template>',
+  ],
+  invalid: [
+    {
+      code: '<template>{{my-component click=(action (mut isClicked true))}}</template>',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+    {
+      code: '<template>{{my-component isClickedMutable=(mut isClicked true)}}</template>',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+    {
+      code: '<template><button {{action (mut isClicked true)}}></button></template>',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+  ],
+});
+
+const hbsRuleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser/hbs'),
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+});
+
+hbsRuleTester.run('template-no-extra-mut-helper-argument', rule, {
+  valid: [
+    '{{my-component click=(action (mut isClicked))}}',
+    '{{my-component click=(action (mut isClicked) true)}}',
+    '{{my-component isClickedMutable=(mut isClicked)}}',
+    '<button {{action (mut isClicked)}}></button>',
+    '<button {{action (mut isClicked) true}}></button>',
+  ],
+  invalid: [
+    {
+      code: '{{my-component click=(action (mut isClicked true))}}',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+    {
+      code: '{{my-component isClickedMutable=(mut isClicked true)}}',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+    {
+      code: '<button {{action (mut isClicked true)}}></button>',
+      output: null,
+      errors: [
+        {
+          message:
+            'The handlebars `mut(attr)` helper should only have one argument passed to it. To pass a value, use: `(action (mut attr) value)`.',
+        },
+      ],
+    },
+  ],
+});