# eslint-config-clutter

> Clutter's ESLint/Prettier config for Typescript projects

Latest version **1.0.0-beta.3** (published 2021-01-20) · UNLICENSED license · 0 weekly downloads

## Install

```sh
npm install eslint-config-clutter
pnpm add eslint-config-clutter
yarn add eslint-config-clutter
bun add eslint-config-clutter
```

## 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.0.0-beta.3 |
| Published | 2021-01-20 |
| First published | 2020-12-11 |
| Weekly downloads | 0 |
| License | UNLICENSED |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 7.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Clutter |
| Maintainers | cluttertech |

## Links

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

## Dependencies (10)

- [prettier](https://npm.io/package/prettier.md) ^2.2.1
- [eslint-plugin-jest](https://npm.io/package/eslint-plugin-jest.md) ^24.1.3
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^7.21.5
- [eslint-plugin-import](https://npm.io/package/eslint-plugin-import.md) ^2.22.1
- [eslint-config-prettier](https://npm.io/package/eslint-config-prettier.md) ^7.0.0
- [@rushstack/eslint-patch](https://npm.io/package/@rushstack/eslint-patch.md) ^1.0.6
- [@typescript-eslint/parser](https://npm.io/package/@typescript-eslint/parser.md) ^4.9.1
- [eslint-config-airbnb-base](https://npm.io/package/eslint-config-airbnb-base.md) ^14.2.1
- [eslint-plugin-react-hooks](https://npm.io/package/eslint-plugin-react-hooks.md) ^4.2.0
- [@typescript-eslint/eslint-plugin](https://npm.io/package/@typescript-eslint/eslint-plugin.md) ^4.9.1

## Recent versions

- 1.0.0-beta.3 (latest) — 2021-01-20
- 1.0.0-beta.2 — 2021-01-19
- 1.0.0-beta.1 — 2020-12-11

## README

# eslint-config-clutter
[![npm version](https://badge.fury.io/js/eslint-config-clutter.svg)](https://badge.fury.io/js/eslint-config-clutter)

This package uses ESLint to enforce Clutter's code style and provides a configuration for our React Typescript projects. We use this package in conjunction with [Prettier](https://prettier.io) for linting our projects.

## Install
```sh
yarn add --dev eslint-config-clutter eslint
```
This ESLint configuration uses [`@rushstack/eslint-patch`](https://github.com/microsoft/rushstack/tree/master/stack/eslint-patch) which allows our configuration to bring along its own plugins rather than imposing peer dependencies on every consumer of the config. See [the README](https://github.com/microsoft/rushstack/tree/master/stack/eslint-patch) for more information.

## Usage
1. Add `"extends": "clutter"` to your ESLint configuration file.
2. Enable the Prettier configuration by updating the project's `package.json` with the following:
```json
{
  "prettier": "eslint-config-clutter/prettier-config"
}
```

## Resources
- [ESLint docs](https://eslint.org/)
- [Prettier docs](https://prettier.io/)
- [`eslint-config-airbnb-base`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base)
- [`@typescript-eslint`](https://github.com/typescript-eslint/typescript-eslint)
- [`eslint-plugin-import`](https://github.com/benmosher/eslint-plugin-import)
- [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react)
- [`eslint-config-airbnb-base`](https://github.com/prettier/eslint-config-prettier)

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