style: apply new linting styles

Author: RebeccaStevens

GETTING_STARTED.md

@@ -45,13 +45,13 @@ export default [
   ...functional.configs.externalVanillaRecommended,
   ...functional.configs.recommended,
   ...functional.configs.stylistic,
-  ...functional.configs.disableTypeChecked
+  ...functional.configs.disableTypeChecked,
   // your other plugin configs here
   {
-  rules: {
-    // any rule configs here
+    rules: {
+      // any rule configs here
+    },
   },
-}
 ];
 ```
 
@@ -61,8 +61,8 @@ In your `eslint.config.js` file, import `typescript-eslint` and `eslint-plugin-f
 
 ```js
 // eslint.config.js
-import tseslint from 'typescript-eslint';
 import functional from "eslint-plugin-functional";
+import tseslint from "typescript-eslint";
 
 export default tseslint.config({
   files: ["**/*.ts"],

cz-adapter/engine.ts

@@ -21,13 +21,13 @@ type CZ = any;
 /**
  * The engine.
  */
-export default (
-  options: Options,
-): { prompter: (cz: CZ, commit: (msg: string) => unknown) => void } => {
-  return {
+export default {
+  create: (
+    options: Options,
+  ): { prompter: (cz: CZ, commit: (msg: string) => unknown) => void } => ({
     prompter: (cz, commit) =>
       promptUser(cz, options).then(doCommit(commit, options)),
-  };
+  }),
 };
 
 /**
@@ -86,9 +86,7 @@ function promptUser(cz: CZ, options: Options) {
       name: "scope",
       message: "What is the scope of this change: (press enter to skip)",
       default: defaultScope,
-      when: (answers: Answers) => {
-        return !scopeRulesType.has(answers.type);
-      },
+      when: (answers: Answers) => !scopeRulesType.has(answers.type),
       filter: filterScope(options),
     },
     {
@@ -97,19 +95,15 @@ function promptUser(cz: CZ, options: Options) {
       message: "Which rule does this change apply to:",
       choices: getRulesChoices(),
       default: defaultScope,
-      when: (answers: Answers) => {
-        return scopeRulesType.has(answers.type);
-      },
+      when: (answers: Answers) => scopeRulesType.has(answers.type),
       filter: filterScope(options),
     },
     {
       type: "confirm",
       name: "isBreaking",
       message: "Are there any breaking changes?",
       default: false,
-      when: (answers: Answers) => {
-        return possibleBreakingRulesType.has(answers.type);
-      },
+      when: (answers: Answers) => possibleBreakingRulesType.has(answers.type),
     },
     {
       type: "input",
@@ -161,9 +155,7 @@ function promptUser(cz: CZ, options: Options) {
       type: "input",
       name: "issues",
       message: 'Add issue references (e.g. "fix #123", "re #123".):\n',
-      when: (answers: Answers) => {
-        return answers.isIssueAffected;
-      },
+      when: (answers: Answers) => answers.isIssueAffected,
       default: defaultIssues,
     },
   ]);
@@ -266,11 +258,8 @@ function maxSummaryLength(options: Options, answers: Answers) {
  * Get a function to auto-process the scope.
  */
 function filterScope(options: Options) {
-  return (value: string) => {
-    return options.disableScopeLowerCase
-      ? value.trim()
-      : value.trim().toLowerCase();
-  };
+  return (value: string) =>
+    options.disableScopeLowerCase ? value.trim() : value.trim().toLowerCase();
 }
 
 /**

docs/rules/functional-parameters.md

@@ -137,7 +137,7 @@ Any function that takes multiple parameter can be rewritten as a higher-order fu
 
 Example:
 
-<!-- eslint-disable @typescript-eslint/no-redeclare -->
+<!-- eslint-disable ts/no-redeclare -->
 
 ```js
 // This function

docs/rules/no-classes.md

