feat(prefer-immutable-types): allow overriding options based on where the type is declared

fix #800

Author: RebeccaStevens

docs/rules/prefer-immutable-types.md

@@ -475,3 +475,22 @@ It allows for the ability to ignore violations based on the identifier (name) of
 
 This option takes a `RegExp` string or an array of `RegExp` strings.
 It allows for the ability to ignore violations based on the type (as written, with whitespace removed) of the node in question.
+
+### `overrides`
+
+Allows for applying overrides to the options based on where the type is defined.
+This can be used to override the settings for types coming from 3rd party libraries.
+
+Note: Only the first matching override will be used.
+
+#### `overrides[n].specifiers`
+
+A specifier, or an array of specifiers to match the function type against.
+
+#### `overrides[n].options`
+
+The options to use when a specifiers matches.
+
+#### `overrides[n].disable`
+
+If true, when a specifier matches, this rule will not be applied to the matching node.

src/options/index.ts

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

src/options/overrides.ts

@@ -0,0 +1,68 @@
+import { type TSESTree } from "@typescript-eslint/utils";
+import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
+import typeMatchesSpecifier, {
+  type TypeDeclarationSpecifier,
+} from "ts-declaration-location";
+
+import { getTypeOfNode } from "../utils/rule";
+
+/**
+ * Options that can be overridden.
+ */
+export type OverridableOptions<CoreOptions> = CoreOptions & {
+  overrides?: Array<
+    {
+      specifiers: TypeDeclarationSpecifier | TypeDeclarationSpecifier[];
+    } & (
+      | {
+          options: CoreOptions;
+          disable?: false;
+        }
+      | {
+          disable: true;
+        }
+    )
+  >;
+};
+
+/**
+ * Get the core options to use, taking into account overrides.
+ *
+ * @throws when there is a configuration error.
+ */
+export function getCoreOptions<
+  CoreOptions extends object,
+  Options extends readonly [Readonly<OverridableOptions<CoreOptions>>],
+>(
+  node: TSESTree.Node,
+  context: Readonly<RuleContext<string, Options>>,
+  options: Readonly<Options>,
+): CoreOptions | null {
+  const [optionsObject] = options;
+
+  const program = context.sourceCode.parserServices?.program ?? undefined;
+  if (program === undefined) {
+    return optionsObject;
+  }
+
+  const type = getTypeOfNode(node, context);
+  const found = optionsObject.overrides?.find((override) =>
+    (Array.isArray(override.specifiers)
+      ? override.specifiers
+      : [override.specifiers]
+    ).some((specifier) => typeMatchesSpecifier(program, specifier, type)),
+  );
+
+  if (found !== undefined) {
+    if (found.disable === true) {
+      return null;
+    }
+    if (found.options === undefined) {
+      // eslint-disable-next-line functional/no-throw-statements
+      throw new Error("Configuration error: No options found for override.");
+    }
+    return found.options;
+  }
+
+  return optionsObject;
+}

src/rules/functional-parameters.ts

@@ -5,23 +5,21 @@ import {
 } from "@typescript-eslint/utils/json-schema";
 import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { deepmerge } from "deepmerge-ts";
-import typeMatchesSpecifier, {
-  type TypeDeclarationSpecifier,
-} from "ts-declaration-location";
 
 import {
+  getCoreOptions,
   ignoreIdentifierPatternOptionSchema,
   ignorePrefixSelectorOptionSchema,
   shouldIgnorePattern,
   type IgnoreIdentifierPatternOption,
   type IgnorePrefixSelectorOption,
+  type OverridableOptions,
 } from "#eslint-plugin-functional/options";
 import { typeSpecifiersSchema } from "#eslint-plugin-functional/utils/common-schemas";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import { type ESFunction } from "#eslint-plugin-functional/utils/node-types";
 import {
   createRuleUsingFunction,
-  getTypeOfNode,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
 } from "#eslint-plugin-functional/utils/rule";
@@ -69,23 +67,7 @@ type CoreOptions = IgnoreIdentifierPatternOption &
 /**
  * The options this rule can take.
  */
-type Options = [
-  CoreOptions & {
-    overrides?: Array<
-      {
-        specifiers: TypeDeclarationSpecifier | TypeDeclarationSpecifier[];
-      } & (
-        | {
-            options: CoreOptions;
-            disable?: false;
-          }
-        | {
-            disable: true;
-          }
-      )
-    >;
-  },
-];
+type Options = [OverridableOptions<CoreOptions>];
 
 const coreOptionsPropertiesSchema: JSONSchema4ObjectSchema["properties"] = {
   allowRestParameter: {
@@ -206,39 +188,6 @@ const meta: NamedCreateRuleCustomMeta<keyof typeof errorMessages, Options> = {
   schema,
 };
 
-/**
- * Get the core options to use, taking into account overrides.
- */
-function getCoreOptions(
-  node: TSESTree.Node,
-  context: Readonly<RuleContext<keyof typeof errorMessages, Options>>,
-  options: Readonly<Options>,
-): CoreOptions | null {
-  const [optionsObject] = options;
-
-  const program = context.sourceCode.parserServices?.program ?? undefined;
-  if (program === undefined) {
-    return optionsObject;
-  }
-
-  const type = getTypeOfNode(node, context);
-  const found = optionsObject.overrides?.find((override) =>
-    (Array.isArray(override.specifiers)
-      ? override.specifiers
-      : [override.specifiers]
-    ).some((specifier) => typeMatchesSpecifier(program, specifier, type)),
-  );
-
-  if (found !== undefined) {
-    if (found.disable === true) {
-      return null;
-    }
-    return found.options;
-  }
-
-  return optionsObject;
-}
-
 /**
  * Get the rest parameter violations.
  */
@@ -313,7 +262,11 @@ function checkFunction(
   context: Readonly<RuleContext<keyof typeof errorMessages, Options>>,
   options: Readonly<Options>,
 ): RuleResult<keyof typeof errorMessages, Options> {
-  const optionsToUse = getCoreOptions(node, context, options);
+  const optionsToUse = getCoreOptions<CoreOptions, Options>(
+    node,
+    context,
+    options,
+  );
 
   if (optionsToUse === null) {
     return {
@@ -359,7 +312,7 @@ function checkIdentifier(
   const optionsToUse =
     functionNode === null
       ? options[0]
-      : getCoreOptions(functionNode, context, options);
+      : getCoreOptions<CoreOptions, Options>(functionNode, context, options);
 
   if (optionsToUse === null) {
     return {