real configuration

Author: ef4

lib/rules/template-missing-invokable.js

@@ -1,16 +1,31 @@
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
-    type: 'suggestion',
+    type: 'problem',
     docs: {
-      description: 'disallow referencing let variables in \\<template\\>',
+      description:
+        'disallow missing helpers, modifiers, or components in \\<template\\> with auto-fix to import them',
       category: 'Ember Octane',
-      recommendedGjs: false,
-      recommendedGts: false,
       url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-missing-invokable.md',
     },
     fixable: 'code',
-    schema: [],
+    schema: [
+      {
+        type: 'object',
+        properties: {
+          invokables: {
+            type: 'object',
+            additionalProperties: {
+              type: 'array',
+              prefixItems: [
+                { type: 'string', description: 'The name to import from the module' },
+                { type: 'string', description: 'The module to import from' },
+              ],
+            },
+          },
+        },
+      },
+    ],
     messages: {
       'missing-invokable':
         'Not in scope. Did you forget to import this? Auto-fix may be configured.',
@@ -20,25 +35,20 @@ module.exports = {
   create: (context) => {
     const sourceCode = context.sourceCode;
 
-    // TODO make real config
-    const config = {
-      eq: { name: 'eq', module: 'ember-truth-helpers' },
-      on: { name: 'on', module: '@ember/modifier' },
-    };
-
     // takes a node with a `.path` property
     function checkInvokable(node) {
       if (node.path.type === 'GlimmerPathExpression' && node.path.tail.length === 0) {
         if (!isBound(node.path.head, sourceCode.getScope(node.path))) {
-          const matched = config[node.path.head.name];
+          const matched = context.options[0]?.invokables?.[node.path.head.name];
           if (matched) {
+            const [name, module] = matched;
             context.report({
               node: node.path,
               messageId: 'missing-invokable',
               fix(fixer) {
                 return fixer.insertTextBeforeRange(
                   [0, 0],
-                  `import { ${matched.name} } from '${matched.module}';\n`
+                  `import { ${name} } from '${module}';\n`
                 );
               },
             });
@@ -64,7 +74,6 @@ module.exports = {
 function isBound(node, scope) {
   const ref = scope.references.find((v) => v.identifier === node);
   if (!ref) {
-    // TODO: can we make a test case for this?
     return false;
   }
   return Boolean(ref.resolved);

tests/lib/rules/template-missing-invokable.js

@@ -85,6 +85,14 @@ ruleTester.run('template-missing-invokable', rule, {
         {{/if}}
       </template>
       `,
+      options: [
+        {
+          invokables: {
+            eq: ['eq', 'ember-truth-helpers'],
+          },
+        },
+      ],
+
       errors: [{ type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] }],
     },
 
@@ -101,6 +109,13 @@ ruleTester.run('template-missing-invokable', rule, {
         {{eq 1 1}}
       </template>
     `,
+      options: [
+        {
+          invokables: {
+            eq: ['eq', 'ember-truth-helpers'],
+          },
+        },
+      ],
       errors: [{ type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] }],
     },
     {
@@ -117,6 +132,13 @@ ruleTester.run('template-missing-invokable', rule, {
         <MyComponent @flag={{eq 1 1}} />
       </template>
     `,
+      options: [
+        {
+          invokables: {
+            eq: ['eq', 'ember-truth-helpers'],
+          },
+        },
+      ],
       errors: [{ type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] }],
     },
 
@@ -135,6 +157,13 @@ ruleTester.run('template-missing-invokable', rule, {
           <button {{on "click" doSomething}}>Go</button>
         </template>
       `,
+      options: [
+        {
+          invokables: {
+            on: ['on', '@ember/modifier'],
+          },
+        },
+      ],
       errors: [{ type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] }],
     },
     // Multiple copies of a fixable invocation
@@ -172,6 +201,13 @@ ruleTester.run('template-missing-invokable', rule, {
           {{/if}}
         </template>
       `,
+      options: [
+        {
+          invokables: {
+            eq: ['eq', 'ember-truth-helpers'],
+          },
+        },
+      ],
       errors: [
         { type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] },
         { type: 'GlimmerPathExpression', message: rule.meta.messages['missing-invokable'] },