Merge pull request #2451 from NullVoxPopuli/nvp/template-lint-extract-rule-template-deprecated-render-helper

Extract rule: template-deprecated-render-helper

Author: NullVoxPopuli

README.md

@@ -292,6 +292,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 | [no-old-shims](docs/rules/no-old-shims.md)                                                       | disallow usage of old shims for modules                   | ✅  | 🔧 |    |
 | [no-string-prototype-extensions](docs/rules/no-string-prototype-extensions.md)                   | disallow usage of `String` prototype extensions           | ✅  |    |    |
 | [template-deprecated-inline-view-helper](docs/rules/template-deprecated-inline-view-helper.md)   | disallow inline {{view}} helper                           |    | 🔧 |    |
+| [template-deprecated-render-helper](docs/rules/template-deprecated-render-helper.md)             | disallow {{render}} helper                                |    | 🔧 |    |
 | [template-no-action](docs/rules/template-no-action.md)                                           | disallow {{action}} helper                                |    |    |    |
 | [template-no-attrs-in-components](docs/rules/template-no-attrs-in-components.md)                 | disallow attrs in component templates                     |    |    |    |
 | [template-no-link-to-positional-params](docs/rules/template-no-link-to-positional-params.md)     | disallow positional params in LinkTo component            |    |    |    |

docs/rules/template-deprecated-render-helper.md

@@ -0,0 +1,27 @@
+# ember/template-deprecated-render-helper
+
+🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
+
+> **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 the {{render}} helper which is deprecated.
+
+## Examples
+
+Incorrect:
+
+```hbs
+{{render 'user'}}
+```
+
+Correct:
+
+```hbs
+<User />
+```
+
+## References
+
+- [eslint-plugin-ember template-deprecated-render-helper](https://github.com/ember-cli/eslint-plugin-ember/blob/master/docs/rules/template-deprecated-render-helper.md)

lib/rules/template-deprecated-render-helper.js

@@ -0,0 +1,73 @@
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow {{render}} helper',
+      category: 'Deprecations',
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-deprecated-render-helper.md',
+      templateMode: 'loose',
+    },
+    fixable: 'code',
+    schema: [],
+    messages: {
+      deprecated:
+        'The render helper is deprecated in favor of using components. See https://emberjs.com/deprecations/v2.x/#toc_code-render-code-helper',
+    },
+    originallyFrom: {
+      name: 'ember-template-lint',
+      rule: 'lib/rules/deprecated-render-helper.js',
+      docs: 'docs/rule/deprecated-render-helper.md',
+      tests: 'test/unit/rules/deprecated-render-helper-test.js',
+    },
+  },
+
+  create(context) {
+    const sourceCode = context.sourceCode;
+
+    function buildFix(node) {
+      const first = node.params[0];
+      if (!first || first.type !== 'GlimmerStringLiteral') {
+        return null;
+      }
+      const templateName = first.value;
+
+      if (node.params.length === 1) {
+        // {{render 'name'}} → {{name}}
+        return (fixer) => fixer.replaceText(node, `{{${templateName}}}`);
+      }
+
+      if (node.params.length === 2) {
+        // {{render 'name' model}} → {{name model=model}}
+        const model = sourceCode.getText(node.params[1]);
+        return (fixer) => fixer.replaceText(node, `{{${templateName} model=${model}}}`);
+      }
+
+      return null;
+    }
+
+    function checkForRender(node) {
+      if (
+        node.path &&
+        node.path.type === 'GlimmerPathExpression' &&
+        node.path.original === 'render'
+      ) {
+        context.report({
+          node,
+          messageId: 'deprecated',
+          fix: buildFix(node),
+        });
+      }
+    }
+
+    return {
+      GlimmerMustacheStatement(node) {
+        checkForRender(node);
+      },
+
+      GlimmerBlockStatement(node) {
+        checkForRender(node);
+      },
+    };
+  },
+};

tests/lib/rules/template-deprecated-render-helper.js

@@ -0,0 +1,74 @@
+const rule = require('../../../lib/rules/template-deprecated-render-helper');
+const RuleTester = require('eslint').RuleTester;
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-deprecated-render-helper', rule, {
+  valid: [
+    '<template><MyComponent /></template>',
+    '<template>{{this.render}}</template>',
+    '<template>{{valid-compoennt}}</template>',
+    '<template>{{input placeholder=(t "email") value=email}}</template>',
+    '<template>{{title "CrossCheck Web" prepent=true separator=" | "}}</template>',
+    '<template>{{hockey-player teamName="Boston Bruins"}}</template>',
+    '<template>{{false}}</template>',
+    '<template>{{"foo"}}</template>',
+    '<template>{{42}}</template>',
+    '<template>{{null}}</template>',
+    '<template>{{undefined}}</template>',
+  ],
+  invalid: [
+    {
+      code: '<template>{{render "user"}}</template>',
+      output: '<template>{{user}}</template>',
+      errors: [{ messageId: 'deprecated' }],
+    },
+    {
+      code: "<template>{{render 'ken-griffey'}}</template>",
+      output: '<template>{{ken-griffey}}</template>',
+      errors: [{ messageId: 'deprecated' }],
+    },
+    {
+      code: "<template>{{render 'baseball-player' pitcher}}</template>",
+      output: '<template>{{baseball-player model=pitcher}}</template>',
+      errors: [{ messageId: 'deprecated' }],
+    },
+  ],
+});
+
+const hbsRuleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser/hbs'),
+  parserOptions: {
+    ecmaVersion: 2022,
+    sourceType: 'module',
+  },
+});
+
+hbsRuleTester.run('template-deprecated-render-helper', rule, {
+  valid: [
+    '{{valid-compoennt}}',
+    '{{input placeholder=(t "email") value=email}}',
+    '{{title "CrossCheck Web" prepent=true separator=" | "}}',
+    '{{hockey-player teamName="Boston Bruins"}}',
+    '{{false}}',
+    '{{"foo"}}',
+    '{{42}}',
+    '{{null}}',
+    '{{undefined}}',
+  ],
+  invalid: [
+    {
+      code: "{{render 'ken-griffey'}}",
+      output: '{{ken-griffey}}',
+      errors: [{ messageId: 'deprecated' }],
+    },
+    {
+      code: "{{render 'baseball-player' pitcher}}",
+      output: '{{baseball-player model=pitcher}}',
+      errors: [{ messageId: 'deprecated' }],
+    },
+  ],
+});