@discourse/lint-configs 2.31.0 → 2.33.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/deprecated-imports.mjs

@@ -35,6 +35,21 @@ export default {
               );
             },
           });
+        } else if (
+          node.source.value === "@ember/application" &&
+          node.specifiers[0]?.local.name === "getOwner"
+        ) {
+          context.report({
+            node,
+            message:
+              "Use '@ember/owner' instead of '@ember/application' to import 'getOwner'",
+            fix(fixer) {
+              return fixer.replaceText(
+                node,
+                `import { getOwner } from "@ember/owner";`
+              );
+            },
+          });
         }
       },
     };

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/no-unused-services.mjs

@@ -0,0 +1,447 @@
+// Based on https://github.com/ember-cli/eslint-plugin-ember/blob/8e4b717c1d7d2c0555f4de807709156c89f7aa7a/lib/rules/no-unused-services.js
+
+const MACROS_TO_TRACKED_ARGUMENT_COUNT = {
+  alias: 1,
+  and: Number.MAX_VALUE,
+  bool: 1,
+  collect: Number.MAX_VALUE,
+  deprecatingAlias: 1,
+  empty: 1,
+  equal: 1,
+  filter: 1,
+  filterBy: 1,
+  gt: 1,
+  gte: 1,
+  intersect: Number.MAX_VALUE,
+  lt: 1,
+  lte: 1,
+  map: 1,
+  mapBy: 1,
+  match: 1,
+  max: 1,
+  min: 1,
+  none: 1,
+  not: 1,
+  notEmpty: 1,
+  oneWay: 1,
+  or: Number.MAX_VALUE,
+  readOnly: 1,
+  reads: 1,
+  setDiff: 2,
+  sort: 1,
+  sum: Number.MAX_VALUE,
+  union: Number.MAX_VALUE,
+  uniq: 1,
+  uniqBy: 1,
+};
+
+const EMBER_MACROS = Object.keys(MACROS_TO_TRACKED_ARGUMENT_COUNT);
+
+function splitValue(value) {
+  return value ? value.split(".")[0] : undefined;
+}
+
+function getImportIdentifier(node, source, namedImportIdentifier = null) {
+  if (node.source.value !== source) {
+    return null;
+  }
+
+  return node.specifiers
+    .filter((specifier) => {
+      return (
+        (specifier.type === "ImportSpecifier" &&
+          specifier.imported.name === namedImportIdentifier) ||
+        (!namedImportIdentifier && specifier.type === "ImportDefaultSpecifier")
+      );
+    })
+    .map((specifier) => specifier.local.name)
+    .pop();
+}
+
+function isObserverDecorator(node, importedObservesName) {
+  return (
+    node?.type === "Decorator" &&
+    node.expression?.type === "CallExpression" &&
+    node.expression.callee?.type === "Identifier" &&
+    node.expression.callee.name === importedObservesName
+  );
+}
+
+function isPropOfType(node, importedServiceName, importedOptionalServiceName) {
+  if (
+    (node?.type === "ClassProperty" ||
+      node?.type === "PropertyDefinition" ||
+      node?.type === "MethodDefinition") &&
+    node.decorators
+  ) {
+    return node.decorators.some((decorator) => {
+      const expression = decorator.expression;
+      return (
+        (expression?.type === "Identifier" &&
+          (expression.name === importedServiceName ||
+            expression.name === importedOptionalServiceName)) ||
+        (expression?.type === "CallExpression" &&
+          (expression.callee.name === importedServiceName ||
+            expression.callee.name === importedOptionalServiceName))
+      );
+    });
+  }
+  return false;
+}
+
+function isThisGetCall(node) {
+  if (
+    node?.type === "CallExpression" &&
+    node.callee?.type === "MemberExpression" &&
+    node.callee.object?.type === "ThisExpression" &&
+    node.callee.property?.type === "Identifier" &&
+    node.callee.property.name === "get" &&
+    node.arguments.length === 1 &&
+    node.arguments[0]?.type === "Literal" &&
+    typeof node.arguments[0]?.value === "string"
+  ) {
+    // Looks like: this.get('property')
+    return true;
+  }
+
+  return false;
+}
+
+function isComputedProp(node, importedComputedName) {
+  return (
+    // computed
+    (node?.type === "Identifier" && node.name === importedComputedName) ||
+    // computed()
+    (node?.type === "CallExpression" &&
+      node.callee?.type === "Identifier" &&
+      node.callee.name === importedComputedName)
+  );
+}
+
+export default {
+  meta: {
+    type: "suggestion",
+    docs: {
+      description:
+        "disallow unused service injections (see rule doc for limitations)",
+      category: "Services",
+      recommended: false,
+      url: "https://github.com/ember-cli/eslint-plugin-ember/tree/master/docs/rules/no-unused-services.md",
+    },
+    fixable: null,
+    hasSuggestions: true,
+    schema: [],
+    messages: {
+      main: "The service `{{name}}` is not referenced in this file and might be unused (note: it could still be used in a parent/child class).",
+      removeServiceInjection: "Remove the service injection.",
+    },
+  },
+
+  create(context) {
+    let currentClass;
+
+    let importedComputedName;
+    let importedDiscourseComputedName;
+    let importedGetName;
+    let importedGetPropertiesName;
+    let importedServiceName;
+    let importedOptionalServiceName;
+    let importedObserverName;
+    let importedObservesName;
+    const importedMacros = {};
+
+    /**
+     * Gets the trailing comma token of the given node.
+     * If the trailing comma does not exist, this returns undefined.
+     * @param {ASTNode} node The given node
+     * @returns {Token|undefined} The trailing comma token or undefined
+     */
+    function getTrailingToken(node) {
+      const nextToken = context.sourceCode.getTokenAfter(node);
+      return nextToken.type === "Punctuator" && nextToken.value === ","
+        ? nextToken
+        : undefined;
+    }
+
+    /**
+     * Go through the current class and report any unused services
+     * @returns {void}
+     */
+    function reportInstances() {
+      const { services, uses } = currentClass;
+      currentClass = null;
+
+      if (Object.keys(services).length === 0) {
+        return;
+      }
+
+      for (const name of Object.keys(services)) {
+        if (!uses.has(name)) {
+          const node = services[name];
+          context.report({
+            node,
+            data: { name },
+            messageId: "main",
+            suggest: [
+              {
+                messageId: "removeServiceInjection",
+                fix(fixer) {
+                  const fixers = [fixer.remove(node)];
+                  if (node?.type === "Property") {
+                    const trailingTokenNode = getTrailingToken(node);
+                    if (trailingTokenNode) {
+                      fixers.push(fixer.remove(trailingTokenNode));
+                    }
+                  }
+                  return fixers;
+                },
+              },
+            ],
+          });
+        }
+      }
+    }
+
+    return {
+      ImportDeclaration(node) {
+        if (node.source.value === "@ember/object") {
+          importedComputedName ||= getImportIdentifier(
+            node,
+            "@ember/object",
+            "computed"
+          );
+          importedGetName ||= getImportIdentifier(node, "@ember/object", "get");
+          importedGetPropertiesName ||= getImportIdentifier(
+            node,
+            "@ember/object",
+            "getProperties"
+          );
+          importedObserverName ||= getImportIdentifier(
+            node,
+            "@ember/object",
+            "observer"
+          );
+        } else if (node.source.value === "@ember/object/computed") {
+          for (const spec of node.specifiers) {
+            if (spec.type === "ImportDefaultSpecifier") {
+              continue;
+            }
+            const name = spec.imported.name;
+            if (EMBER_MACROS.includes(name)) {
+              const localName = spec.local.name;
+              importedMacros[localName] = name;
+            }
+          }
+        } else if (node.source.value === "discourse/lib/decorators") {
+          importedDiscourseComputedName ||= getImportIdentifier(
+            node,
+            "discourse/lib/decorators"
+          );
+        } else if (node.source.value === "@ember/service") {
+          importedServiceName ||= getImportIdentifier(
+            node,
+            "@ember/service",
+            "service"
+          );
+        } else if (node.source.value === "discourse/lib/optional-service") {
+          importedOptionalServiceName ||= getImportIdentifier(
+            node,
+            "discourse/lib/optional-service"
+          );
+        } else if (node.source.value === "@ember-decorators/object") {
+          importedObservesName ||= getImportIdentifier(
+            node,
+            "@ember-decorators/object",
+            "observes"
+          );
+        }
+      },
+
+      // Native JS class
+      ClassDeclaration(node) {
+        currentClass = { node, services: {}, uses: new Set() };
+      },
+
+      CallExpression(node) {
+        if (!currentClass) {
+          return;
+        }
+
+        if (isComputedProp(node, importedComputedName)) {
+          // computed()
+          for (const elem of node.arguments) {
+            if (elem?.type === "Literal" && typeof elem?.value === "string") {
+              const name = splitValue(elem.value);
+              currentClass.uses.add(name);
+            }
+          }
+        } else if (isComputedProp(node, importedDiscourseComputedName)) {
+          // discourseComputed()
+          for (const elem of node.arguments) {
+            if (elem?.type === "Literal" && typeof elem?.value === "string") {
+              const name = splitValue(elem.value);
+              currentClass.uses.add(name);
+            }
+          }
+        } else if (isThisGetCall(node)) {
+          // this.get('foo...');
+          const name = splitValue(node.arguments[0].value);
+          currentClass.uses.add(name);
+        } else if (
+          node.callee.object?.type === "ThisExpression" &&
+          node.callee.property.name === "getProperties"
+        ) {
+          // this.getProperties([..., 'foo..', ...]); or this.getProperties(..., 'foo..', ...);
+          const argArray =
+            node.arguments[0]?.type === "ArrayExpression"
+              ? node.arguments[0].elements
+              : node.arguments;
+          for (const elem of argArray) {
+            const name = splitValue(elem.value);
+            currentClass.uses.add(name);
+          }
+        } else if (node.callee?.type === "Identifier") {
+          const calleeName = node.callee.name;
+          if (node.arguments[0]?.type === "ThisExpression") {
+            // If `get` and `getProperties` weren't imported, skip out early
+            if (!importedGetName && !importedGetPropertiesName) {
+              return;
+            }
+
+            if (calleeName === importedGetName) {
+              // get(this, 'foo...');
+              const name = splitValue(node.arguments[1].value);
+              currentClass.uses.add(name);
+            } else if (calleeName === importedGetPropertiesName) {
+              // getProperties(this, [..., 'foo..', ...]); or getProperties(this, ..., 'foo..', ...);
+              const argArray =
+                node.arguments[1]?.type === "ArrayExpression"
+                  ? node.arguments[1].elements
+                  : node.arguments.slice(1);
+              for (const elem of argArray) {
+                const name = splitValue(elem.value);
+                currentClass.uses.add(name);
+              }
+            }
+          } else if (importedMacros[calleeName]) {
+            // Computed macros like @alias(), @or()
+            const macroName = importedMacros[calleeName];
+            for (
+              let idx = 0;
+              idx < MACROS_TO_TRACKED_ARGUMENT_COUNT[macroName] &&
+              idx < node.arguments.length;
+              idx++
+            ) {
+              const elem = node.arguments[idx];
+              if (elem?.type === "Literal" && typeof elem?.value === "string") {
+                const name = splitValue(elem.value);
+                currentClass.uses.add(name);
+              }
+            }
+          } else if (calleeName === importedObserverName) {
+            // observer('foo', ...)
+            for (const elem of node.arguments) {
+              if (elem?.type === "Literal" && typeof elem?.value === "string") {
+                const name = splitValue(elem.value);
+                currentClass.uses.add(name);
+              }
+            }
+          }
+        }
+      },
+
+      "ClassDeclaration:exit"(node) {
+        if (currentClass && currentClass.node === node) {
+          // Leaving current class
+          reportInstances();
+        }
+      },
+
+      // @observes('foo', ...)
+      Decorator(node) {
+        // If `service` and `optionalService` weren't imported OR observes wasn't imported, skip out early
+        if (
+          (!importedServiceName && !importedOptionalServiceName) ||
+          !importedObservesName
+        ) {
+          return;
+        }
+
+        if (
+          currentClass &&
+          isObserverDecorator(node, importedObservesName) &&
+          node.expression?.type === "CallExpression"
+        ) {
+          for (const elem of node.expression.arguments) {
+            if (elem.type === "Literal" && typeof elem.value === "string") {
+              const name = splitValue(elem.value);
+              currentClass.uses.add(name);
+            }
+          }
+        }
+      },
+
+      PropertyDefinition(node) {
+        // Handles:
+        //   @service(...) foo;
+        //   @optionalService(...) foo;
+
+        // If `service` and `optionalService` weren't imported, skip out early
+        if (!importedServiceName && !importedOptionalServiceName) {
+          return;
+        }
+
+        if (
+          currentClass &&
+          isPropOfType(node, importedServiceName, importedOptionalServiceName)
+        ) {
+          if (node.key.type === "Identifier") {
+            const name = node.key.name;
+            currentClass.services[name] = node;
+          } else if (
+            node.key?.type === "Literal" &&
+            typeof node.key?.value === "string"
+          ) {
+            const name = node.key.value;
+            currentClass.services[name] = node;
+          }
+        }
+      },
+
+      // this.foo...
+      MemberExpression(node) {
+        if (
+          currentClass &&
+          node.object?.type === "ThisExpression" &&
+          node.property?.type === "Identifier"
+        ) {
+          const name = node.property.name;
+          currentClass.uses.add(name);
+        }
+      },
+
+      GlimmerPathExpression(node) {
+        if (
+          currentClass &&
+          node.head.type === "ThisHead" &&
+          node.tail.length > 0
+        ) {
+          const name = node.tail[0];
+          currentClass.uses.add(name);
+        }
+      },
+
+      VariableDeclarator(node) {
+        if (
+          currentClass &&
+          node.init?.type === "ThisExpression" &&
+          node.id?.type === "ObjectPattern"
+        ) {
+          for (const property of node.id.properties) {
+            currentClass.uses.add(property.key.name);
+          }
+        }
+      },
+    };
+  },
+};

