@kontent-ai/eslint-config 2.0.3 → 2.2.0

package/README.md

@@ -10,7 +10,7 @@
 
 # Kontent.ai eslint configuration
 
-This is the eslint configuration that Kontent.ai uses for its TypeScript packages.
+This is the eslint configuration that Kontent.ai uses for its TypeScript packages. This package uses ESLint 9+ Flat Config format.
 
 # Getting Started
 
@@ -22,26 +22,35 @@ This is the eslint configuration that Kontent.ai uses for its TypeScript package
     npm i --save-dev @kontent-ai/eslint-config
     ```
 
-1. [Extend](https://eslint.org/docs/latest/use/configure/configuration-files#extending-configuration-files) your eslint configuration
-
-    ```jsonc
-    // showcase of .eslintrc.json
-    {
-        // ...
-        "extends": [
-            // ...
-            "@kontent-ai",
-            "@kontent-ai/eslint-config/react"
-        ]
-    }
+1. Extend the configuration in your `eslint.config.js` file (Flat Config format for ESLint 9+ is required)
+
+    ```js
+    // eslint.config.js
+    import kontentAiConfig from "@kontent-ai/eslint-config";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig({
+        extends: [ kontentAiConfig ],
+    });
+    ```
+
+    For React projects, use the React-specific configuration:
+
+    ```js
+    // eslint.config.js
+    import kontentAiReactConfig from "@kontent-ai/eslint-config/react";
+    import { defineConfig } from "eslint/config";
+
+    export default defineConfig({
+        extends: [ kontentAiReactConfig ],
+    });
     ```
 
 1. Run the lint process based on your project configuration
 
 Available configurations are:
-* `@kontent-ai` (default configuration for any TypeScript file)
+* `@kontent-ai/eslint-config` (default configuration for any TypeScript file)
 * `@kontent-ai/eslint-config/react` (react specific, extends default)
-* `@kontent-ai/eslint-config/jest` (jest specific, extends default)
 
 # License
 

package/index.js

@@ -1,20 +1,26 @@
-module.exports = {
-  parser: "@typescript-eslint/parser",
-  parserOptions: {
-    project: "./tsconfig.json",
-    ecmaFeatures: {
-      jsx: true,
+import tsParser from "@typescript-eslint/parser";
+import tsPlugin from "@typescript-eslint/eslint-plugin";
+import { defineConfig } from "eslint/config";
+
+export default defineConfig([{
+  languageOptions: {
+    parser: tsParser,
+    parserOptions: {
+      project: "./tsconfig.json",
+      ecmaFeatures: {
+        jsx: true,
+      },
+      sourceType: "module",
     },
-    sourceType: "module",
+  },
+  plugins: {
+    "@typescript-eslint": tsPlugin,
   },
   settings: {
     react: {
       version: "detect",
     },
   },
-  plugins: [
-    "@typescript-eslint",
-  ],
   rules: {
     "no-duplicate-imports": "error",
     "no-promise-executor-return": "error",
@@ -52,6 +58,5 @@ module.exports = {
     "@typescript-eslint/require-array-sort-compare": "error",
     "@typescript-eslint/no-mixed-enums": "error",
     "@typescript-eslint/no-unsafe-enum-comparison": "error",
-    "@typescript-eslint/strict-boolean-expressions": "warn",
   },
-};
+}]);

package/package.json

@@ -1,17 +1,21 @@
 {
   "name": "@kontent-ai/eslint-config",
-  "version": "2.0.3",
+  "version": "2.2.0",
   "description": "Eslint configuration used for packages in Kontent.ai",
   "main": "index.js",
   "private": false,
   "type": "module",
+  "exports": {
+    ".": "./index.js",
+    "./react": "./react.js"
+  },
   "scripts": {},
   "author": "Jiri Lojda",
   "license": "MIT",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^8.1.0",
-    "@typescript-eslint/parser": "^8.1.0",
-    "eslint": "^9.9.0",
-    "eslint-plugin-react": "^7.35.0"
+    "@typescript-eslint/eslint-plugin": "^8.46.3",
+    "@typescript-eslint/parser": "^8.46.3",
+    "eslint": "^9.39.1",
+    "eslint-plugin-react": "^7.37.5"
   }
 }

package/react.js

@@ -1,12 +1,12 @@
-module.exports = {
-  plugins: [
-    "react",
-  ],
-
-  extends: [
-    "@kontent-ai",
-  ],
+import reactPlugin from "eslint-plugin-react";
+import baseConfig from "./index.js";
+import { defineConfig } from "eslint/config";
 
+export default defineConfig([{
+  extends: [baseConfig],
+  plugins: {
+    react: reactPlugin,
+  },
   rules: {
     "react/jsx-boolean-value": "error",
     "react/jsx-equals-spacing": "error",
@@ -50,4 +50,4 @@ module.exports = {
     "react/jsx-no-leaked-render": "error",
     "react/prefer-stateless-function": "error",
   },
-}
+}]);