fix!: replace ignorePattern option with ignoreIdentifierPattern and ignoreCodePattern

fix #467

Author: RebeccaStevens

docs/rules/functional-parameters.md

@@ -65,7 +65,7 @@ type Options = {
         ignoreIIFE: boolean;
         ignoreGettersAndSetters: boolean;
       };
-  ignorePattern?: string[] | string;
+  ignoreIdentifierPattern?: string[] | string;
   ignorePrefixSelector?: string[] | string;
 };
 ```
@@ -192,7 +192,7 @@ The following inline callback won't be flagged:
 const sum = [1, 2, 3].reduce((carry, current) => current, 0);
 ```
 
-### `ignorePattern`
+### `ignoreIdentifierPattern`
 
 This option takes a RegExp string or an array of RegExp strings.
 It allows for the ability to ignore violations based on a function's name.

docs/rules/immutable-data.md

@@ -61,7 +61,7 @@ This rule accepts an options object of the following type:
 type Options = {
   ignoreClasses: boolean | "fieldsOnly";
   ignoreImmediateMutation: boolean;
-  ignorePattern?: string[] | string;
+  ignoreIdentifierPattern?: string[] | string;
   ignoreAccessorPattern?: string[] | string;
 };
 ```
@@ -103,7 +103,7 @@ Ignore mutations inside classes.
 
 Classes already aren't functional so ignore mutations going on inside them.
 
-### `ignorePattern`
+### `ignoreIdentifierPattern`
 
 This option takes a RegExp string or an array of RegExp strings.
 It allows for the ability to ignore violations based on a variable's name.

docs/rules/no-expression-statements.md

@@ -58,7 +58,7 @@ This rule accepts an options object of the following type:
 
 ```ts
 type Options = {
-  ignorePattern?: string[] | string;
+  ignoreCodePattern?: string[] | string;
   ignoreVoid?: boolean;
   ignoreSelfReturning?: boolean;
 };
@@ -83,7 +83,7 @@ Like `ignoreVoid` but instead does not flag function calls that always only retu
 
 Limitation: The function declaration must explicitly use `return this`; equivalents (such as assign this to a variable first, that is then returned) won't be considered valid.
 
-### `ignorePattern`
+### `ignoreCodePattern`
 
 This option takes a RegExp string or an array of RegExp strings.
-It allows for the ability to ignore violations based on the line(s) of code.
+It allows for the ability to ignore violations based on the code itself.

docs/rules/no-let.md

@@ -57,7 +57,7 @@ This rule accepts an options object of the following type:
 ```ts
 type Options = {
   allowInFunctions: boolean;
-  ignorePattern?: string[] | string;
+  ignoreIdentifierPattern?: string[] | string;
 };
 ```
 