@@ -69,7 +69,7 @@ const Message = ({ message }) => <div>{message}</div>;
 What about lifecycle methods like `shouldComponentUpdate`? We can use the [recompose](https://github.com/acdlite/recompose) library to apply these optimizations to your Stateless Functional Components. The [recompose](https://github.com/acdlite/recompose) library relies on the fact that your Redux state is immutable to efficiently implement `shouldComponentUpdate` for you.
 
 ```js
-import { pure, onlyUpdateForKeys } from "recompose";
+import { onlyUpdateForKeys, pure } from "recompose";
 
 const Message = ({ message }) => <div>{message}</div>;
 

docs/rules/no-let.md

@@ -86,7 +86,7 @@ If set, `let`s inside of for a loop initializer are allowed. This does not inclu
 
 #### ✅ Correct
 
-<!-- eslint-disable @typescript-eslint/prefer-for-of -->
+<!-- eslint-disable ts/prefer-for-of -->
 
 ```js
 /* eslint functional/no-let: ["error", { "allowInForLoopInit": true } ] */

docs/rules/prefer-property-signatures.md

@@ -29,7 +29,7 @@ type Foo = {
 
 ### ✅ Correct
 
-<!-- eslint-disable @typescript-eslint/no-redeclare -->
+<!-- eslint-disable ts/no-redeclare -->
 
 ```ts
 /* eslint functional/prefer-property-signatures: "error" */

docs/rules/prefer-readonly-type.md

@@ -67,7 +67,7 @@ This is just as effective as using `Object.freeze()` to prevent mutations. Howev
 
 The `readonly` modifier also works on indexers:
 
-<!-- eslint-disable @typescript-eslint/consistent-indexed-object-style -->
+<!-- eslint-disable ts/consistent-indexed-object-style -->
 
 ```ts
 const foo: { readonly [key: string]: number } = { a: 1, b: 2 };

docs/rules/settings/immutability.md

@@ -32,13 +32,13 @@ readonly, then no override will be applied.
             "name": "ReadonlyArray",
           },
           "to": "Immutable",
-          "from": "ReadonlyDeep"
-        }
-      ]
-    }
+          "from": "ReadonlyDeep",
+        },
+      ],
+    },
   },
   "rules": {
     // ...
-  }
+  },
 }
 ```

docs/user-guide/migrating-from-tslint.md

@@ -22,17 +22,13 @@ In order for the parser to have access to type information, it needs access to y
   "parserOptions": {
     "ecmaVersion": 10,
     "project": "./tsconfig.json",
-    "sourceType": "module"
+    "sourceType": "module",
   },
-  "plugins": [
-    "functional"
-  ],
+  "plugins": ["functional"],
   "env": {
-    "es6": true
+    "es6": true,
   },
-  "extends": [
-    "plugin:functional/recommended"
-  ],
+  "extends": ["plugin:functional/recommended"],
   "rules": {
     // These rules will be applied to all linted file.
   },
@@ -41,9 +37,9 @@ In order for the parser to have access to type information, it needs access to y
       "files": ["*.ts", "*.tsx"],
       "rules": {
         // These rules will only be applied to ts file.
-      }
-    }
-  ]
+      },
+    },
+  ],
 }
 ```
 

eslint.config.js

