part: set up overridable options

knip.jsonc

@@ -2,7 +2,7 @@
   "$schema": "node_modules/knip/schema-jsonc.json",
   "entry": ["src/index.ts!", "tests/**/*.test.ts"],
   "project": ["src/**/*.ts!", "tests/**/*.{js,ts}"],
-  "ignore": ["tests/fixture/file.ts"],
+  "ignore": ["tests/fixture/file.ts", "src/utils/schemas.ts"],
   "ignoreDependencies": [
     // Unknown reason for issue.
     "@vitest/coverage-v8",

package.json

@@ -76,7 +76,8 @@
     "deepmerge-ts": "^7.1.0",
     "escape-string-regexp": "^5.0.0",
     "is-immutable-type": "^5.0.0",
-    "ts-api-utils": "^1.3.0"
+    "ts-api-utils": "^1.3.0",
+    "ts-declaration-location": "^1.0.3"
   },
   "devDependencies": {
     "@babel/eslint-parser": "7.25.1",

src/options/index.ts

@@ -1 +1,2 @@
 export * from "./ignore";
+export * from "./overrides";

src/options/overrides.ts

@@ -0,0 +1,185 @@
+import assert from "node:assert/strict";
+
+import { type TSESTree } from "@typescript-eslint/utils";
+import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
+import { deepmerge } from "deepmerge-ts";
+import typeMatchesSpecifier, {
+  type TypeDeclarationSpecifier,
+} from "ts-declaration-location";
+import { type Program, type Type, type TypeNode } from "typescript";
+
+import { getTypeDataOfNode } from "#/utils/rule";
+import {
+  type RawTypeSpecifier,
+  type TypeSpecifier,
+  typeMatchesPattern,
+} from "#/utils/type-specifier";
+
+/**
+ * Options that can be overridden.
+ */
+export type OverridableOptions<CoreOptions> = CoreOptions & {
+  overrides?: Array<
+    {
+      specifiers: TypeSpecifier | TypeSpecifier[];
+    } & (
+      | {
+          options: CoreOptions;
+          inherit?: boolean;
+          disable?: false;
+        }
+      | {
+          disable: true;
+        }
+    )
+  >;
+};
+
+export type RawOverridableOptions<CoreOptions> = CoreOptions & {
+  overrides?: Array<{
+    specifiers?: RawTypeSpecifier | RawTypeSpecifier[];
+    options?: CoreOptions;
+    inherit?: boolean;
+    disable?: boolean;
+  }>;
+};
+
+export function upgradeRawOverridableOptions<CoreOptions>(
+  raw: Readonly<RawOverridableOptions<CoreOptions>>,
+): OverridableOptions<CoreOptions> {
+  return {
+    ...raw,
+    overrides:
+      raw.overrides?.map((override) => ({
+        ...override,
+        specifiers:
+          override.specifiers === undefined
+            ? []
+            : Array.isArray(override.specifiers)
+              ? override.specifiers.map(upgradeRawTypeSpecifier)
+              : [upgradeRawTypeSpecifier(override.specifiers)],
+      })) ?? [],
+  } as OverridableOptions<CoreOptions>;
+}
+
+function upgradeRawTypeSpecifier(raw: RawTypeSpecifier): TypeSpecifier {
+  const { ignoreName, ignorePattern, name, pattern, ...rest } = raw;
+
+  const names = name === undefined ? [] : Array.isArray(name) ? name : [name];
+
+  const patterns = (
+    pattern === undefined ? [] : Array.isArray(pattern) ? pattern : [pattern]
+  ).map((p) => new RegExp(p, "u"));
+
+  const ignoreNames =
+    ignoreName === undefined
+      ? []
+      : Array.isArray(ignoreName)
+        ? ignoreName
+        : [ignoreName];
+
+  const ignorePatterns = (
+    ignorePattern === undefined
+      ? []
+      : Array.isArray(ignorePattern)
+        ? ignorePattern
+        : [ignorePattern]
+  ).map((p) => new RegExp(p, "u"));
+
+  const include = [...names, ...patterns];
+  const exclude = [...ignoreNames, ...ignorePatterns];
+
+  return {
+    ...rest,
+    include,
+    exclude,
+  };
+}
+
+/**
+ * Get the core options to use, taking into account overrides.
+ */
+export function getCoreOptions<
+  CoreOptions extends object,
+  Options extends Readonly<OverridableOptions<CoreOptions>>,
+>(
+  node: TSESTree.Node,
+  context: Readonly<RuleContext<string, unknown[]>>,
+  options: Readonly<Options>,
+): CoreOptions | null {
+  const program = context.sourceCode.parserServices?.program ?? undefined;
+  if (program === undefined) {
+    return options;
+  }
+
+  const [type, typeNode] = getTypeDataOfNode(node, context);
+  return getCoreOptionsForType(type, typeNode, context, options);
+}
+
+export function getCoreOptionsForType<
+  CoreOptions extends object,
+  Options extends Readonly<OverridableOptions<CoreOptions>>,
+>(
+  type: Type,
+  typeNode: TypeNode | null,
+  context: Readonly<RuleContext<string, unknown[]>>,
+  options: Readonly<Options>,
+): CoreOptions | null {
+  const program = context.sourceCode.parserServices?.program ?? undefined;
+  if (program === undefined) {
+    return options;
+  }
+
+  const found = options.overrides?.find((override) =>
+    (Array.isArray(override.specifiers)
+      ? override.specifiers
+      : [override.specifiers]
+    ).some(
+      (specifier) =>
+        typeMatchesSpecifierDeep(program, specifier, type) &&
+        (specifier.include === undefined ||
+          specifier.include.length === 0 ||
+          typeMatchesPattern(
+            program,
+            type,
+            typeNode,
+            specifier.include,
+            specifier.exclude,
+          )),
+    ),
+  );
+
+  if (found !== undefined) {
+    if (found.disable === true) {
+      return null;
+    }
+    if (found.inherit !== false) {
+      return deepmerge(options, found.options) as CoreOptions;
+    }
+    return found.options;
+  }
+
+  return options;
+}
+
+function typeMatchesSpecifierDeep(
+  program: Program,
+  specifier: TypeDeclarationSpecifier,
+  type: Type,
+) {
+  const m_stack = [type];
+  // eslint-disable-next-line functional/no-loop-statements -- best to do this iteratively.
+  while (m_stack.length > 0) {
+    const t = m_stack.pop() ?? assert.fail();
+
+    if (typeMatchesSpecifier(program, specifier, t)) {
+      return true;
+    }
+
+    if (t.aliasTypeArguments !== undefined) {
+      m_stack.push(...t.aliasTypeArguments);
+    }
+  }
+
+  return false;
+}

src/utils/rule.ts

@@ -1,3 +1,5 @@
+import assert from "node:assert/strict";
+
 import { type TSESTree } from "@typescript-eslint/utils";
 import {
   type NamedCreateRuleMeta,
@@ -23,6 +25,8 @@ import { getImmutabilityOverrides } from "#/settings";
 import { __VERSION__ } from "#/utils/constants";
 import { type ESFunction } from "#/utils/node-types";
 
+import { typeMatchesPattern } from "./type-specifier";
+
 type Docs = {
   /**
    * Used for creating category configs and splitting the README rules list into sub-lists.
@@ -188,12 +192,46 @@ export function getTypeOfNode<Context extends RuleContext<string, BaseOptions>>(
   node: TSESTree.Node,
   context: Context,
 ): Type {
+  assert(typescript !== undefined);
+
   const { esTreeNodeToTSNodeMap } = getParserServices(context);
 
   const tsNode = esTreeNodeToTSNodeMap.get(node);
   return getTypeOfTSNode(tsNode, context);
 }
 
+/**
+ * Get the type of the the given node.
+ */
+export function getTypeNodeOfNode<
+  Context extends RuleContext<string, BaseOptions>,
+>(node: TSESTree.Node, context: Context): TypeNode | null {
+  assert(typescript !== undefined);
+
+  const { esTreeNodeToTSNodeMap } = getParserServices(context);
+
+  const tsNode = esTreeNodeToTSNodeMap.get(node) as TSNode & {
+    type?: TypeNode;
+  };
+  return tsNode.type ?? null;
+}
+
+/**
+ * Get the type of the the given node.
+ */
+export function getTypeDataOfNode<
+  Context extends RuleContext<string, BaseOptions>,
+>(node: TSESTree.Node, context: Context): [Type, TypeNode | null] {
+  assert(typescript !== undefined);
+
+  const { esTreeNodeToTSNodeMap } = getParserServices(context);
+
+  const tsNode = esTreeNodeToTSNodeMap.get(node) as TSNode & {
+    type?: TypeNode;
+  };
+  return [getTypeOfTSNode(tsNode, context), tsNode.type ?? null];
+}
+
 /**
  * Get the type of the the given ts node.
  */
@@ -284,6 +322,7 @@ export function getTypeImmutabilityOfNode<
     // Don't use the global cache in testing environments as it may cause errors when switching between different config options.
     process.env["NODE_ENV"] !== "test",
     maxImmutability,
+    typeMatchesPattern,
   );
 }
 

src/utils/schemas.ts

@@ -0,0 +1,81 @@
+import {
+  type JSONSchema4,
+  type JSONSchema4ObjectSchema,
+} from "@typescript-eslint/utils/json-schema";
+
+const typeSpecifierPatternSchemaProperties: JSONSchema4ObjectSchema["properties"] =
+  {
+    name: schemaInstanceOrInstanceArray({
+      type: "string",
+    }),
+    pattern: schemaInstanceOrInstanceArray({
+      type: "string",
+    }),
+    ignoreName: schemaInstanceOrInstanceArray({
+      type: "string",
+    }),
+    ignorePattern: schemaInstanceOrInstanceArray({
+      type: "string",
+    }),
+  };
+
+const typeSpecifierSchema: JSONSchema4 = {
+  oneOf: [
+    {
+      type: "object",
+      properties: {
+        ...typeSpecifierPatternSchemaProperties,
+        from: {
+          type: "string",
+          enum: ["file"],
+        },
+        path: {
+          type: "string",
+        },
+      },
+      additionalProperties: false,
+    },
+    {
+      type: "object",
+      properties: {
+        ...typeSpecifierPatternSchemaProperties,
+        from: {
+          type: "string",
+          enum: ["lib"],
+        },
+      },
+      additionalProperties: false,
+    },
+    {
+      type: "object",
+      properties: {
+        ...typeSpecifierPatternSchemaProperties,
+        from: {
+          type: "string",
+          enum: ["package"],
+        },
+        package: {
+          type: "string",
+        },
+      },
+      additionalProperties: false,
+    },
+  ],
+};
+
+export const typeSpecifiersSchema: JSONSchema4 =
+  schemaInstanceOrInstanceArray(typeSpecifierSchema);
+
+export function schemaInstanceOrInstanceArray(
+  items: JSONSchema4,
+): NonNullable<JSONSchema4ObjectSchema["properties"]>[string] {
+  return {
+    oneOf: [
+      items,
+      {
+        type: "array",
+        items,
+      },
+    ],
+  };
+}