@@ -118,7 +118,7 @@ for (let [index, element] of array.entries()) {
 
 If true, the rule will not flag any statements that are inside of function bodies.
 
-### `ignorePattern`
+### `ignoreIdentifierPattern`
 
 This option takes a RegExp string or an array of RegExp strings.
 It allows for the ability to ignore violations based on a variable's name.

docs/rules/type-declaration-immutability.md

@@ -86,7 +86,7 @@ type Options = {
       | false;
   }>;
   ignoreInterfaces: boolean;
-  ignorePattern: string[] | string;
+  ignoreIdentifierPattern: string[] | string;
 };
 ```
 
@@ -189,7 +189,7 @@ If not set, or set to `false`, the fixer will be disabled.
 A boolean to specify whether interfaces should be exempt from these rules.
 `false` by default.
 
-### `ignorePattern`
+### `ignoreIdentifierPattern`
 
 This option takes a RegExp string or an array of RegExp strings.
 It allows for the ability to ignore violations based on a type's name.

package.json

@@ -87,7 +87,7 @@
     "@cspell/dict-cryptocurrencies": "3.0.1",
     "@google/semantic-release-replace-plugin": "1.2.7",
     "@istanbuljs/nyc-config-typescript": "1.0.2",
-    "@rebeccastevens/eslint-config": "2.0.1",
+    "@rebeccastevens/eslint-config": "2.0.2",
     "@rollup/plugin-commonjs": "25.0.3",
     "@rollup/plugin-json": "6.0.0",
     "@rollup/plugin-typescript": "11.1.2",

pnpm-lock.yaml

@@ -3,7 +3,10 @@ import { type JSONSchema4ObjectSchema } from "@typescript-eslint/utils/json-sche
 import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import escapeRegExp from "escape-string-regexp";
 
-import { getNodeIdentifierTexts } from "#eslint-plugin-functional/utils/misc";
+import {
+  getNodeCode,
+  getNodeIdentifierTexts,
+} from "#eslint-plugin-functional/utils/misc";
 import { type BaseOptions } from "#eslint-plugin-functional/utils/rule";
 import {
   isInClass,
@@ -20,16 +23,36 @@ import {
 /**
  * The option to ignore patterns.
  */
-export type IgnorePatternOption = Readonly<{
-  ignorePattern?: ReadonlyArray<string> | string;
+export type IgnoreIdentifierPatternOption = Readonly<{
+  ignoreIdentifierPattern?: ReadonlyArray<string> | string;
+}>;
+
+/**
+ * The schema for the option to ignore patterns.
+ */
+export const ignoreIdentifierPatternOptionSchema: JSONSchema4ObjectSchema["properties"] =
+  {
+    ignoreIdentifierPattern: {
+      type: ["string", "array"],
+      items: {
+        type: "string",
+      },
+    },
+  };
+
+/**
+ * The option to ignore patterns.
+ */
+export type IgnoreCodePatternOption = Readonly<{
+  ignoreCodePattern?: ReadonlyArray<string> | string;
 }>;
 
 /**
  * The schema for the option to ignore patterns.
  */
-export const ignorePatternOptionSchema: JSONSchema4ObjectSchema["properties"] =
+export const ignoreCodePatternOptionSchema: JSONSchema4ObjectSchema["properties"] =
   {
-    ignorePattern: {
+    ignoreCodePattern: {
       type: ["string", "array"],
       items: {
         type: "string",
@@ -109,14 +132,12 @@ export const ignorePrefixSelectorOptionSchema: JSONSchema4ObjectSchema["properti
  */
 function shouldIgnoreViaPattern(
   text: string,
-  ignorePattern: ReadonlyArray<string> | string,
+  pattern: ReadonlyArray<string> | string,
 ): boolean {
-  const patterns = Array.isArray(ignorePattern)
-    ? ignorePattern
-    : [ignorePattern];
+  const patterns = Array.isArray(pattern) ? pattern : [pattern];
 
   // One or more patterns match?
-  return patterns.some((pattern) => new RegExp(pattern, "u").test(text));
+  return patterns.some((p) => new RegExp(p, "u").test(text));
 }
 
 /**
@@ -173,15 +194,13 @@ function accessorPatternMatch(
  */
 function shouldIgnoreViaAccessorPattern(
   text: string,
-  ignorePattern: ReadonlyArray<string> | string,
+  pattern: ReadonlyArray<string> | string,
 ): boolean {
-  const patterns = Array.isArray(ignorePattern)
-    ? ignorePattern
-    : [ignorePattern];
+  const patterns = Array.isArray(pattern) ? pattern : [pattern];
 
   // One or more patterns match?
-  return patterns.some((pattern) =>
-    accessorPatternMatch(pattern.split("."), text.split(".")),
+  return patterns.some((p) =>
+    accessorPatternMatch(p.split("."), text.split(".")),
   );
 }
 
@@ -223,30 +242,43 @@ export function shouldIgnoreClasses(
  * Should the given node be allowed base off the following rule options?
  *
  * - IgnoreAccessorPatternOption.
- * - IgnorePatternOption.
+ * - IgnoreIdentifierPatternOption.
  */
 export function shouldIgnorePattern(
   node: TSESTree.Node,
   context: Readonly<RuleContext<string, BaseOptions>>,
-  ignorePattern: Readonly<Partial<IgnorePatternOption>["ignorePattern"]>,
+  ignoreIdentifierPattern: Readonly<
+    Partial<IgnoreIdentifierPatternOption>["ignoreIdentifierPattern"]
+  >,
   ignoreAccessorPattern?: Readonly<
     Partial<IgnoreAccessorPatternOption>["ignoreAccessorPattern"]
   >,
+  ignoreCodePattern?: Readonly<
+    Partial<IgnoreCodePatternOption>["ignoreCodePattern"]
+  >,
 ): boolean {
   const texts = getNodeIdentifierTexts(node, context);
 
   if (texts.length === 0) {
-    return false;
+    return (
+      ignoreCodePattern !== undefined &&
+      shouldIgnoreViaPattern(getNodeCode(node, context), ignoreCodePattern)
+    );
   }
 
   return (
-    // Ignore if ignorePattern is set and a pattern matches.
-    (ignorePattern !== undefined &&
-      texts.every((text) => shouldIgnoreViaPattern(text, ignorePattern))) ||
+    // Ignore if ignoreIdentifierPattern is set and a pattern matches.
+    (ignoreIdentifierPattern !== undefined &&
+      texts.every((text) =>
+        shouldIgnoreViaPattern(text, ignoreIdentifierPattern),
+      )) ||
     // Ignore if ignoreAccessorPattern is set and an accessor pattern matches.
     (ignoreAccessorPattern !== undefined &&
       texts.every((text) =>
         shouldIgnoreViaAccessorPattern(text, ignoreAccessorPattern),
-      ))
+      )) ||
+    // Ignore if ignoreCodePattern is set and a code pattern matches.
+    (ignoreCodePattern !== undefined &&
+      shouldIgnoreViaPattern(getNodeCode(node, context), ignoreCodePattern))
   );
 }

src/options/ignore.ts

@@ -7,12 +7,12 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { deepmerge } from "deepmerge-ts";
 
 import {
-  type IgnorePatternOption,
+  type IgnoreIdentifierPatternOption,
   type IgnorePrefixSelectorOption,
 } from "#eslint-plugin-functional/options";
 import {
   shouldIgnorePattern,
-  ignorePatternOptionSchema,
+  ignoreIdentifierPatternOptionSchema,
   ignorePrefixSelectorOptionSchema,
 } from "#eslint-plugin-functional/options";
 import { type ESFunction } from "#eslint-plugin-functional/utils/node-types";
@@ -45,7 +45,7 @@ type ParameterCountOptions = "atLeastOne" | "exactlyOne";
  * The options this rule can take.
  */
 type Options = [
-  IgnorePatternOption &
+  IgnoreIdentifierPatternOption &
     IgnorePrefixSelectorOption & {
       allowRestParameter: boolean;
       allowArgumentsKeyword: boolean;
@@ -68,7 +68,7 @@ const schema: JSONSchema4[] = [
   {
     type: "object",
     properties: deepmerge(
-      ignorePatternOptionSchema,
+      ignoreIdentifierPatternOptionSchema,
       ignorePrefixSelectorOptionSchema,
       {
         allowRestParameter: {
@@ -230,9 +230,9 @@ function checkFunction(
   options: Readonly<Options>,
 ): RuleResult<keyof typeof errorMessages, Options> {
   const [optionsObject] = options;
-  const { ignorePattern } = optionsObject;
+  const { ignoreIdentifierPattern } = optionsObject;
 
-  if (shouldIgnorePattern(node, context, ignorePattern)) {
+  if (shouldIgnorePattern(node, context, ignoreIdentifierPattern)) {
     return {
       context,
       descriptors: [],
@@ -257,9 +257,9 @@ function checkIdentifier(
   options: Readonly<Options>,
 ): RuleResult<keyof typeof errorMessages, Options> {
   const [optionsObject] = options;
-  const { ignorePattern } = optionsObject;
+  const { ignoreIdentifierPattern } = optionsObject;
 
-  if (shouldIgnorePattern(node, context, ignorePattern)) {
+  if (shouldIgnorePattern(node, context, ignoreIdentifierPattern)) {
     return {
       context,
       descriptors: [],