@discourse/lint-configs 2.39.1 → 2.41.0

package/eslint-rules/utils/analyze-imports.mjs

@@ -0,0 +1,65 @@
+// Generic utilities to inspect ImportDeclaration nodes in a source AST.
+// These helpers are intentionally generic so they can be reused by multiple
+// lint rules in this repo instead of containing rule-specific logic.
+
+/**
+ * @typedef {import('estree').Node} Node
+ * @typedef {import('estree').ImportDeclaration} ImportDeclaration
+ * @typedef {Object} ImportInfo
+ * @property {ImportDeclaration} node - The ImportDeclaration AST node
+ * @property {Array<import('estree').ImportSpecifier|import('estree').ImportDefaultSpecifier|import('estree').ImportNamespaceSpecifier>} specifiers - The import specifiers
+ */
+
+/**
+ * Collects all ImportDeclaration nodes from the provided ESLint SourceCode
+ * and returns a Map keyed by the import source string (e.g. "@ember/object").
+ *
+ * The resulting Map values are objects with the original ImportDeclaration
+ * node and a shallow copy of its specifiers. Rules can use this to inspect
+ * existing imports and build fixes that modify or add import statements.
+ *
+ * @param {import('eslint').SourceCode} sourceCode - ESLint SourceCode object
+ * @returns {Map<string, ImportInfo>} Map from import source value to import info
+ */
+export function collectImports(sourceCode) {
+  const imports = new Map();
+
+  sourceCode.ast.body.forEach((statement) => {
+    if (statement && statement.type === "ImportDeclaration") {
+      const sourceValue = statement.source && statement.source.value;
+      if (!imports.has(sourceValue)) {
+        imports.set(sourceValue, {
+          node: statement,
+          specifiers: Array.isArray(statement.specifiers)
+            ? statement.specifiers.slice()
+            : [],
+        });
+      }
+    }
+  });
+
+  return imports;
+}
+
+/**
+ * Returns the set of all locally imported identifier names in the file. This
+ * is useful to detect name collisions before inserting new imports (for
+ * example, to decide whether to alias an imported identifier).
+ *
+ * @param {import('eslint').SourceCode} sourceCode - ESLint SourceCode object
+ * @returns {Set<string>} Set of local import names
+ */
+export function getImportedLocalNames(sourceCode) {
+  const names = new Set();
+  const imports = collectImports(sourceCode);
+
+  for (const { specifiers } of imports.values()) {
+    specifiers.forEach((spec) => {
+      if (spec?.local?.name) {
+        names.add(spec.local.name);
+      }
+    });
+  }
+
+  return names;
+}

package/eslint-rules/utils/property-path.mjs

@@ -0,0 +1,78 @@
+// Utilities for working with property paths used in @discourseComputed
+// decorators. These helpers make it easier to reason about and convert
+// parameter property paths to `this`-based optional chaining accessors.
+
+// Extract the "clean" attribute path before special tokens like @each, [],
+// or template-style placeholders. Example:
+// - "items.@each.title" -> "items"
+// - "data.0.value" -> "data.0.value" (numeric index preserved)
+// - "payload{?}.name" -> "payload"
+export function niceAttr(attr) {
+  if (!attr || typeof attr !== "string") {
+    return "";
+  }
+
+  const parts = attr.split(".");
+  let i;
+
+  for (i = 0; i < parts.length; i++) {
+    if (parts[i] === "@each" || parts[i] === "[]" || parts[i].includes("{")) {
+      break;
+    }
+  }
+
+  return parts.slice(0, i).join(".");
+}
+
+// Convert a `propertyPath` (like "model.poll.title" or "data.0.value") into
+// a `this`-prefixed access with optional chaining where appropriate.
+// Parameters:
+// - propertyPath: original path used in the decorator or parameter mapping
+// - useOptionalChaining: if true, emit `?.` and `?.[...]` for nested parts
+// - needsTrailingChaining: when true and the path requires it, append a
+//   trailing `?.` so that subsequent member access becomes part of the chain.
+export function propertyPathToOptionalChaining(
+  propertyPath,
+  useOptionalChaining = true,
+  needsTrailingChaining = false
+) {
+  const cleanPath = niceAttr(propertyPath);
+  const wasExtracted = cleanPath !== propertyPath;
+
+  if (!cleanPath) {
+    return "this";
+  }
+
+  const parts = cleanPath.split(".");
+  let result = "this";
+
+  for (let i = 0; i < parts.length; i++) {
+    const part = parts[i];
+
+    if (/^\d+$/.test(part)) {
+      // Numeric index -> bracket notation
+      if (useOptionalChaining) {
+        result += `?.[${part}]`;
+      } else {
+        result += `[${part}]`;
+      }
+    } else {
+      if (i === 0) {
+        result += `.${part}`;
+      } else {
+        result += useOptionalChaining ? `?.${part}` : `.${part}`;
+      }
+    }
+  }
+
+  if (needsTrailingChaining && useOptionalChaining) {
+    if (
+      (wasExtracted && parts.length === 1) ||
+      (!wasExtracted && parts.length > 1)
+    ) {
+      result += "?.";
+    }
+  }
+
+  return result;
+}

package/eslint.mjs

@@ -17,11 +17,13 @@ import deprecatedPluginApis from "./eslint-rules/deprecated-plugin-apis.mjs";
 import discourseCommonImports from "./eslint-rules/discourse-common-imports.mjs";
 import i18nImport from "./eslint-rules/i18n-import-location.mjs";
 import i18nT from "./eslint-rules/i18n-t.mjs";
+import keepArraySorted from "./eslint-rules/keep-array-sorted.mjs";
 import lineAfterImports from "./eslint-rules/line-after-imports.mjs";
 import lineBeforeDefaultExport from "./eslint-rules/line-before-default-export.mjs";
 import linesBetweenClassMembers from "./eslint-rules/lines-between-class-members.mjs";
 import movedPackagesImportPaths from "./eslint-rules/moved-packages-import-paths.mjs";
 import noCurlyComponents from "./eslint-rules/no-curly-components.mjs";
+import noDiscourseComputed from "./eslint-rules/no-discourse-computed.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";
@@ -122,6 +124,7 @@ export default [
         rules: {
           "i18n-import-location": i18nImport,
           "i18n-t": i18nT,
+          "keep-array-sorted": keepArraySorted,
           "service-inject-import": serviceInjectImport,
           "truth-helpers-imports": truthHelpersImports,
           "no-unused-services": noUnusedServices,
@@ -141,6 +144,7 @@ export default [
           "no-route-template": noRouteTemplate,
           "template-tag-no-self-this": templateTagNoSelfThis,
           "moved-packages-import-paths": movedPackagesImportPaths,
+          "no-discourse-computed": noDiscourseComputed,
           "test-filename-suffix": testFilenameSuffix,
         },
       },
@@ -311,6 +315,8 @@ export default [
       "discourse/no-route-template": ["error"],
       "discourse/moved-packages-import-paths": ["error"],
       "discourse/test-filename-suffix": ["error"],
+      "discourse/keep-array-sorted": ["error"],
+      "discourse/no-discourse-computed": ["error"],
     },
   },
   {

package/package.json

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