Add new rule no-at-ember-render-modifiers

docs/rule/no-at-ember-render-modifiers.md

@@ -0,0 +1,51 @@
+# no-at-ember-render-modifiers
+
+`@ember/render-modifiers` were meant as a transitional tool from the pre-Octane era, and not long-term usage.
+
+More information about this can be found on the [`@ember/render-modifiers` README](https://github.com/emberjs/ember-render-modifiers#when-to-use-these-modifiers-and-when-not-to-use-them).
+
+## Examples
+
+This rule **forbids** the following:
+
+```hbs
+<div {{did-insert this.someFunction}}>
+```
+
+```hbs
+<div {{did-update this.someFunction}}>
+```
+
+```hbs
+<div {{will-destroy this.someFunction}}>
+```
+
+## Migration
+
+The migration path typically depends on what the render-modifier was used for, but if you need a custom modifier, the [`ember-modifier` README](https://github.com/ember-modifier/ember-modifier) covers everything you need to know for making custom modifiers.
+
+For example, if render modifiers were used for setup/teardown, the migration to `ember-modifier` could be the following:
+
+```js
+import Component from '@glimmer/component';
+import { modifier } from 'ember-modifier';
+
+export default class MyComponent extends Component {
+  myModifier = modifier((element) => {
+    let handleEvent = () => {};
+
+    element.addEventListener('eventName', handleEvent);
+
+    return () => element.removeEventListener('eventName', handelEvent);
+  });
+}
+```
+
+```hbs
+<div {{this.myModifier}}>
+```
+
+## References
+
+- [`@ember/render-modifiers`](https://github.com/emberjs/ember-render-modifiers) (deprecated)
+- [`ember-modifier`](https://github.com/ember-modifier/ember-modifier)

lib/rules/index.js

@@ -21,6 +21,7 @@ import noargumentsforhtmlelements from './no-arguments-for-html-elements.js';
 import noariahiddenbody from './no-aria-hidden-body.js';
 import noariaunsupportedelements from './no-aria-unsupported-elements.js';
 import noarrayprototypeextensions from './no-array-prototype-extensions.js';
+import noatemberrendermodifiers from './no-at-ember-render-modifiers.js';
 import noattrsincomponents from './no-attrs-in-components.js';
 import noautofocusattribute from './no-autofocus-attribute.js';
 import nobarestrings from './no-bare-strings.js';
@@ -140,6 +141,7 @@ export default {
   'no-aria-hidden-body': noariahiddenbody,
   'no-aria-unsupported-elements': noariaunsupportedelements,
   'no-array-prototype-extensions': noarrayprototypeextensions,
+  'no-at-ember-render-modifiers': noatemberrendermodifiers,
   'no-attrs-in-components': noattrsincomponents,
   'no-autofocus-attribute': noautofocusattribute,
   'no-bare-strings': nobarestrings,

lib/rules/no-at-ember-render-modifiers.js

@@ -0,0 +1,30 @@
+import Rule from './_base.js';
+
+const WHY = `This modifier was intended to ease migration to Octane and not for long-term side-effects.`;
+const ACTION = `Instead, refactor to use a custom modifier. See https://github.com/ember-modifier/ember-modifier`;
+export const MESSAGES = {
+  'did-insert': `Do not use the \`did-insert\` modifier. ${WHY} ${ACTION}`,
+  'did-update': `Do not use the \`did-update\` modifier. ${WHY} ${ACTION}`,
+  'will-destroy': `Do not use the \`will-destroy\` modifier. ${WHY} ${ACTION}`,
+};
+
+const MODIFIERS = new Set([`did-insert`, `did-update`, `will-destroy`]);
+
+export default class NoAtEmberRenderModifiers extends Rule {
+  visitor() {
+    return {
+      ElementModifierStatement(node) {
+        let modifierName = node.path.original;
+        if (!MODIFIERS.has(modifierName)) {
+          return;
+        }
+
+        this.log({
+          message: MESSAGES[modifierName],
+          node,
+          source: this.sourceForNode(node),
+        });
+      },
+    };
+  }
+}

test/unit/rules/no-at-ember-render-modifiers-test.js

@@ -0,0 +1,139 @@
+import { MESSAGES } from '../../../lib/rules/no-at-ember-render-modifiers.js';
+import generateRuleTests from '../../helpers/rule-test-harness.js';
+
+generateRuleTests({
+  name: 'no-at-ember-render-modifiers',
+
+  config: true,
+
+  good: [
+    '<div {{this.someModifier}}></div>',
+    '<div {{someModifier}}></div>',
+    '<div {{did-foo}}></div>',
+    // helper -- a different rule should prevent this
+    // https://github.com/buschtoens/ember-render-helpers (depending on usage)
+    '{{did-insert}}',
+    '{{did-update}}',
+    '{{will-destroy}}',
+  ],
+
+  bad: [
+    {
+      template: '<div {{did-insert}}></div>',
+      verifyResults(results) {
+        expect({ results }).toMatchInlineSnapshot(
+          {
+            results: [
+              {
+                column: 5,
+                endColumn: 19,
+                endLine: 1,
+                filePath: 'layout.hbs',
+                line: 1,
+                message: MESSAGES['did-insert'],
+                rule: 'no-at-ember-render-modifiers',
+                severity: 2,
+                source: '{{did-insert}}',
+              },
+            ],
+          },
+          `
+          {
+            "results": [
+              {
+                "column": 5,
+                "endColumn": 19,
+                "endLine": 1,
+                "filePath": "layout.hbs",
+                "line": 1,
+                "message": "Do not use the \`did-insert\` modifier. This modifier was intended to ease migration to Octane and not for long-term side-effects. Instead, refactor to use a custom modifier. See https://github.com/ember-modifier/ember-modifier",
+                "rule": "no-at-ember-render-modifiers",
+                "severity": 2,
+                "source": "{{did-insert}}",
+              },
+            ],
+          }
+        `
+        );
+      },
+    },
+    {
+      template: '<div {{did-update}}></div>',
+      verifyResults(results) {
+        expect({ results }).toMatchInlineSnapshot(
+          {
+            results: [
+              {
+                column: 5,
+                endColumn: 19,
+                endLine: 1,
+                filePath: 'layout.hbs',
+                line: 1,
+                message: MESSAGES['did-update'],
+                rule: 'no-at-ember-render-modifiers',
+                severity: 2,
+                source: '{{did-update}}',
+              },
+            ],
+          },
+          `
+          {
+            "results": [
+              {
+                "column": 5,
+                "endColumn": 19,
+                "endLine": 1,
+                "filePath": "layout.hbs",
+                "line": 1,
+                "message": "Do not use the \`did-update\` modifier. This modifier was intended to ease migration to Octane and not for long-term side-effects. Instead, refactor to use a custom modifier. See https://github.com/ember-modifier/ember-modifier",
+                "rule": "no-at-ember-render-modifiers",
+                "severity": 2,
+                "source": "{{did-update}}",
+              },
+            ],
+          }
+        `
+        );
+      },
+    },
+    {
+      template: '<div {{will-destroy}}></div>',
+      verifyResults(results) {
+        expect({ results }).toMatchInlineSnapshot(
+          {
+            results: [
+              {
+                column: 5,
+                endColumn: 21,
+                endLine: 1,
+                filePath: 'layout.hbs',
+                line: 1,
+                message: MESSAGES['will-destroy'],
+                rule: 'no-at-ember-render-modifiers',
+                severity: 2,
+                source: '{{will-destroy}}',
+              },
+            ],
+          },
+          `
+          {
+            "results": [
+              {
+                "column": 5,
+                "endColumn": 21,
+                "endLine": 1,
+                "filePath": "layout.hbs",
+                "line": 1,
+                "message": "Do not use the \`will-destroy\` modifier. This modifier was intended to ease migration to Octane and not for long-term side-effects. Instead, refactor to use a custom modifier. See https://github.com/ember-modifier/ember-modifier",
+                "rule": "no-at-ember-render-modifiers",
+                "severity": 2,
+                "source": "{{will-destroy}}",
+              },
+            ],
+          }
+        `
+        );
+      },
+    },
+  ],
+});