# @chax-at/eslint-config

> Base eslint configs

Latest version **0.1.1** (published 2025-02-18) · ISC license · 0 weekly downloads

## Install

```sh
npm install @chax-at/eslint-config
pnpm add @chax-at/eslint-config
yarn add @chax-at/eslint-config
bun add @chax-at/eslint-config
```

## Health

**Score 25/100 (F)** — status: maintenance-mode.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2025-02-18 |
| First published | 2020-10-29 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 24.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | jan-chax, chartinger, simonjimenez, valerionn |
| Keywords | eslintconfig, eslint |

## Links

- npm: https://www.npmjs.com/package/@chax-at/eslint-config
- Repository: https://github.com/chax-at/eslint-config
- Homepage: https://github.com/chax-at/eslint-config#readme
- Issues: https://github.com/chax-at/eslint-config/issues
- npm.io page: https://npm.io/package/@chax-at/eslint-config

## Dependencies (1)

- [eslint-plugin-max-params-no-constructor](https://npm.io/package/eslint-plugin-max-params-no-constructor.md) ^0.0.4

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@pandacss/eslint-plugin](https://npm.io/package/@pandacss/eslint-plugin.md) — 18.7K weekly downloads

## Recent versions

- 0.1.1 (latest) — 2025-02-18
- 0.1.0 — 2023-08-22
- 0.0.9 — 2022-01-13
- 0.0.8 — 2021-08-17
- 0.0.7 — 2021-01-20
- 0.0.6 — 2020-11-13
- 0.0.5 — 2020-11-13
- 0.0.4 — 2020-11-10
- 0.0.3 — 2020-11-06
- 0.0.2 — 2020-10-29
- 0.0.1 — 2020-10-29

## README

# chax-at/eslint-config

Base eslint config for typescript projects

## Installation

```
npm install @chax-at/eslint-config --save-dev
```

### Peer dependencies

default ts project:
```
npm install eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser --save-dev
```

react ts project:
```
npm install eslint @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint-plugin-react eslint-plugin-react-hooks --save-dev
```

## Usage

Add the config to the extends rule section of your `.eslintrc`

```json
{
  "extends": [
    "@chax-at/eslint-config"
  ]
}
```

## Example config

default ts project:
```json
{
  "env": {
    "browser": true,
    "es6": true,
    "mocha": true,
    "node": true
  },
  "extends": [
    "@chax-at/eslint-config"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true,
      "legacyDecorators": true,
      "modules": true
    },
    "ecmaVersion": 6,
    "project": "./tsconfig.json",
    "sourceType": "module",
    "tsconfigRootDir": "./"
  },
  "plugins": [
    "@typescript-eslint",
    "mocha"
  ]
}
```

react project:
```json
{
  "env": {
    "browser": true,
    "es6": true,
    "mocha": false
  },
  "extends": [
    "@chax-at/eslint-config/react"
  ],
  "parser": "@typescript-eslint/parser",
  "parserOptions": {
    "ecmaFeatures": {
      "jsx": true,
      "legacyDecorators": true,
      "modules": true
    },
    "ecmaVersion": 6,
    "project": "./tsconfig.json",
    "sourceType": "module",
    "tsconfigRootDir": "./"
  },
  "plugins": [
    "@typescript-eslint",
    "mocha",
    "react",
    "react-hooks"
  ],
  "settings": {
    "react": {
      "version": "detect"
    }
  },
  "overrides": [
    {
      "files": [
        "**/*.spec.ts",
        "**/*.spec.tsx"
      ],
      "env": {
        "mocha": true
      }
    }
  ]
}
```

## Developers

To test changes locally:

* run `npm link` in the cloned eslint-config project directory
* run `npm link @chax-at/eslint-config` in the project you want to test your config
* make sure you rerun the above command after an `npm install`
* run `npm unlink @chax-at/eslint-config` after you are done

---
_Source: https://npm.io/package/@chax-at/eslint-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._