Sync with ember-template-lint

NullVoxPopuli · NullVoxPopuli · commit c9c9fcb1e3b9 · 2026-03-21T12:54:44.000-04:00
diff --git a/README.md b/README.md
@@ -257,7 +257,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 | [template-no-obsolete-elements](docs/rules/template-no-obsolete-elements.md)                                       | disallow obsolete HTML elements                                              |    |    |    |
 | [template-no-outlet-outside-routes](docs/rules/template-no-outlet-outside-routes.md)                               | disallow {{outlet}} outside of route templates                               |    |    |    |
 | [template-no-page-title-component](docs/rules/template-no-page-title-component.md)                                 | disallow usage of ember-page-title component                                 |    |    |    |
-| [template-no-potential-path-strings](docs/rules/template-no-potential-path-strings.md)                             | disallow potential path strings in templates                                 |    |    |    |
+| [template-no-potential-path-strings](docs/rules/template-no-potential-path-strings.md)                             | disallow potential path strings in attribute values                          |    |    |    |
 | [template-no-splattributes-with-class](docs/rules/template-no-splattributes-with-class.md)                         | disallow splattributes with class attribute                                  |    |    |    |
 | [template-no-trailing-spaces](docs/rules/template-no-trailing-spaces.md)                                           | disallow trailing whitespace at the end of lines in templates                |    | 🔧 |    |
 | [template-no-unavailable-this](docs/rules/template-no-unavailable-this.md)                                         | disallow `this` in templates that are not inside a class or function         |    |    |    |
diff --git a/docs/rules/template-no-potential-path-strings.md b/docs/rules/template-no-potential-path-strings.md
@@ -2,69 +2,30 @@
 
 <!-- end auto-generated rule header -->
 
-Disallow potential path strings that should be dynamic values in templates.
-
-## Rule Details
-
 It might happen sometimes that `{{` and `}}` are forgotten when invoking a component, and the string that is passed was actually supposed to be a property path or argument.
 
-This rule warns about attribute values and text content that look like they should be dynamic paths. Specifically, it catches:
-
-- **Attribute values** that start with `this.` or `@` (e.g. `<img src="this.picture">` or `<img src="@img">`)
-- **Text content** that contains path-like strings (e.g. `<div>this.propertyName</div>` or `<div>foo.bar</div>`)
+This rule warns about all arguments and attributes that start with `this.` or `@`, but are missing the surrounding `{{` and `}}` characters.
 
 ## Examples
 
-Examples of **incorrect** code for this rule:
+This rule **forbids** the following:
 
-```gjs
-<template>
-  <img src="this.picture">
-</template>
+```hbs
+<img src='this.picture' />
 ```
 
-```gjs
-<template>
-  <img src="@img">
-</template>
+```hbs
+<img src='@img' />
 ```
 
-```gjs
-<template>
-  <div>this.propertyName</div>
-</template>
-```
-
-```gjs
-<template>
-  <div>foo.bar</div>
-</template>
-```
-
-Examples of **correct** code for this rule:
-
-```gjs
-<template>
-  <img src={{this.picture}}>
-</template>
-```
-
-```gjs
-<template>
-  <img src={{@img}}>
-</template>
-```
+This rule **allows** the following:
 
-```gjs
-<template>
-  <div>{{this.propertyName}}</div>
-</template>
+```hbs
+<img src={{this.picture}} />
 ```
 
-```gjs
-<template>
-  <div>{{this.foo.bar}}</div>
-</template>
+```hbs
+<img src={{@img}} />
 ```
 
 ## Migration
