Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,7 @@ rules in templates can be disabled with eslint directives with mustache or html
| [no-observers](docs/rules/no-observers.md) | disallow usage of observers | ✅ | | |
| [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-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 | | | |

Expand Down
25 changes: 25 additions & 0 deletions docs/rules/template-deprecated-render-helper.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ember/template-deprecated-render-helper

> **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)
49 changes: 49 additions & 0 deletions lib/rules/template-deprecated-render-helper.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/** @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: null,
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) {
function checkForRender(node) {
if (
node.path &&
node.path.type === 'GlimmerPathExpression' &&
node.path.original === 'render'
) {
context.report({
node,
messageId: 'deprecated',
});
}
}

return {
GlimmerMustacheStatement(node) {
checkForRender(node);
},

GlimmerBlockStatement(node) {
checkForRender(node);
},
};
},
};
85 changes: 85 additions & 0 deletions tests/lib/rules/template-deprecated-render-helper.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
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: null,
errors: [{ messageId: 'deprecated' }],
},

{
code: "<template>{{render 'ken-griffey'}}</template>",
output: null,
errors: [{ messageId: 'deprecated' }],
},
{
code: "<template>{{render 'baseball-player' pitcher}}</template>",
output: null,
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: null,
errors: [
{
message:
'The render helper is deprecated in favor of using components. See https://emberjs.com/deprecations/v2.x/#toc_code-render-code-helper',
},
],
},
{
code: "{{render 'baseball-player' pitcher}}",
output: null,
errors: [
{
message:
'The render helper is deprecated in favor of using components. See https://emberjs.com/deprecations/v2.x/#toc_code-render-code-helper',
},
],
},
],
});
Loading