@sarj/eslint-plugin 8.0.0 → 9.1.0

package/README.md

@@ -21,7 +21,7 @@ rename moves them.
 
 Presets: `recommended` (warn-first), `strict` (every rule at error), `style-guide` (formatting/naming subset).
 
-## Renamed in 7.0.0 (breaking)
+## Renamed in 7.0.0, aliases deleted in 9.0.0 (breaking)
 
 | Old name | New name |
 | --- | --- |
@@ -30,18 +30,21 @@ Presets: `recommended` (warn-first), `strict` (every rule at error), `style-guid
 | `@sarj/strict-test-assertions` | `@sarj/prefer-whole-object-assertion` |
 | `@sarj/trailing-value-narration` | `@sarj/no-trailing-value-narration` |
 
-Every old name is still REGISTERED, as a deprecated alias of the same rule, so a
-config entry, an `eslint-disable` comment or a suppressions baseline naming it
-keeps working while you migrate; ESLint reports the deprecation and names the
-replacement. Neither preset wires an alias, so nothing double-reports. The map is
+7.0.0 kept each old name registered as a deprecated alias. 9.0.0 deletes them, so
+the new names are the only names — and an old name left in a config, an
+`eslint-disable` comment or a suppressions baseline now makes ESLint exit 2 with
+`Could not find "@sarj/<rule>" in plugin "@sarj"` before it reads a file.
+
+Run `sarj-lint-configs doctor` before upgrading: it reads the shipped rule ledger
+and names every file holding an old name, with the replacement. The map is also
 exported for codemods:
 
 ```js
 import { renamedRules } from "@sarj/eslint-plugin";
 ```
 
-Migration steps, the reasoning behind each name, and why the old keys are kept
-rather than dropped: [`docs/rules/_renames.md`](../../docs/rules/_renames.md).
+Migration steps, the reasoning behind each name, and why the aliases went:
+[`docs/rules/_renames.md`](../../docs/rules/_renames.md).
 
 ## New in 4.1.0 — `no-hand-rolled-sleep`
 

package/dist/index.cjs

@@ -8764,26 +8764,111 @@ var import_utils56 = require("@typescript-eslint/utils");
 var CONFIGISH_TYPE_RE = /(?:Options|Opts|Config|Configuration|Settings|Params|Props|Args|Env|Environment|Callbacks|Flags)$/;
 var CONFIGISH_NAME_RE = /^(?:options|opts|config|configuration|settings|params|props|args|env|environment|callbacks|flags|logger|log|clock)$/i;
 var HTTP_TRANSPORT_TYPE_RE = /^(?:KyInstance|AxiosInstance|Session)$/;
+var BUILTIN_CONTAINER_TYPE_RE = /^(?:Record|Map|WeakMap|Set|WeakSet|Array|ReadonlyArray|ReadonlyMap|ReadonlySet|Promise|Partial|Required|Readonly|Pick|Omit|Exclude|Extract|NonNullable|Awaited|Parameters|ReturnType|InstanceType)$/;
 var TRANSPORT_WRAPPER_NAME_RE = /Client$/;
 var ROUTER_FACTORY_NAME = "Router";
 var FRAMEWORK_HTTP_TYPES = /* @__PURE__ */ new Set(["Request", "Response", "NextFunction"]);
 var isExportedClass = (node) => node.parent.type === import_utils56.AST_NODE_TYPES.ExportNamedDeclaration || node.parent.type === import_utils56.AST_NODE_TYPES.ExportDefaultDeclaration;
 var qualifiedName = (name) => name.type === import_utils56.AST_NODE_TYPES.Identifier ? name.name : name.type === import_utils56.AST_NODE_TYPES.TSQualifiedName ? `${qualifiedName(name.left)}.${name.right.name}` : "";
-var typeReferenceName = (annotated) => {
+var readTypeReference = (annotation) => {
+  if (annotation === void 0 || annotation.type !== import_utils56.AST_NODE_TYPES.TSTypeReference) return null;
+  const { typeName } = annotation;
+  const rightmost = typeName.type === import_utils56.AST_NODE_TYPES.Identifier ? typeName.name : typeName.type === import_utils56.AST_NODE_TYPES.TSQualifiedName ? typeName.right.name : null;
+  if (rightmost === null) return null;
+  return { typeName: rightmost, display: qualifiedName(typeName) };
+};
+var namedParameterCollaborator = (annotated) => {
   let target = annotated;
   if (target.type === import_utils56.AST_NODE_TYPES.TSParameterProperty) target = target.parameter;
   if (target.type === import_utils56.AST_NODE_TYPES.AssignmentPattern) target = target.left;
   if (target.type !== import_utils56.AST_NODE_TYPES.Identifier) return null;
-  const annotation = target.typeAnnotation?.typeAnnotation;
-  if (annotation === void 0 || annotation.type !== import_utils56.AST_NODE_TYPES.TSTypeReference) {
+  const reference = readTypeReference(target.typeAnnotation?.typeAnnotation);
+  if (reference === null) return null;
+  return { name: target.name, ...reference };
+};
+var propertySignatureTypes = (members) => {
+  const types = /* @__PURE__ */ new Map();
+  for (const member of members) {
+    if (member.type !== import_utils56.AST_NODE_TYPES.TSPropertySignature) continue;
+    if (member.computed || member.key.type !== import_utils56.AST_NODE_TYPES.Identifier) continue;
+    const reference = readTypeReference(member.typeAnnotation?.typeAnnotation);
+    if (reference === null) continue;
+    types.set(member.key.name, reference);
+  }
+  return types;
+};
+var fileTypeIndex = (program) => {
+  const objects = /* @__PURE__ */ new Map();
+  const functionAliases = /* @__PURE__ */ new Set();
+  for (const statement of program.body) {
+    const declaration = statement.type === import_utils56.AST_NODE_TYPES.ExportNamedDeclaration ? statement.declaration : statement;
+    if (declaration?.type === import_utils56.AST_NODE_TYPES.TSInterfaceDeclaration) {
+      objects.set(declaration.id.name, propertySignatureTypes(declaration.body.body));
+      continue;
+    }
+    if (declaration?.type !== import_utils56.AST_NODE_TYPES.TSTypeAliasDeclaration) continue;
+    const aliased = declaration.typeAnnotation;
+    if (aliased.type === import_utils56.AST_NODE_TYPES.TSFunctionType || aliased.type === import_utils56.AST_NODE_TYPES.TSConstructorType) {
+      functionAliases.add(declaration.id.name);
+      continue;
+    }
+    const literals = aliased.type === import_utils56.AST_NODE_TYPES.TSTypeLiteral ? [aliased] : aliased.type === import_utils56.AST_NODE_TYPES.TSIntersectionType ? aliased.types.filter((part) => part.type === import_utils56.AST_NODE_TYPES.TSTypeLiteral) : [];
+    if (literals.length === 0) continue;
+    const merged = /* @__PURE__ */ new Map();
+    for (const literal of literals) {
+      for (const [name, reference] of propertySignatureTypes(literal.members)) {
+        merged.set(name, reference);
+      }
+    }
+    objects.set(declaration.id.name, merged);
+  }
+  return { objects, functionAliases };
+};
+var bagMemberTypes = (annotation, declared) => {
+  if (annotation.type === import_utils56.AST_NODE_TYPES.TSTypeLiteral) {
+    return propertySignatureTypes(annotation.members);
+  }
+  if (annotation.type !== import_utils56.AST_NODE_TYPES.TSTypeReference || annotation.typeName.type !== import_utils56.AST_NODE_TYPES.Identifier) {
     return null;
   }
-  const { typeName } = annotation;
-  const rightmost = typeName.type === import_utils56.AST_NODE_TYPES.Identifier ? typeName.name : typeName.type === import_utils56.AST_NODE_TYPES.TSQualifiedName ? typeName.right.name : null;
-  if (rightmost === null) return null;
-  return { name: target.name, typeName: rightmost, display: qualifiedName(typeName) };
+  return declared().objects.get(annotation.typeName.name) ?? null;
+};
+var objectPatternCollaborators = (pattern, declared) => {
+  const annotation = pattern.typeAnnotation?.typeAnnotation;
+  if (annotation === void 0) return [];
+  const members = bagMemberTypes(annotation, declared);
+  if (members === null) return [];
+  const collaborators = [];
+  for (const property of pattern.properties) {
+    if (property.type !== import_utils56.AST_NODE_TYPES.Property || property.computed) continue;
+    if (property.key.type !== import_utils56.AST_NODE_TYPES.Identifier) continue;
+    const key = property.key.name;
+    const bound = property.value.type === import_utils56.AST_NODE_TYPES.AssignmentPattern ? property.value.left : property.value;
+    if (bound.type !== import_utils56.AST_NODE_TYPES.Identifier) continue;
+    if (CONFIGISH_NAME_RE.test(key)) continue;
+    const reference = members.get(key);
+    if (reference === void 0) continue;
+    collaborators.push({ name: bound.name, ...reference });
+  }
+  return collaborators;
+};
+var parameterCollaborators = (parameter, declared) => {
+  let target = parameter;
+  if (target.type === import_utils56.AST_NODE_TYPES.AssignmentPattern) target = target.left;
+  if (target.type === import_utils56.AST_NODE_TYPES.ObjectPattern) {
+    return objectPatternCollaborators(target, declared);
+  }
+  const named2 = namedParameterCollaborator(parameter);
+  return named2 === null ? [] : [named2];
+};
+var typeParameterNames = (...declarations) => {
+  const names = /* @__PURE__ */ new Set();
+  for (const declaration of declarations) {
+    for (const parameter of declaration?.params ?? []) names.add(parameter.name.name);
+  }
+  return names;
 };
-var readConstructor = (ctor) => {
+var readConstructor = (ctor, declared, typeParameters) => {
   const body = ctor.value.body;
   const storedFrom = /* @__PURE__ */ new Set();
   let constructedFields = 0;
@@ -8806,13 +8891,16 @@ var readConstructor = (ctor) => {
   }
   const collaborators = [];
   for (const parameter of ctor.value.params) {
-    const reference = typeReferenceName(parameter);
-    if (reference === null) continue;
-    const stored = parameter.type === import_utils56.AST_NODE_TYPES.TSParameterProperty || storedFrom.has(reference.name);
-    if (!stored) continue;
-    if (CONFIGISH_TYPE_RE.test(reference.typeName)) continue;
-    if (CONFIGISH_NAME_RE.test(reference.name)) continue;
-    collaborators.push(reference);
+    for (const reference of parameterCollaborators(parameter, declared)) {
+      const stored = parameter.type === import_utils56.AST_NODE_TYPES.TSParameterProperty || storedFrom.has(reference.name);
+      if (!stored) continue;
+      if (CONFIGISH_TYPE_RE.test(reference.typeName)) continue;
+      if (CONFIGISH_NAME_RE.test(reference.name)) continue;
+      if (typeParameters.has(reference.typeName)) continue;
+      if (BUILTIN_CONTAINER_TYPE_RE.test(reference.typeName)) continue;
+      if (declared().functionAliases.has(reference.typeName)) continue;
+      collaborators.push(reference);
+    }
   }
   return { collaborators, constructedFields };
 };
@@ -8894,6 +8982,8 @@ var require_interface_for_injected_service_default = createRule({
     const { filename } = context;
     if (isTestFile(filename) || isStoryFile(filename) || isScriptFile(filename)) return {};
     if (isGeneratedFile(filename, context.sourceCode.getText())) return {};
+    let declaredTypes = null;
+    const objectTypes = () => declaredTypes ??= fileTypeIndex(context.sourceCode.ast);
     return {
       ClassDeclaration(node) {
         if (node.id === null) return;
@@ -8906,7 +8996,11 @@ var require_interface_for_injected_service_default = createRule({
           (member) => member.type === import_utils56.AST_NODE_TYPES.MethodDefinition && member.kind === "constructor"
         );
         if (ctor === void 0) return;
-        const { collaborators, constructedFields } = readConstructor(ctor);
+        const { collaborators, constructedFields } = readConstructor(
+          ctor,
+          objectTypes,
+          typeParameterNames(node.typeParameters, ctor.value.typeParameters)
+        );
         if (collaborators.length === 0) return;
         if (constructedFields > collaborators.length) return;
         if (isFrameworkWiring(node.body)) return;
@@ -9289,29 +9383,8 @@ var rules = {
 };
 var meta = {
   name: "@sarj/eslint-plugin",
-  version: "8.0.0"
+  version: "9.1.0"
 };
-var renames = renamedRules;
-var deprecatedAliases = Object.fromEntries(
-  Object.entries(renames).map(([from, to]) => {
-    const rule = rules[to];
-    return [
-      from,
-      {
-        ...rule,
-        meta: {
-          ...rule.meta,
-          deprecated: {
-            message: `Renamed to \`@sarj/${to}\`.`,
-            replacedBy: [{ rule: { name: `@sarj/${to}` } }],
-            deprecatedSince: meta.version
-          }
-        }
-      }
-    ];
-  })
-);
-var allRules = { ...rules, ...deprecatedAliases };
 var recommendedRules = {
   "@sarj/enforce-file-structure": "warn",
   "@sarj/no-async-callback-in-wait-for": "warn",
@@ -9418,7 +9491,7 @@ var strictRules = {
 };
 var plugin = {
   meta,
-  rules: allRules,
+  rules,
   // Withdrawn names travel WITH the plugin so a consumer's migration script and
   // this repo's gates read one map, not two. See src/rules/_retired.ts.
   retiredRules,