README.md

Kontent.ai eslint configuration

This is the eslint configuration that Kontent.ai uses for its TypeScript packages.

Getting Started

1. Install the package the eslint configuration.

   # optionaly install eslint if you don't already have it
   # npm i --save-dev eslint
   npm i --save-dev @kontent-ai/eslint-config

2. Extend your eslint configuration

   // showcase of .eslintrc.json
   {
       // ...
       "extends": [
           // ...
           "@kontent-ai",
           "@kontent-ai/eslint-config/react"
       ]
   }

3. Run the lint process based on your project configuration

Available configurations are:

• @kontent-ai (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

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