@discourse/lint-configs 2.32.0 → 2.34.0

package/.prettierrc.cjs

@@ -6,12 +6,14 @@ module.exports = {
       files: "*.gjs",
       options: {
         parser: "ember-template-tag",
+        templateExportDefault: true,
       },
     },
     {
       files: "*.gts",
       options: {
         parser: "ember-template-tag",
+        templateExportDefault: true,
       },
     },
   ],

package/eslint-rules/no-route-template.mjs

@@ -0,0 +1,55 @@
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description: "Disallow RouteTemplate wrapper for route templates.",
+    },
+    fixable: "code",
+    schema: [],
+    messages: {
+      removeRouteTemplate: "Remove RouteTemplate wrapper for route templates.",
+    },
+  },
+
+  create(context) {
+    return {
+      ExportDefaultDeclaration(node) {
+        if (
+          node.declaration &&
+          node.declaration.type === "CallExpression" &&
+          node.declaration.callee.name === "RouteTemplate" &&
+          node.declaration.arguments.length === 1
+        ) {
+          context.report({
+            node,
+            messageId: "removeRouteTemplate",
+            fix(fixer) {
+              const sourceCode = context.getSourceCode();
+              const arg = node.declaration.arguments[0];
+              // Find import of RouteTemplate
+              const importDecl = sourceCode.ast.body.find(
+                (n) =>
+                  n.type === "ImportDeclaration" &&
+                  n.specifiers.some(
+                    (s) =>
+                      s.type === "ImportDefaultSpecifier" &&
+                      s.local.name === "RouteTemplate"
+                  )
+              );
+
+              // Only remove the import and replace the export, do not touch whitespace/indentation
+              const fixes = [];
+              if (importDecl) {
+                fixes.push(fixer.remove(importDecl));
+              }
+              fixes.push(
+                fixer.replaceText(node.declaration, sourceCode.getText(arg))
+              );
+              return fixes;
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/eslint-rules/template-tag-no-self-this.mjs

@@ -0,0 +1,62 @@
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description:
+        "Avoid using `const self = this`. Use `this` directly inside template tags.",
+    },
+    fixable: "code",
+    schema: [], // no options
+  },
+
+  create(context) {
+    return {
+      VariableDeclarator(node) {
+        if (
+          node.id.type !== "Identifier" ||
+          node.init?.type !== "ThisExpression"
+        ) {
+          return;
+        }
+
+        const variable = context.sourceCode.getDeclaredVariables(node)[0];
+        const references = variable.references.filter(
+          (ref) => ref.identifier.parent !== node
+        );
+
+        const referencedOnlyInAdjacentTemplateTag = references.every((ref) => {
+          if (ref.identifier.type !== "VarHead") {
+            return false;
+          }
+
+          const hasSameVariableScope =
+            context.sourceCode.getScope(ref.identifier).variableScope ===
+            context.sourceCode.getScope(node).variableScope;
+
+          return hasSameVariableScope;
+        });
+
+        if (referencedOnlyInAdjacentTemplateTag) {
+          context.report({
+            node,
+            message:
+              "Remove `self = this` and use `this` directly inside template tags.",
+            fix(fixer) {
+              const fixes = [];
+
+              // Replace all references to `self` with `this`
+              references.forEach((ref) => {
+                fixes.push(fixer.replaceText(ref.identifier, "this"));
+              });
+
+              // Remove the original variable declaration
+              fixes.push(fixer.remove(node.parent));
+
+              return fixes;
+            },
+          });
+        }
+      },
+    };
+  },
+};

package/eslint.mjs

@@ -24,10 +24,12 @@ import lineBeforeDefaultExport from "./eslint-rules/line-before-default-export.m
 import linesBetweenClassMembers from "./eslint-rules/lines-between-class-members.mjs";
 import noCurlyComponents from "./eslint-rules/no-curly-components.mjs";
 import noOnclick from "./eslint-rules/no-onclick.mjs";
+import noRouteTemplate from "./eslint-rules/no-route-template.mjs";
 import noSimpleQuerySelector from "./eslint-rules/no-simple-query-selector.mjs";
 import noUnusedServices from "./eslint-rules/no-unused-services.mjs";
 import pluginApiNoVersion from "./eslint-rules/plugin-api-no-version.mjs";
 import serviceInjectImport from "./eslint-rules/service-inject-import.mjs";
+import templateTagNoSelfThis from "./eslint-rules/template-tag-no-self-this.mjs";
 import themeImports from "./eslint-rules/theme-imports.mjs";
 import truthHelpersImports from "./eslint-rules/truth-helpers-imports.mjs";
 
@@ -136,6 +138,8 @@ export default [
           "no-curly-components": noCurlyComponents,
           "capital-components": capitalComponents,
           "no-onclick": noOnclick,
+          "no-route-template": noRouteTemplate,
+          "template-tag-no-self-this": templateTagNoSelfThis,
         },
       },
     },
@@ -312,6 +316,8 @@ export default [
       "discourse/no-curly-components": ["error"],
       "discourse/capital-components": ["error"],
       "discourse/no-onclick": ["error"],
+      "discourse/template-tag-no-self-this": ["error"],
+      // "discourse/no-route-template": ["error"], // Enable by default once Ember 6.6 is on stable
     },
   },
   {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@discourse/lint-configs",
-  "version": "2.32.0",
+  "version": "2.34.0",
   "description": "Shareable lint configs for Discourse core, plugins, and themes",
   "author": "Discourse",
   "license": "MIT",