# @gathermade/eslint-config

> GatherMade's shared ESLint configurations.

Latest version **2.2.2** (published 2022-09-21) · ISC license · 0 weekly downloads

## Install

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

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.2 |
| Published | 2022-09-21 |
| First published | 2022-06-13 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 20.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | GatherMade |
| Maintainers | amit-gm, ndhoule |

## Links

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

## Dependencies (15)

- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ~27.0.4
- [eslint-plugin-node](https://npm.io/package/eslint-plugin-node.md) ~11.1.0
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ~7.31.8
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ~2.26.0
- [eslint-plugin-unicorn](https://npm.io/package/eslint-plugin-unicorn.md) ~43.0.2
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ~8.5.0
- [eslint-config-problems](https://npm.io/package/eslint-config-problems.md) ~6.0.0
- [eslint-plugin-jsx-a11y](https://npm.io/package/eslint-plugin-jsx-a11y.md) ~6.6.1
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ~4.2.1
- [@next/eslint-plugin-next](https://npm.io/package/@next/eslint-plugin-next.md) ~12.3.1
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ~5.38.0
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ~4.6.0
- [eslint-plugin-eslint-comments](https://npm.io/package/eslint-plugin-eslint-comments.md) ~3.2.0
- [eslint-plugin-jest-formatting](https://npm.io/package/eslint-plugin-jest-formatting.md) ~3.1.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ~5.38.0

## Recent versions

- 2.2.2 (latest) — 2022-09-21
- 2.2.1 — 2022-09-21
- 2.2.0 — 2022-09-21
- 2.1.1 — 2022-09-02
- 2.1.0 — 2022-09-02
- 2.0.0 — 2022-08-25
- 1.0.0 — 2022-07-29
- 1.0.0-beta.1 — 2022-06-13

## README

# `@gathermade/eslint-config`

GatherMade's shared ESLint configurations.

## Installation

Install via your package manager of choice:

```sh
npm install -D @gathermade/eslint-config
yarn add -D @gathermade/eslint-config
```

You'll also need to install `eslint` and `prettier`, which are peer dependencies.

You will also need to install `typescript` if you're using those configurations; these are also represented as peer dependencies.

## Configurations

- `@gathermade/eslint-config/recommended`: A base configuration. You probably want this rule set enabled at the root of your configuration.
- `@gathermade/eslint-config/recommended-typescript`: A base configuration for TypeScript files.
- `@gathermade/eslint-config/jest`: A configuration for Jest tests.
- `@gathermade/eslint-config/node/commonjs/typescript`: A configuration for TypeScript files run via a CommonJS Node runtime.
- `@gathermade/eslint-config/node/commonjs`: A configuration for files run via a CommonJS Node runtime.

## Usage

The most effective way to use this configuration is in conjunction with overrides. For example:

```js
// .eslintrc.js
module.exports = {
  root: true,
  extends: ["@gathermade/eslint-config/recommended"],
  overrides: [
    // TypeScript files
    {
      files: ["src/**/*.ts"],
      parserOptions: {
        tsconfigRootDir: __dirname,
        project: "./tsconfig.json",
      },
      extends: ["@gathermade/eslint-config/recommended-typescript"],
    },
    // Tests
    {
      files: ["src/**/*.test.{j,t}s"],
      extends: ["@gathermade/eslint-config/jest"],
    },
  ],
};
```

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