diff --git a/lib/rules/template-no-potential-path-strings.js b/lib/rules/template-no-potential-path-strings.js
@@ -1,19 +1,20 @@
+const FINE_SYMBOLS = ['|', '/', '\\'];
+
 /** @type {import('eslint').Rule.RuleModule} */
 module.exports = {
   meta: {
     type: 'suggestion',
     docs: {
-      description: 'disallow potential path strings in templates',
+      description: 'disallow potential path strings in attribute values',
       category: 'Best Practices',
-      recommended: false,
       url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-potential-path-strings.md',
       templateMode: 'both',
     },
     fixable: null,
     schema: [],
     messages: {
       noPotentialPathStrings:
-        'Potential path string detected. Use dynamic values instead of path strings.',
+        'Potential path in attribute string detected. Did you mean {{{{path}}}}?',
     },
     originallyFrom: {
       name: 'ember-template-lint',
@@ -24,36 +25,20 @@ module.exports = {
   },
 
   create(context) {
-    const attrTextNodes = new WeakSet();
-
     return {
       GlimmerAttrNode(node) {
-        if (node.value && node.value.type === 'GlimmerTextNode') {
-          attrTextNodes.add(node.value);
-          const text = node.value.chars;
-          // Check for potential paths in attribute values:
-          // - this.something (should be {{this.something}})
-          // - @argName without / \ | (should be {{@argName}})
-          if (/^this\.\w+/.test(text) || /^@[\w-]+$/.test(text)) {
-            context.report({
-              node: node.value,
-              messageId: 'noPotentialPathStrings',
-            });
-          }
-        }
-      },
-
-      GlimmerTextNode(node) {
-        if (!node.chars || attrTextNodes.has(node)) {
+        if (!node.value || node.value.type !== 'GlimmerTextNode') {
           return;
         }
 
-        // Check if text content looks like it could be a path (e.g., "foo.bar" or "this.foo")
-        const pathPattern = /\b(this\.\w+|\w+\.\w+)\b/;
-        if (pathPattern.test(node.chars)) {
+        const chars = node.value.chars;
+        const hasSpecialPrefix = chars.startsWith('this.') || chars.startsWith('@');
+
+        if (hasSpecialPrefix && !FINE_SYMBOLS.some((symbol) => chars.includes(symbol))) {
           context.report({
-            node,
+            node: node.value,
             messageId: 'noPotentialPathStrings',
+            data: { path: chars },
           });
         }
       },
diff --git a/tests/lib/rules/template-no-potential-path-strings.js b/tests/lib/rules/template-no-potential-path-strings.js
@@ -8,31 +8,6 @@ const ruleTester = new RuleTester({
 
 ruleTester.run('template-no-potential-path-strings', rule, {
   valid: [
-    {
-      filename: 'my-component.gjs',
-      code: `
-        import Component from '@glimmer/component';
-        export default class MyComponent extends Component {
-          <template>
-            <div>{{this.propertyName}}</div>
-          </template>
-        }
-      `,
-      output: null,
-    },
-    {
-      filename: 'my-component.gjs',
-      code: `
-        import Component from '@glimmer/component';
-        export default class MyComponent extends Component {
-          <template>
-            <div>Hello world</div>
-          </template>
-        }
-      `,
-      output: null,
-    },
-
     '<template><img src="foo.png"></template>',
     '<template><img src={{picture}}></template>',
     '<template><img src={{this.picture}}></template>',
@@ -45,69 +20,58 @@ ruleTester.run('template-no-potential-path-strings', rule, {
 
   invalid: [
     {
-      filename: 'my-component.gjs',
-      code: `
-        import Component from '@glimmer/component';
-        export default class MyComponent extends Component {
-          <template>
-            <div>this.propertyName</div>
-          </template>
-        }
-      `,
+      code: '<template><img src="this.picture"></template>',
       output: null,
       errors: [
         {
-          messageId: 'noPotentialPathStrings',
+          message: 'Potential path in attribute string detected. Did you mean {{this.picture}}?',
         },
       ],
     },
     {
-      filename: 'my-component.gjs',
-      code: `
-        import Component from '@glimmer/component';
-        export default class MyComponent extends Component {
-          <template>
-            <div>foo.bar</div>
-          </template>
-        }
-      `,
+      code: '<template><img src=this.picture></template>',
       output: null,
       errors: [
         {
-          messageId: 'noPotentialPathStrings',
+          message: 'Potential path in attribute string detected. Did you mean {{this.picture}}?',
         },
       ],
     },
-
-    {
-      code: '<template><img src="this.picture"></template>',
-      output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
-    },
-    {
-      code: '<template><img src=this.picture></template>',
-      output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
-    },
     {
       code: '<template><img src="@img"></template>',
       output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
+      errors: [
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@img}}?',
+        },
+      ],
     },
     {
       code: '<template><img src=@img></template>',
       output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
+      errors: [
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@img}}?',
+        },
+      ],
     },
     {
       code: '<template><SomeComponent @foo=@bar /></template>',
       output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
+      errors: [
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@bar}}?',
+        },
+      ],
     },
     {
       code: '<template><SomeComponent @foo=this.bar /></template>',
       output: null,
-      errors: [{ messageId: 'noPotentialPathStrings' }],
+      errors: [
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{this.bar}}?',
+        },
+      ],
     },
   ],
 });
@@ -136,42 +100,54 @@ hbsRuleTester.run('template-no-potential-path-strings', rule, {
       code: '<img src="this.picture">',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{this.picture}}?',
+        },
       ],
     },
     {
       code: '<img src=this.picture>',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{this.picture}}?',
+        },
       ],
     },
     {
       code: '<img src="@img">',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@img}}?',
+        },
       ],
     },
     {
       code: '<img src=@img>',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@img}}?',
+        },
       ],
     },
     {
       code: '<SomeComponent @foo=@bar />',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{@bar}}?',
+        },
       ],
     },
     {
       code: '<SomeComponent @foo=this.bar />',
       output: null,
       errors: [
-        { message: 'Potential path string detected. Use dynamic values instead of path strings.' },
+        {
+          message: 'Potential path in attribute string detected. Did you mean {{this.bar}}?',
+        },
       ],
     },
   ],
