Merge pull request #2491 from NullVoxPopuli/nvp/template-lint-extract-rule-template-no-page-title-component

Extract rule: template-no-page-title-component

Author: NullVoxPopuli

README.md

@@ -208,6 +208,7 @@ rules in templates can be disabled with eslint directives with mustache or html
 | [template-no-input-placeholder](docs/rules/template-no-input-placeholder.md)                           | disallow placeholder attribute on input elements                |    |    |    |
 | [template-no-input-tagname](docs/rules/template-no-input-tagname.md)                                   | disallow tagName attribute on {{input}} helper                  |    |    |    |
 | [template-no-log](docs/rules/template-no-log.md)                                                       | disallow {{log}} in templates                                   |    |    |    |
+| [template-no-page-title-component](docs/rules/template-no-page-title-component.md)                     | disallow usage of ember-page-title component                    |    |    |    |
 
 ### Components
 

docs/rules/template-no-page-title-component.md

@@ -0,0 +1,43 @@
+# ember/template-no-page-title-component
+
+<!-- end auto-generated rule header -->
+
+Disallows usage of the `<PageTitle>` component.
+
+## Rule Details
+
+Use the `{{pageTitle}}` helper instead of the `<PageTitle>` component from ember-page-title.
+
+## Examples
+
+Examples of **incorrect** code for this rule:
+
+```gjs
+<template>
+  <PageTitle>My Page</PageTitle>
+</template>
+```
+
+```gjs
+<template>
+  <PageTitle @title="My Page" />
+</template>
+```
+
+Examples of **correct** code for this rule:
+
+```gjs
+<template>
+  {{pageTitle "My Page"}}
+</template>
+```
+
+```gjs
+<template>
+  {{pageTitle this.dynamicTitle}}
+</template>
+```
+
+## References
+
+- [ember-page-title documentation](https://github.com/ember-cli/ember-page-title)

lib/rules/template-no-page-title-component.js

@@ -0,0 +1,30 @@
+/** @type {import('eslint').Rule.RuleModule} */
+module.exports = {
+  meta: {
+    type: 'suggestion',
+    docs: {
+      description: 'disallow usage of ember-page-title component',
+      category: 'Best Practices',
+      url: 'https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/template-no-page-title-component.md',
+      templateMode: 'both',
+    },
+    fixable: null,
+    schema: [],
+    messages: {
+      noPageTitle: 'Use the `pageTitle` helper instead of the <PageTitle> component.',
+    },
+  },
+
+  create(context) {
+    return {
+      GlimmerElementNode(node) {
+        if (node.tag === 'PageTitle') {
+          context.report({
+            node,
+            messageId: 'noPageTitle',
+          });
+        }
+      },
+    };
+  },
+};

tests/lib/rules/template-no-page-title-component.js

@@ -0,0 +1,68 @@
+//------------------------------------------------------------------------------
+// Requirements
+//------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/template-no-page-title-component');
+const RuleTester = require('eslint').RuleTester;
+
+//------------------------------------------------------------------------------
+// Tests
+//------------------------------------------------------------------------------
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('ember-eslint-parser'),
+  parserOptions: { ecmaVersion: 2022, sourceType: 'module' },
+});
+
+ruleTester.run('template-no-page-title-component', rule, {
+  valid: [
+    `<template>
+      {{pageTitle "My Page"}}
+    </template>`,
+    `<template>
+      {{pageTitle this.dynamicTitle}}
+    </template>`,
+    `<template>
+      <div></div>
+    </template>`,
+  ],
+
+  invalid: [
+    {
+      code: `<template>
+        <PageTitle>My Page</PageTitle>
+      </template>`,
+      output: null,
+      errors: [
+        {
+          message: 'Use the `pageTitle` helper instead of the <PageTitle> component.',
+          type: 'GlimmerElementNode',
+        },
+      ],
+    },
+    {
+      code: `<template>
+        <PageTitle @title="My Page" />
+      </template>`,
+      output: null,
+      errors: [
+        {
+          message: 'Use the `pageTitle` helper instead of the <PageTitle> component.',
+          type: 'GlimmerElementNode',
+        },
+      ],
+    },
+    {
+      code: `<template>
+        <PageTitle>{{this.title}}</PageTitle>
+      </template>`,
+      output: null,
+      errors: [
+        {
+          message: 'Use the `pageTitle` helper instead of the <PageTitle> component.',
+          type: 'GlimmerElementNode',
+        },
+      ],
+    },
+  ],
+});