kibana/packages/kbn-eslint-config
Kibana Machine 962e2e1f46
[8.4] [eslint] fix and skip violations for cross-boundary imports (#136911) (#137624)
* [eslint] fix and skip violations for cross-boundary imports (#136911)

(cherry picked from commit bebec37f04)

* skip violations unique to 8.4

Co-authored-by: Spencer <spencer@elastic.co>
2022-07-29 14:24:56 -07:00
..
.eslintrc.js [8.4] [eslint] fix and skip violations for cross-boundary imports (#136911) (#137624) 2022-07-29 14:24:56 -07:00
.gitignore chore(NA): rename @elastic/eslint-config-kibana as @kbn/eslint-config (#132278) 2022-05-16 13:02:02 -07:00
BUILD.bazel chore(NA): eslint rule for disallowing naked eslint-disable (#136408) 2022-07-19 17:11:04 +01:00
javascript.js [kbn/pm] rewrite to avoid needing a build process (#136207) 2022-07-18 08:46:13 -07:00
jest.js chore(NA): rename @elastic/eslint-config-kibana as @kbn/eslint-config (#132278) 2022-05-16 13:02:02 -07:00
package.json chore(NA): rename @elastic/eslint-config-kibana as @kbn/eslint-config (#132278) 2022-05-16 13:02:02 -07:00
react.js chore(NA): rename @elastic/eslint-config-kibana as @kbn/eslint-config (#132278) 2022-05-16 13:02:02 -07:00
README.mdx Initialize ops documentation section (#132262) 2022-05-17 15:22:38 -05:00
restricted_globals.js chore(NA): rename @elastic/eslint-config-kibana as @kbn/eslint-config (#132278) 2022-05-16 13:02:02 -07:00
typescript.js Bump prettier to 2.7.1 (#135143) 2022-07-05 14:39:20 -05:00

---
id: kibDevDocsOpsEslintConfig
slug: /kibana-dev-docs/ops/eslint-config
title: "@kbn/eslint-config"
description: A package holding the main eslint configs on Kibana
date: 2022-05-16
tags: ['kibana', 'dev', 'contributor', 'operations', 'eslint', 'custom', 'config']
---

This package is used to group and provide the eslint configurations used by the Kibana team.
It defines default plugins, env, parserOptions and rules for javascript, typescript, and react code bases. 
Optionally it can also be used with jest as explained below.

## Usage

To use this eslint config, it needs to be referenced in the `.eslintrc` file:

```javascript
module.exports = {
  extends: [
    '@kbn/eslint-config'
  ]
}
```

## Optional jest eslint config

If [jest test runner](https://facebook.github.io/jest/) is used, 
the `@kbn/eslint-config/jest` config can be extended as well to use 
`eslint-plugin-jest` and add settings specific to it:

```javascript
module.exports = {
  extends: [
    '@kbn/eslint-config',
    '@kbn/eslint-config/jest'
  ]
}
```