Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chungweileong94/eslint-config-whiteroom

White Room ESLint Configuration
https://github.com/chungweileong94/eslint-config-whiteroom

eslint javascript react typescript

Last synced: about 1 month ago
JSON representation

White Room ESLint Configuration

Awesome Lists containing this project

README

        

# eslint-config-whiteroom

White Room ESLint Configuration

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

## Installation

```bash
# npm
npm install -D eslint-config-whiteroom

# yarn
yarn add -D eslint-config-whiteroom

# pnpm
pnpm add -D eslint-config-whiteroom
```

### Install peer dependencies
```bash
npx install-peerdeps --dev eslint-config-whiteroom
```

## Configure ESLint

In your ESLint configuration file:

1. You need tell the parser where's your `tsconfig.json`

```diff
+ parserOptions: {
+ project: './tsconfig.json'
+ }
```

2. Extends `eslint-config-whiteroom`

```diff
extends: [
...
+ 'whiteroom',
]
```