@open-xchange/linter-presets 0.10.3 → 0.11.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## `0.11.0` – 2024-Nov-19
+
+- change: (ESLint) switch from `eslint-plugin-react` to `@eslint-react/eslint-plugin`
+- change: (ESLint) remove `eslint-plugin-jsx-expressions` plugin
+
+## `0.10.4` – 2024-Nov-18
+
+- fix: (ESLint) correctly configure `vue/html-indent` rule
+
 ## `0.10.3` – 2024-Nov-18
 
 - chore: (ESLint) bump dependencies to fix ESLint v9.15 API errors

package/dist/eslint/config/vue.d.ts

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import { type LanguageConfig } from "../shared/env-utils.js";
+import type { LanguageConfig, StylisticConfig } from "../shared/env-utils.js";
 /**
  * Creates configuration objects with linter rules for Vue.js.
  *
@@ -9,7 +9,10 @@ import { type LanguageConfig } from "../shared/env-utils.js";
  * @param languageConfig
  *  Resolved language configuration options.
  *
+ * @param stylisticConfig
+ *  Resolved stylistic configuration options.
+ *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function vue(languageConfig: LanguageConfig): Linter.Config[];
+export default function vue(languageConfig: LanguageConfig, stylisticConfig: StylisticConfig): Linter.Config[];

package/dist/eslint/config/vue.js

@@ -12,10 +12,13 @@ import { fixMissingFilesOption } from "../shared/env-utils.js";
  * @param languageConfig
  *  Resolved language configuration options.
  *
+ * @param stylisticConfig
+ *  Resolved stylistic configuration options.
+ *
  * @returns
  *  An array of configuration objects to be added to the flat configuration.
  */
