feat!: rename many of the options

docs/rules/immutable-data.md

@@ -63,7 +63,7 @@ type Options = {
         forArrays: boolean;
         forObjects: boolean;
       }
-  ignoreClass: boolean | "fieldsOnly";
+  ignoreClasses: boolean | "fieldsOnly";
   ignoreImmediateMutation: boolean;
   ignorePattern?: string[] | string;
   ignoreAccessorPattern?: string[] | string;
@@ -75,7 +75,7 @@ type Options = {
 ```ts
 type Options = {
   assumeTypes: true;
-  ignoreClass: false;
+  ignoreClasses: false;
   ignoreImmediateMutation: true;
 };
 ```
@@ -86,7 +86,7 @@ type Options = {
 
 ```ts
 const liteOptions = {
-  ignoreClass: "fieldsOnly",
+  ignoreClasses: "fieldsOnly",
 }
 ```
 
@@ -121,7 +121,7 @@ const original = ["foo", "bar", "baz"];
 const sorted = [...original].sort((a, b) => a.localeCompare(b)); // This is OK with ignoreImmediateMutation.
 ```
 
-### `ignoreClass`
+### `ignoreClasses`
 
 Ignore mutations inside classes.
 

docs/rules/no-let.md

@@ -53,7 +53,7 @@ This rule accepts an options object of the following type:
 
 ```ts
 type Options = {
-  allowLocalMutation: boolean;
+  allowInFunctions: boolean;
   ignorePattern?: string[] | string;
 }
 ```
@@ -63,7 +63,7 @@ type Options = {
 ```ts
 const defaults = {
   allowInForLoopInit: false,
-  allowLocalMutation: false
+  allowInFunctions: false
 }
 ```
 
@@ -112,9 +112,11 @@ for (let [index, element] of array.entries()) {
 }
 ```
 
-### `allowLocalMutation`
+### `allowInFunctions`
 
-See the [allowLocalMutation](./options/allow-local-mutation.md) docs.
+If true, the rule will not flag any statements that are inside of function bodies.
+
+See the [allowLocalMutation](./options/allow-local-mutation.md) docs for more information.
 
 ### `ignorePattern`
 

docs/rules/no-return-void.md

@@ -41,7 +41,7 @@ This rule accepts an options object of the following type:
 type Options = {
   allowNull: boolean;
   allowUndefined: boolean;
-  ignoreImplicit: boolean;
+  ignoreInferredTypes: boolean;
 }
 ```
 
@@ -51,18 +51,18 @@ type Options = {
 const defaults = {
   allowNull: true,
   allowUndefined: true,
-  ignoreImplicit: false,
+  ignoreInferredTypes: false,
 }
 ```
 
-### allowNull
+### `allowNull`
 
 If true allow returning null.
 
-### allowUndefined
+### `allowUndefined`
 
 If true allow returning undefined.
 
-### ignoreImplicit
+### `ignoreInferredTypes`
 
 If true ignore functions that don't explicitly specify a return type.

docs/rules/prefer-immutable-types.md

@@ -143,20 +143,30 @@ This rule accepts an options object of the following type:
 type Options = {
   enforcement: "None" | "ReadonlyShallow" | "ReadonlyDeep" | "Immutable";
   ignoreInferredTypes: boolean;
+  ignoreClasses: boolean | "fieldsOnly";
+  ignorePattern?: string[] | string;
 
   parameters?: {
-    // The same properties as above or just an enforcement value.
+    enforcement: "None" | "ReadonlyShallow" | "ReadonlyDeep" | "Immutable";
+    ignoreInferredTypes: boolean;
+    ignoreClasses: boolean | "fieldsOnly";
+    ignorePattern?: string[] | string;
   };
+
   returnTypes?: {
-    // The same properties as above or just an enforcement value.
+    enforcement: "None" | "ReadonlyShallow" | "ReadonlyDeep" | "Immutable";
+    ignoreInferredTypes: boolean;
+    ignoreClasses: boolean | "fieldsOnly";
+    ignorePattern?: string[] | string;
   };
+
   variables?: {
-    // The same properties as above or just an enforcement value.
+    enforcement: "None" | "ReadonlyShallow" | "ReadonlyDeep" | "Immutable";
+    allowInFunctions: boolean;
+    ignoreInferredTypes: boolean;
+    ignoreClasses: boolean | "fieldsOnly";
+    ignorePattern?: string[] | string;
   };
-
-  allowLocalMutation: boolean;
-  ignoreClass: boolean | "fieldsOnly";
-  ignorePattern?: string[] | string;
 }
 ```
 
@@ -166,7 +176,7 @@ type Options = {
 const defaults = {
   enforcement: "Immutable",
   allowLocalMutation: false,
-  ignoreClass: false,
+  ignoreClasses: false,
   ignoreInferredTypes: false,
 }
 ```
@@ -179,7 +189,9 @@ const defaults = {
 const recommendedOptions = {
   enforcement: "None",
   ignoreInferredTypes: true,
-  parameters: "ReadonlyDeep",
+  parameters: {
+    enforcement: "ReadonlyDeep",
+  },
 },
 ```
 
@@ -189,7 +201,9 @@ const recommendedOptions = {
 const liteOptions = {
   enforcement: "None",
   ignoreInferredTypes: true,
-  parameters: "ReadonlyShallow",
+  parameters: {
+    enforcement: "ReadonlyShallow",
+  },
 },
 ```
 
@@ -239,6 +253,10 @@ type. This may be desirable in cases where an external dependency specifies a
 callback with mutable parameters, and manually annotating the callback's
 parameters is undesirable.
 
+### `ignoreClasses`
+
+A boolean to specify if checking classes should be ignored. `false` by default.
+
 <!--tabs-->
 
 #### ❌ Incorrect
@@ -301,13 +319,12 @@ export const acceptsCallback: AcceptsCallback;
 
 Override the options specifically for the given type of types.
 
-### `ignoreClass`
 
-A boolean to specify if checking classes should be ignored. `false` by default.
+#### `variables.ignoreInFunctions`
 
-### `allowLocalMutation`
+If true, the rule will not flag any variables that are inside of function bodies.
 
-See the [allowLocalMutation](./options/allow-local-mutation.md) docs.
+See the [allowLocalMutation](./options/allow-local-mutation.md) docs for more information.
 
 ### `ignorePattern`
 

src/common/ignore-options.ts

@@ -14,28 +14,12 @@ import {
   isThisExpression,
 } from "~/util/typeguard";
 
-/**
- * The option to allow local mutations.
- */
-export type AllowLocalMutationOption = {
-  readonly allowLocalMutation: boolean;
-};
-
-/**
- * The schema for the option to allow local mutations.
- */
-export const allowLocalMutationOptionSchema: JSONSchema4["properties"] = {
-  allowLocalMutation: {
-    type: "boolean",
-  },
-};
-
 /**
  * The option to ignore patterns.
  */
-export type IgnorePatternOption = {
-  readonly ignorePattern?: ReadonlyArray<string> | string;
-};
+export type IgnorePatternOption = Readonly<{
+  ignorePattern?: ReadonlyArray<string> | string;
+}>;
 
 /**
  * The schema for the option to ignore patterns.
@@ -52,9 +36,9 @@ export const ignorePatternOptionSchema: JSONSchema4["properties"] = {
 /**
  * The option to ignore accessor patterns.
  */
-export type IgnoreAccessorPatternOption = {
-  readonly ignoreAccessorPattern?: ReadonlyArray<string> | string;
-};
+export type IgnoreAccessorPatternOption = Readonly<{
+  ignoreAccessorPattern?: ReadonlyArray<string> | string;
+}>;
 
 /**
  * The schema for the option to ignore accessor patterns.
@@ -71,15 +55,15 @@ export const ignoreAccessorPatternOptionSchema: JSONSchema4["properties"] = {
 /**
  * The option to ignore classes.
  */
-export type IgnoreClassOption = {
-  readonly ignoreClass: boolean | "fieldsOnly";
-};
+export type IgnoreClassesOption = Readonly<{
+  ignoreClasses: boolean | "fieldsOnly";
+}>;
 
 /**
  * The schema for the option to ignore classes.
  */
-export const ignoreClassOptionSchema: JSONSchema4["properties"] = {
-  ignoreClass: {
+export const ignoreClassesOptionSchema: JSONSchema4["properties"] = {
+  ignoreClasses: {
     oneOf: [
       {
         type: "boolean",
@@ -95,25 +79,25 @@ export const ignoreClassOptionSchema: JSONSchema4["properties"] = {
 /**
  * The option to ignore interfaces.
  */
-export type IgnoreInterfaceOption = {
-  readonly ignoreInterface: boolean;
-};
+export type IgnoreInterfacesOption = Readonly<{
+  ignoreInterfaces: boolean;
+}>;
 
 /**
  * The schema for the option to ignore interfaces.
  */
-export const ignoreInterfaceOptionSchema: JSONSchema4["properties"] = {
-  ignoreInterface: {
+export const ignoreInterfacesOptionSchema: JSONSchema4["properties"] = {
+  ignoreInterfaces: {
     type: "boolean",
   },
 };
 
 /**
  * The option to ignore prefix selector.
  */
-export type IgnorePrefixSelectorOption = {
-  readonly ignorePrefixSelector?: ReadonlyArray<string> | string;
-};
+export type IgnorePrefixSelectorOption = Readonly<{
+  ignorePrefixSelector?: ReadonlyArray<string> | string;
+}>;
 
 /**
  * The schema for the option to ignore prefix selector.
@@ -213,29 +197,29 @@ function shouldIgnoreViaAccessorPattern(
 /**
  * Should the given node be allowed base off the following rule options?
  *
- * - AllowLocalMutationOption.
+ * - AllowInFunctionOption.
  */
-export function shouldIgnoreLocalMutation(
+export function shouldIgnoreInFunction(
   node: ReadonlyDeep<TSESTree.Node>,
   context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>,
-  { allowLocalMutation }: Partial<AllowLocalMutationOption>
+  allowInFunction: boolean | undefined
 ): boolean {
-  return allowLocalMutation === true && inFunctionBody(node);
+  return allowInFunction === true && inFunctionBody(node);
 }
 
 /**
  * Should the given node be allowed base off the following rule options?
  *
- * - IgnoreClassOption.
+ * - IgnoreClassesOption.
  */
-export function shouldIgnoreClass(
+export function shouldIgnoreClasses(
   node: ReadonlyDeep<TSESTree.Node>,
   context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>,
-  { ignoreClass }: Partial<IgnoreClassOption>
+  ignoreClasses: Partial<IgnoreClassesOption>["ignoreClasses"]
 ): boolean {
   return (
-    (ignoreClass === true && inClass(node)) ||
-    (ignoreClass === "fieldsOnly" &&
+    (ignoreClasses === true && inClass(node)) ||
+    (ignoreClasses === "fieldsOnly" &&
       (isPropertyDefinition(node) ||
         (isAssignmentExpression(node) &&
           inClass(node) &&
@@ -247,14 +231,14 @@ export function shouldIgnoreClass(
 /**
  * Should the given node be allowed base off the following rule options?
  *
- * - IgnoreInterfaceOption.
+ * - IgnoreInterfacesOption.
  */
-export function shouldIgnoreInterface(
+export function shouldIgnoreInterfaces(
   node: ReadonlyDeep<TSESTree.Node>,
   context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>,
-  { ignoreInterface }: Partial<IgnoreInterfaceOption>
+  ignoreInterfaces: Partial<IgnoreInterfacesOption>["ignoreInterfaces"]
 ): boolean {
-  return ignoreInterface === true && inInterface(node);
+  return ignoreInterfaces === true && inInterface(node);
 }
 
 /**
@@ -266,10 +250,8 @@ export function shouldIgnoreInterface(
 export function shouldIgnorePattern(
   node: ReadonlyDeep<TSESTree.Node>,
   context: ReadonlyDeep<TSESLint.RuleContext<string, BaseOptions>>,
-  {
-    ignorePattern,
-    ignoreAccessorPattern,
-  }: Partial<IgnoreAccessorPatternOption & IgnorePatternOption>
+  ignorePattern: Partial<IgnorePatternOption>["ignorePattern"],
+  ignoreAccessorPattern?: Partial<IgnoreAccessorPatternOption>["ignoreAccessorPattern"]
 ): boolean {
   const texts = getNodeIdentifierTexts(node, context);
 

src/configs/lite.ts

@@ -19,7 +19,7 @@ const overrides: Linter.Config = {
     ],
     [`functional/${immutableData.name}`]: [
       "error",
-      { ignoreClass: "fieldsOnly" },
+      { ignoreClasses: "fieldsOnly" },
     ],
     [`functional/${noConditionalStatements.name}`]: "off",
     [`functional/${noExpressionStatements.name}`]: "off",
@@ -28,7 +28,9 @@ const overrides: Linter.Config = {
       {
         enforcement: "None",
         ignoreInferredTypes: true,
-        parameters: "ReadonlyShallow",
+        parameters: {
+          enforcement: "ReadonlyShallow",
+        },
       },
     ],
   },

src/configs/recommended.ts

@@ -50,7 +50,9 @@ const overrides: Linter.Config = {
       {
         enforcement: "None",
         ignoreInferredTypes: true,
-        parameters: "ReadonlyDeep",
+        parameters: {
+          enforcement: "ReadonlyDeep",
+        },
       },
     ],
     [`functional/${typeDeclarationImmutability.name}`]: [