https://github.com/kontent-ai/eslint-config
Eslint configuration for Kontent.ai repositories
https://github.com/kontent-ai/eslint-config
eslint kontent-ai
Last synced: 4 months ago
JSON representation
Eslint configuration for Kontent.ai repositories
- Host: GitHub
- URL: https://github.com/kontent-ai/eslint-config
- Owner: kontent-ai
- License: mit
- Created: 2023-02-20T08:54:54.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-04T08:39:47.000Z (over 1 year ago)
- Last Synced: 2025-02-04T09:31:35.688Z (over 1 year ago)
- Topics: eslint, kontent-ai
- Language: JavaScript
- Homepage: https://kontent.ai
- Size: 173 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![npm][npm-shield]](https://www.npmjs.com/package/@kontent-ai/eslint-config)
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Discord][discord-shield]][discord-url]
# 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.
```sh
# optionaly install eslint if you don't already have it
# npm i --save-dev eslint
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. 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`](./LICENSE.md) for more information.
[contributors-shield]: https://img.shields.io/github/contributors/kontent-ai/eslint-config.svg?style=for-the-badge
[contributors-url]: https://github.com/kontent-ai/eslint-config/graphs/contributors
[npm-shield]: https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white
[forks-shield]: https://img.shields.io/github/forks/kontent-ai/eslint-config.svg?style=for-the-badge
[forks-url]: https://github.com/kontent-ai/eslint-config/network/members
[stars-shield]: https://img.shields.io/github/stars/kontent-ai/eslint-config.svg?style=for-the-badge
[stars-url]: https://github.com/kontent-ai/eslint-config/stargazers
[issues-shield]: https://img.shields.io/github/issues/kontent-ai/eslint-config.svg?style=for-the-badge
[issues-url]:https://github.com/kontent-ai/eslint-config/issues
[license-shield]: https://img.shields.io/github/license/kontent-ai/eslint-config.svg?style=for-the-badge
[license-url]:https://github.com/kontent-ai/eslint-config/blob/master/LICENSE.md
[discord-shield]: https://img.shields.io/discord/821885171984891914?color=%237289DA&label=Kontent.ai%20Discord&logo=discord&style=for-the-badge
[discord-url]: https://discord.com/invite/SKCxwPtevJ