Kontent.ai eslint configuration

This is the eslint configuration that Kontent.ai uses for its TypeScript packages. This package uses the ESLint Flat Config format, supports ESLint ^9.22.0 || ^10.0.0, and requires Node.js ^20.19.0 || ^22.13.0 || >=24.0.0.

For React projects, JSX formatting and React-specific linting are covered by @kontent-ai/biome-config instead of this package.

Getting Started

1. Install the package the eslint configuration.

   pnpm add -D eslint @kontent-ai/eslint-config

   eslint, @typescript-eslint/eslint-plugin, and @typescript-eslint/parser are peer dependencies. Package managers with automatic peer installation (npm 7+, pnpm 8+) install them for you; otherwise add them explicitly.

2. Extend the configuration in your eslint.config.js file (Flat Config format is required)

   // eslint.config.js
   import kontentAiConfig from "@kontent-ai/eslint-config";
   import { defineConfig } from "eslint/config";
   
   export default defineConfig({
       extends: [ kontentAiConfig ],
   });

3. Run the lint process based on your project configuration

License

Distributed under the MIT License. See LICENSE.md for more information.