-export default function vue(languageConfig) {
+export default function vue(languageConfig, stylisticConfig) {
     // add missing "files" property in configurations with rules (otherwise, plugin conflicts with "@eslint/markdown")
     return fixMissingFilesOption([
         // use TypeScript parser for Vue files
@@ -34,8 +37,9 @@ export default function vue(languageConfig) {
         // reconfigure plugin rules
         {
             rules: {
-                "vue/singleline-html-element-content-newline": "off",
+                "vue/html-indent": ["error", stylisticConfig.indent.vue],
                 "vue/max-attributes-per-line": "off",
+                "vue/singleline-html-element-content-newline": "off",
             },
         },
     ]);

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

@@ -1,5 +1,5 @@
 import type { Linter } from "eslint";
-import { type EnvBaseOptions } from "../shared/env-utils.js";
+import type { EnvBaseOptions } from "../shared/env-utils.js";
 /**
  * Configuration options for the environment preset "env.react".
  */
@@ -13,11 +13,10 @@ export interface EnvReactOptions extends EnvBaseOptions {
  * Creates configuration objects with linter rules for ReactJS.
  *
  * Wraps the following packages:
- * - `eslint-plugin-react`
+ * - `@eslint-react/eslint-plugin`
  * - `eslint-plugin-react-hooks`
  * - `eslint-plugin-react-hooks-static-deps`
  * - `eslint-plugin-react-refresh`
- * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
  * @param envOptions

package/dist/eslint/env/react.js

@@ -1,22 +1,20 @@
-import reactPlugin from "eslint-plugin-react";
+import reactPlugin from "@eslint-react/eslint-plugin";
 import reactHooksPlugin from "eslint-plugin-react-hooks";
 import reactHooksStaticDepsPlugin from "eslint-plugin-react-hooks-static-deps";
 import reactRefreshPlugin from "eslint-plugin-react-refresh";
-import jsxExpressionsPlugin from "eslint-plugin-jsx-expressions";
 import jsxA11yPlugin from "eslint-plugin-jsx-a11y";
 import { fixupPluginRules } from "@eslint/compat";
-import { JS_GLOB } from "../shared/env-utils.js";
-import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js";
+import { parser } from "typescript-eslint";
+import { concatConfigs, createConfig, customRules, convertRuleWarningsToErrors } from "../shared/env-utils.js";
 // functions ==================================================================
 /**
  * Creates configuration objects with linter rules for ReactJS.
  *
  * Wraps the following packages:
- * - `eslint-plugin-react`
+ * - `@eslint-react/eslint-plugin`
  * - `eslint-plugin-react-hooks`
  * - `eslint-plugin-react-hooks-static-deps`
  * - `eslint-plugin-react-refresh`
- * - `eslint-plugin-jsx-expressions`
  * - `eslint-plugin-jsx-a11y`
  *
  * @param envOptions
@@ -26,35 +24,36 @@ import { concatConfigs, createConfig, customRules } from "../shared/env-utils.js
  *  An array of configuration objects to be added to the flat configuration.
  */
 export default function react(envOptions) {
+    // recommended configuration of the main plugin
+    const recommendedConfig = reactPlugin.configs["recommended-type-checked"];
     return concatConfigs(
     // configure "react" plugin for all source files (JSX and TSX)
     createConfig(envOptions, {
         // auto-detect installed React version
-        settings: {
-            react: {
-                version: "detect",
-            },
+        languageOptions: {
+            parser: parser,
+            parserOptions: { projectService: true },
         },
         // register rule implementations and language settings
-        // TODO: remove type cast after fix: https://github.com/jsx-eslint/eslint-plugin-react/issues/3838
-        ...reactPlugin.configs.flat.recommended,
+        ...recommendedConfig,
         rules: {
-            // recommended rules
-            ...(reactPlugin.configs.flat.recommended.rules),
-            ...(reactPlugin.configs.flat["jsx-runtime"].rules),
+            // recommended rules (move all to error level)
+            ...convertRuleWarningsToErrors(recommendedConfig.rules),
             // custom overrides
-            "react/hook-use-state": "error",
-            "react/iframe-missing-sandbox": "error",
-            "react/jsx-boolean-value": "error",
-            "react/jsx-no-script-url": "error",
-            "react/jsx-no-useless-fragment": "error",
-            "react/jsx-props-no-spread-multi": "error",
-            "react/no-danger": "error",
-            "react/no-invalid-html-attribute": "error",
-            "react/no-typos": "error",
-            "react/prop-types": ["error", { skipUndeclared: true }],
-            "react/style-prop-object": "error",
-            "react/void-dom-elements-no-children": "error",
+            "@eslint-react/jsx-no-duplicate-props": "error",
+            "@eslint-react/jsx-uses-vars": "error",
+            "@eslint-react/no-children-prop": "error",
+            "@eslint-react/no-class-component": "error",
+            "@eslint-react/no-implicit-key": "error",
+            "@eslint-react/no-missing-component-display-name": "error",
+            "@eslint-react/no-useless-fragment": "error",
+            "@eslint-react/prefer-shorthand-boolean": "error",
+            "@eslint-react/prefer-shorthand-fragment": "error",
+            "@eslint-react/dom/no-unknown-property": "error",
+            "@eslint-react/hooks-extra/no-unnecessary-use-callback": "error",
+            "@eslint-react/hooks-extra/no-unnecessary-use-memo": "error",
+            "@eslint-react/naming-convention/filename-extension": ["error", { allow: "as-needed" }],
+            "@eslint-react/naming-convention/use-state": "error",
         },
     }), 
     // "react-hooks" plugin
@@ -86,18 +85,6 @@ export default function react(envOptions) {
             "react-refresh/only-export-components": ["error", { allowConstantExport: true }],
         },
     }), 
-    // "jsx-expressions" plugin (TSX only)
-    createConfig(envOptions, {
-        ignores: JS_GLOB,
-        // register rule implementations of the plugins
-        plugins: {
-            "jsx-expressions": fixupPluginRules(jsxExpressionsPlugin), // https://github.com/hluisson/eslint-plugin-jsx-expressions/issues/18
-        },
-        rules: {
-            // replace "react/jsx-no-leaked-render" rule with advanced alternative
-            "jsx-expressions/strict-logical-expressions": "error",
-        },
-    }), 
     // "jsx-a11y" plugin
     createConfig(envOptions, jsxA11yPlugin.flatConfigs.recommended), 
     // custom rules

package/dist/eslint/index.js

@@ -86,7 +86,7 @@ export function configure(options) {
         // default configuration for TypeScript files
         ...ts(),
         // default configuration for Vue.js files
-        ...vue(languageConfig),
+        ...vue(languageConfig, stylisticConfig),
         // default configuration for JSON files
         ...json(stylisticConfig),
         // default configuration for YAML files

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

@@ -233,3 +233,13 @@ export declare function customRules(envOptions: EnvBaseOptions, rules?: Linter.R
  *  The fixed configuration options.
  */
 export declare function fixMissingFilesOption(configs: Linter.Config[]): Linter.Config[];
+/**
+ * Converts all warnings in the passed rule options to errors.
+ *
+ * @param rules
+ *  The rules record to be converted.
+ *
+ * @returns
+ *  The converted rules record.
+ */
+export declare function convertRuleWarningsToErrors(rules: Linter.RulesRecord): Linter.RulesRecord;

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

@@ -141,3 +141,23 @@ export function fixMissingFilesOption(configs) {
     const files = configs.find(config => config.files)?.files;
     return files ? configs.map(config => (!config.files && (config.languageOptions || config.rules)) ? { ...config, files } : config) : configs;
 }
+/**
+ * Converts all warnings in the passed rule options to errors.
+ *
+ * @param rules
+ *  The rules record to be converted.
+ *
+ * @returns
+ *  The converted rules record.
+ */
+export function convertRuleWarningsToErrors(rules) {
+    return Object.fromEntries(Object.entries(rules).map(([key, value]) => {
+        if (value === "warn") {
+            value = "error";
+        }
+        else if (Array.isArray(value) && (value[0] === "warn")) {
+            value = ["error", ...value.slice(1)];
+        }
+        return [key, value];
+    }));
+}

package/doc/eslint/env/react.md

@@ -2,11 +2,10 @@
 
 Creates configuration objects with linter rules for ReactJS. Adds the following plugins and their recommended rules:
 
-- [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react)
+- [@eslint-react/eslint-plugin](https://eslint-react.xyz/)
 - [eslint-plugin-react-hooks](https://github.com/facebook/react/tree/main/packages/eslint-plugin-react-hooks)
 - [eslint-plugin-react-hooks-static-deps](https://github.com/stoikio/eslint-plugin-react-hooks-static-deps)
 - [eslint-plugin-react-refresh](https://github.com/ArnaudBarre/eslint-plugin-react-refresh)
-- [eslint-plugin-jsx-expressions](https://github.com/hluisson/eslint-plugin-jsx-expressions)
 - [eslint-plugin-jsx-a11y](https://github.com/jsx-eslint/eslint-plugin-jsx-a11y)
 
 ## Signature

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-xchange/linter-presets",
-  "version": "0.10.3",
+  "version": "0.11.0",
   "description": "Configuration presets for ESLint and StyleLint",
   "repository": {
     "type": "git",
@@ -25,6 +25,7 @@
     "@babel/eslint-parser": "^7.25.9",
     "@babel/plugin-proposal-decorators": "^7.25.9",
     "@eslint-community/eslint-plugin-eslint-comments": "^4.4.1",
+    "@eslint-react/eslint-plugin": "^1.16.1",
     "@eslint/compat": "^1.2.3",
     "@eslint/js": "^9.15.0",
     "@eslint/markdown": "^6.2.1",
@@ -44,11 +45,9 @@
     "eslint-plugin-jsdoc": "^50.5.0",
     "eslint-plugin-jsonc": "^2.18.2",
     "eslint-plugin-jsx-a11y": "^6.10.2",
-    "eslint-plugin-jsx-expressions": "^1.3.2",
     "eslint-plugin-license-header": "^0.6.1",
     "eslint-plugin-n": "^17.13.2",
     "eslint-plugin-promise": "^7.1.0",
-    "eslint-plugin-react": "^7.37.2",
     "eslint-plugin-react-hooks": "^5.0.0",
     "eslint-plugin-react-hooks-static-deps": "^1.0.7",
     "eslint-plugin-react-refresh": "^0.4.14",