@open-xchange/linter-presets 1.3.0 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## `1.4.0` – 2025-Jun-19
+
+- added: (ESLint) new option "additionalHooks" for `env.react`
+
 ## `1.3.0` – 2025-Jun-19
 
 - chore: bump dependencies

package/dist/eslint/config/vue.js

@@ -38,7 +38,7 @@ export default function vue(languageConfig, stylisticConfig) {
         ...recommendedConfigs,
         // raise all recommended rules to "error" level
         ...recommendedConfigs.map(config => ({
-            rules: convertRuleWarningsToErrors(config.rules ?? {}),
+            rules: convertRuleWarningsToErrors(config.rules),
         })),
         // reconfigure plugin rules
         {

package/dist/eslint/env/react.d.ts

@@ -6,6 +6,30 @@ import type { EnvBaseOptions } from "../shared/env-utils.js";
 export interface EnvReactOptions extends EnvBaseOptions {
     /**
      * Configuration for the rule "react-hooks-static-deps/exhaustive-deps".
+     *
+     * Additional hooks that will be checked for dependencies, as a dictionary
+     * mapping hook names to the parameter index of the callback function to be
+     * analyzed.
+     *
+     * @example
+     *  additionalHooks: {
+     *    useCustomHook: 0,   // usage: `useCustomHook(callback, [deps])`
+     *    useOtherHook: 1,    // usage: `useOtherHook(value, callback, [deps])`
+     *  }
+     */
+    additionalHooks?: Record<string, number>;
+    /**
+     * Configuration for the rule "react-hooks-static-deps/exhaustive-deps".
+     *
+     * Additional hooks that return stable values, as a dictionary mapping hook
+     * names to the declaration of the stable values the hook will return.
+     *
+     * @example
+     *  staticHooks: {
+     *    useCustomHook: true,              // entire return value is stable
+     *    useOtherHook: [false, true],      // second array element is stable
+     *    useThirdHook: { callback: true }, // property "callback" is stable
+     *  }
      */
     staticHooks?: Record<string, boolean | boolean[] | Record<string, boolean>>;
 }

package/dist/eslint/env/react.js

@@ -66,17 +66,20 @@ export default function react(envOptions) {
         plugins: {
             "react-hooks": reactHooksPlugin,
         },
-        // recommended rules
-        rules: reactHooksPlugin.configs.recommended.rules,
+        // recommended rules (raise all recommended rules to "error" level)
+        rules: convertRuleWarningsToErrors(reactHooksPlugin.configs.recommended.rules),
     }), 
     // "react-hooks-static-deps" plugin
-    envOptions.staticHooks && createConfig(envOptions, {
+    (envOptions.additionalHooks ?? envOptions.staticHooks) && createConfig(envOptions, {
         plugins: {
             "react-hooks-static-deps": fixupPluginRules(reactHooksStaticDepsPlugin), // https://github.com/stoikio/eslint-plugin-react-hooks-static-deps/issues/1
         },
         rules: {
             "react-hooks/exhaustive-deps": "off",
-            "react-hooks-static-deps/exhaustive-deps": ["error", { staticHooks: envOptions.staticHooks }],
+            "react-hooks-static-deps/exhaustive-deps": ["error", {
+                    additionalHooks: envOptions.additionalHooks,
+                    staticHooks: envOptions.staticHooks,
+                }],
         },
     }), 
     // "react-refresh" plugin

package/dist/eslint/shared/env-utils.d.ts

@@ -273,7 +273,7 @@ export declare function fixMissingFilesOption(configs: Linter.Config[]): Linter.
  * @returns
  *  The converted rules record.
  */
-export declare function convertRuleWarningsToErrors(rules: Partial<Linter.RulesRecord>): Partial<Linter.RulesRecord>;
+export declare function convertRuleWarningsToErrors(rules: Partial<Linter.RulesRecord> | undefined): Partial<Linter.RulesRecord>;
 /**
  * Translates the stylistic option `dangle` to the configuration options for
  * "comma-dangle" rules.

package/dist/eslint/shared/env-utils.js

@@ -163,7 +163,7 @@ export function fixMissingFilesOption(configs) {
  *  The converted rules record.
  */
 export function convertRuleWarningsToErrors(rules) {
-    return Object.fromEntries(Object.entries(rules).map(([key, value]) => {
+    return rules ? Object.fromEntries(Object.entries(rules).map(([key, value]) => {
         if (value === "warn") {
             value = "error";
         }
@@ -171,7 +171,7 @@ export function convertRuleWarningsToErrors(rules) {
             value = ["error", ...value.slice(1)];
         }
         return [key, value];
-    }));
+    })) : {};
 }
 /**
  * Translates the stylistic option `dangle` to the configuration options for

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",