@@ -25,7 +25,11 @@ export default rsEslint(
 
       // Some types say they have nonnullable properties, but they don't always.
       "ts/no-unnecessary-condition": "off",
-
+    },
+  },
+  {
+    files: ["src/**/*"],
+    rules: {
       "eslint/fixer-return": "error",
       "eslint/meta-property-ordering": "error",
       "eslint/no-deprecated-context-methods": "error",
@@ -56,7 +60,7 @@ export default rsEslint(
     },
   },
   {
-    files: ["src/configs/", "src/index.ts"],
+    files: ["src/configs/**/*", "src/index.ts"],
     rules: {
       "ts/naming-convention": "off",
     },
@@ -68,7 +72,7 @@ export default rsEslint(
     },
   },
   {
-    files: ["src/utils/conditional-imports/"],
+    files: ["src/utils/conditional-imports/**/*"],
     rules: {
       "@typescript-eslint/no-var-requires": "off",
       "functional/functional-parameters": "off",
@@ -83,14 +87,14 @@ export default rsEslint(
     },
   },
   {
-    files: ["tests/"],
+    files: ["tests/**/*"],
     rules: {
       "functional/no-return-void": "off",
       "jsdoc/require-jsdoc": "off",
     },
   },
   {
-    files: ["cz-adapter/"],
+    files: ["cz-adapter/**/*"],
     rules: {
       "no-console": "off",
 

src/index.ts

@@ -56,7 +56,6 @@ const configs = {
   stylistic: { plugins: { functional }, rules: stylistic },
 } satisfies Record<string, FlatConfig.Config>;
 
-// eslint-disable-next-line functional/immutable-data, functional/no-expression-statements
 functional.configs = configs;
 
 export default functional as FlatConfig.Plugin & {

src/rules/functional-parameters.ts

@@ -7,18 +7,18 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { deepmerge } from "deepmerge-ts";
 
 import {
+  type IgnoreIdentifierPatternOption,
+  type IgnorePrefixSelectorOption,
   ignoreIdentifierPatternOptionSchema,
   ignorePrefixSelectorOptionSchema,
   shouldIgnorePattern,
-  type IgnoreIdentifierPatternOption,
-  type IgnorePrefixSelectorOption,
 } from "#eslint-plugin-functional/options";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import { type ESFunction } from "#eslint-plugin-functional/utils/node-types";
 import {
-  createRuleUsingFunction,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRuleUsingFunction,
 } from "#eslint-plugin-functional/utils/rule";
 import {
   isArgument,

src/rules/immutable-data.ts

@@ -7,24 +7,24 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { deepmerge } from "deepmerge-ts";
 
 import {
+  type IgnoreAccessorPatternOption,
+  type IgnoreClassesOption,
+  type IgnoreIdentifierPatternOption,
   ignoreAccessorPatternOptionSchema,
   ignoreClassesOptionSchema,
   ignoreIdentifierPatternOptionSchema,
   shouldIgnoreClasses,
   shouldIgnorePattern,
-  type IgnoreAccessorPatternOption,
-  type IgnoreClassesOption,
-  type IgnoreIdentifierPatternOption,
 } from "#eslint-plugin-functional/options";
 import {
   isExpected,
   ruleNameScope,
 } from "#eslint-plugin-functional/utils/misc";
 import {
-  createRule,
-  getTypeOfNode,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
+  getTypeOfNode,
 } from "#eslint-plugin-functional/utils/rule";
 import {
   findRootIdentifier,

src/rules/no-classes.ts

@@ -4,9 +4,9 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import { type ESClass } from "#eslint-plugin-functional/utils/node-types";
 import {
-  createRule,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
 } from "#eslint-plugin-functional/utils/rule";
 
 /**

src/rules/no-conditional-statements.ts

@@ -6,10 +6,10 @@ import { type Type } from "typescript";
 import tsApiUtils from "#eslint-plugin-functional/conditional-imports/ts-api-utils";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import {
-  createRule,
-  getTypeOfNode,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
+  getTypeOfNode,
 } from "#eslint-plugin-functional/utils/rule";
 import {
   isBlockStatement,

src/rules/no-expression-statements.ts

@@ -9,19 +9,19 @@ import { deepmerge } from "deepmerge-ts";
 import tsApiUtils from "#eslint-plugin-functional/conditional-imports/ts-api-utils";
 import typescript from "#eslint-plugin-functional/conditional-imports/typescript";
 import {
+  type IgnoreCodePatternOption,
   ignoreCodePatternOptionSchema,
   shouldIgnorePattern,
-  type IgnoreCodePatternOption,
 } from "#eslint-plugin-functional/options";
 import {
   isDirectivePrologue,
   ruleNameScope,
 } from "#eslint-plugin-functional/utils/misc";
 import {
-  createRule,
-  getTypeOfNode,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
+  getTypeOfNode,
 } from "#eslint-plugin-functional/utils/rule";
 import {
   isCallExpression,

src/rules/no-let.ts

@@ -7,16 +7,16 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { deepmerge } from "deepmerge-ts";
 
 import {
+  type IgnoreIdentifierPatternOption,
   ignoreIdentifierPatternOptionSchema,
   shouldIgnoreInFunction,
   shouldIgnorePattern,
-  type IgnoreIdentifierPatternOption,
 } from "#eslint-plugin-functional/options";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import {
-  createRule,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
 } from "#eslint-plugin-functional/utils/rule";
 import { isInForLoopInitializer } from "#eslint-plugin-functional/utils/tree";
 

src/rules/no-loop-statements.ts

@@ -4,9 +4,9 @@ import { type RuleContext } from "@typescript-eslint/utils/ts-eslint";
 import { ruleNameScope } from "#eslint-plugin-functional/utils/misc";
 import { type ESLoop } from "#eslint-plugin-functional/utils/node-types";
 import {
-  createRule,
   type NamedCreateRuleCustomMeta,
   type RuleResult,
+  createRule,
 } from "#eslint-plugin-functional/utils/rule";
 
 /**