package/eslint.mjs

@@ -24,7 +24,9 @@ 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 themeImports from "./eslint-rules/theme-imports.mjs";
@@ -121,6 +123,7 @@ export default [
           "i18n-t": i18nT,
           "service-inject-import": serviceInjectImport,
           "truth-helpers-imports": truthHelpersImports,
+          "no-unused-services": noUnusedServices,
           "plugin-api-no-version": pluginApiNoVersion,
           "theme-imports": themeImports,
           "no-simple-query-selector": noSimpleQuerySelector,
@@ -134,6 +137,7 @@ export default [
           "no-curly-components": noCurlyComponents,
           "capital-components": capitalComponents,
           "no-onclick": noOnclick,
+          "no-route-template": noRouteTemplate,
         },
       },
     },
@@ -296,6 +300,7 @@ export default [
       "discourse/i18n-t": ["error"],
       "discourse/service-inject-import": ["error"],
       "discourse/truth-helpers-imports": ["error"],
+      "discourse/no-unused-services": ["error"],
       "discourse/plugin-api-no-version": ["error"],
       "discourse/theme-imports": ["error"],
       "discourse/no-simple-query-selector": ["error"],
@@ -309,6 +314,7 @@ export default [
       "discourse/no-curly-components": ["error"],
       "discourse/capital-components": ["error"],
       "discourse/no-onclick": ["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.31.0",
+  "version": "2.33.0",
   "description": "Shareable lint configs for Discourse core, plugins, and themes",
   "author": "Discourse",
   "license": "MIT",
@@ -30,13 +30,13 @@
     "test": "cd ../test && node test.js"
   },
   "dependencies": {
-    "@babel/core": "^7.28.0",
+    "@babel/core": "^7.28.4",
     "@babel/eslint-parser": "^7.28.0",
     "@babel/plugin-proposal-decorators": "^7.28.0",
-    "ember-template-lint": "^7.9.1",
-    "eslint": "^9.32.0",
+    "ember-template-lint": "^7.9.3",
+    "eslint": "^9.36.0",
     "eslint-plugin-decorator-position": "^6.0.0",
-    "eslint-plugin-ember": "^12.7.0",
+    "eslint-plugin-ember": "^12.7.4",
     "eslint-plugin-import": "^2.32.0",
     "eslint-plugin-qunit": "^8.2.5",
     "eslint-plugin-simple-import-sort": "^12.1.1",
@@ -44,16 +44,16 @@
     "globals": "^16.3.0",
     "prettier": "^3.6.2",
     "prettier-plugin-ember-template-tag": "^2.1.0",
-    "stylelint": "^16.22.0",
-    "stylelint-config-standard": "^38.0.0",
+    "stylelint": "^16.24.0",
+    "stylelint-config-standard": "^39.0.0",
     "stylelint-config-standard-scss": "^15.0.1",
     "stylelint-scss": "^6.12.1",
-    "typescript": "^5.8.3"
+    "typescript": "^5.9.2"
   },
   "peerDependencies": {
-    "ember-template-lint": "7.9.1",
-    "eslint": "9.32.0",
+    "ember-template-lint": "7.9.3",
+    "eslint": "9.36.0",
     "prettier": "3.6.2",
-    "stylelint": "16.22.0"
+    "stylelint": "16.24.0"
   }
 }

package/template-lint.config.cjs

@@ -11,7 +11,6 @@ module.exports = {
 
     // Pending default rules
     "link-href-attributes": false,
-    "no-action": false,
     "no-at-ember-render-modifiers": false,
     "no-curly-component-invocation": false,
     "no-duplicate-landmark-elements": false,
@@ -34,7 +33,6 @@ module.exports = {
     // Pending non-default rules
     "attribute-order": false,
     "inline-link-to": false,
-    "no-action-modifiers": false,
     "no-builtin-form-components": false,
     "no-this-in-template-only-components": false, // emits false-positives in gjs
 
@@ -61,13 +59,6 @@ module.exports = {
       files: ["**/*.gjs", "**/*.gts"],
       rules: {
         "discourse/no-implicit-this": false,
-        "no-action-modifiers": true,
-      },
-    },
-    {
-      files: ["**/templates/**/*.gjs"],
-      rules: {
-        "no-action": true,
       },
     },
   ],