# @auditorium-ai/eslint-config

> Auditorium's shared ESLint config

Latest version **0.0.19** (published 2025-01-20) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install @auditorium-ai/eslint-config
pnpm add @auditorium-ai/eslint-config
yarn add @auditorium-ai/eslint-config
bun add @auditorium-ai/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.0.19 |
| Published | 2025-01-20 |
| First published | 2024-04-25 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 19 |
| Unpacked size | 10.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Auditorium |
| Maintainers | auditorium |

## Links

- npm: https://www.npmjs.com/package/@auditorium-ai/eslint-config
- Repository: https://github.com/auditorium-ai/standards
- Homepage: https://github.com/auditorium-ai/standards/eslint-config
- Issues: https://github.com/auditorium-ai/standards/issues
- npm.io page: https://npm.io/package/@auditorium-ai/eslint-config

## Dependencies (19)

- [eslint-scope](https://npm.io/package/eslint-scope.md) ^8.0.1
- [eslint-config-next](https://npm.io/package/eslint-config-next.md) 14.2.5
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^28.2.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.34.1
- [eslint-plugin-tsdoc](https://npm.io/package/eslint-plugin-tsdoc.md) ^0.2.17
- [eslint-config-airbnb](https://npm.io/package/eslint-config-airbnb.md) ^19.0.4
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.29.1
- [eslint-plugin-unicorn](https://npm.io/package/eslint-plugin-unicorn.md) ^52.0.0
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^9.1.0
- [eslint-plugin-jest-dom](https://npm.io/package/eslint-plugin-jest-dom.md) ^5.4.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ^6.8.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^7.7.1
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^15.0.0
- [eslint-import-resolver-ts](https://npm.io/package/eslint-import-resolver-ts.md) ^0.4.2
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.6.0
- [eslint-plugin-prefer-arrow](https://npm.io/package/eslint-plugin-prefer-arrow.md) ^1.2.3
- [eslint-plugin-next-on-pages](https://npm.io/package/eslint-plugin-next-on-pages.md) ^1.13.2
- [eslint-plugin-testing-library](https://npm.io/package/eslint-plugin-testing-library.md) ^6.2.2
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^7.7.1

## Recent versions

- 0.0.19 (latest) — 2025-01-20
- 0.0.20-pre-2 (beta) — 2025-01-21
- 0.0.20-pre-1 — 2025-01-21
- 0.0.18 — 2024-12-11
- 0.0.17 — 2024-10-01
- 0.0.17-pre-1 — 2024-10-01
- 0.0.16 — 2024-06-05
- 0.0.15 — 2024-05-10
- 0.0.14 — 2024-05-10
- 0.0.13 — 2024-05-10
- 0.0.12 — 2024-04-29
- 0.0.11 — 2024-04-25
- 0.0.10 — 2024-04-25
- 0.0.9 — 2024-04-25
- 0.0.8 — 2024-04-25
- … 7 more at https://npm.io/package/@auditorium-ai/eslint-config/versions

## README

# @auditorium-ai/eslint-config

This package contains a root [ESLint](https://eslint.org/) config, with automatic support for [TypeScript](https://www.typescriptlang.org/) and [React](https://reactjs.org/).

## Methodology

### Style rules

As linting configs are often heavily debated, this config uses Prettier for most code-style choices.

The base config is [`eslint-config-airbnb`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb).

### TypeScript support

When working with TypeScript, the recommended rules from [`@typescript-eslint/eslint-plugin`](https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin#usage) are applied.

You should also ensure that your IDE is set up to run ESLint on TypeScript files. In VSCode, this setting is:

```json
  "eslint.validate": [
      "javascript",
      "javascriptreact",
      "typescript",
      "typescriptreact"
  ],
```

## Installation

To manually install, add this package to the `"extends"` array in your project’s [ESLint config](https://eslint.org/docs/user-guide/configuring).

```json
{
  "extends": ["@auditorium-ai/eslint-config"]
}
```

The following base configs are available:

- `@auditorium-ai/eslint-config` (JS/TS-only)
- `@auditorium-ai/eslint-config/react` (JS/TS and React)

Optional configs are also available, and can be added alongside either of the base configs:

- `@auditorium-ai/eslint-config/jest`
- `@auditorium-ai/eslint-config/next`

## Support for monorepos

This config has automatic configuration for monorepos.

This requires a single root ESLint config.

If you're working with TypeScript, each package that uses TypeScript must have a `tsconfig.json`.

## Usage in JavaScript projects

If you aren't using TypeScript, you may need to add the `browser` environment to your ESLint config.

```js
module.exports = {
  extends: [
    "@auditorium-ai/eslint-config/react",
    "@auditorium-ai/eslint-config/jest",
  ],
  env: {
    browser: true,
  },
};
```

Additionally, you will need to install TypeScript as a dependency of your project.

## Customising rules

You can easily add, modify, or disable rules with this config.

```js
module.exports = {
  extends: ["@auditorium-ai/eslint-config"],
  rules: {
    "some-rule": 2,
    "some-other-rule": 1,
  },
};
```

### Targeting TypeScript or JavaScript

If you want your rule change to only affect a certain filetype, use `overrides`.

```js
module.exports = {
  extends: ["@auditorium-ai/eslint-config/react"],
  overrides: [
    {
      files: ["*.ts", "*.tsx"],
      rules: {
        "some-rule": 0,
      },
    },
    {
      files: ["*.js"],
      rules: {
        "some-rule": 2,
      },
    },
  ],
};
```

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