# @uniswap/eslint-config

> Uniswap ESLint config

Latest version **1.2.0** (published 2023-05-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install @uniswap/eslint-config
pnpm add @uniswap/eslint-config
yarn add @uniswap/eslint-config
bun add @uniswap/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 | 1.2.0 |
| Published | 2023-05-09 |
| First published | 2022-12-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 14 |
| Unpacked size | 7.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | dannydaniil, andysmithuni, cmcewen, eddiedugan, tinaszheng, rileydcampbell, mtoda, azflin, alicehenshaw, matteen, zzmp, justindomingue, sarareynolds, noahwz, ianlapham, callil, towering-elsie, emag3m, willpote |
| Keywords | config, eslint, eslintconfig, uniswap |

## Links

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

## Dependencies (14)

- [prettier](https://npm.io/package/prettier.md) ^2.8.0
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^27.1.6
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.31.11
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.26.0
- [eslint-plugin-cypress](https://npm.io/package/eslint-plugin-cypress.md) ^2.12.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^8.5.0
- [eslint-plugin-prettier](https://npm.io/package/eslint-plugin-prettier.md) ^4.2.1
- [@rushstack/eslint-patch](https://npm.io/package/@rushstack/eslint-patch.md) ^1.2.0
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^5.45.1
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.6.0
- [eslint-plugin-unused-imports](https://npm.io/package/eslint-plugin-unused-imports.md) ^2.0.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^5.45.1
- [eslint-plugin-simple-import-sort](https://npm.io/package/eslint-plugin-simple-import-sort.md) ^8.0.0
- [eslint-import-resolver-typescript](https://npm.io/package/eslint-import-resolver-typescript.md) ^3.5.2

## 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

- 1.2.0 (latest) — 2023-05-09
- 1.1.1 — 2022-12-20
- 1.1.0 — 2022-12-19
- 1.0.0 — 2022-12-15

## README

# @uniswap/eslint-config

Uniswap ESLint config to enforce coding standards and best practices.

- TypeScript and Jest support
- Seamless Prettier integration
- Separate environments for Node.js and React

## Installation

```bash
yarn add --dev eslint @uniswap/eslint-config
```

## Usage

> Make sure to include `require('@uniswap/eslint-config/load')` at the top of your ESLint config. This loads a `@rushstack/eslint-patch/modern-module-resolution` patch so that ESLint loads any plugins installed by this package. 

```js
require('@uniswap/eslint-config/load')

module.exports = {
  extends: '@uniswap/eslint-config/node'
}
```

or:

```js
require('@uniswap/eslint-config/load')

module.exports = {
  extends: '@uniswap/eslint-config/react'
}
```

#### VSCode

If you're a VSCode user, consider installing the official [ESLint plugin](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint) and copying [`./.vscode/settings.json`](.vscode/settings.json#L1-L6) to your own `.vscode/settings.json` configuration file. This will automatically run `eslint --fix` on save.

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