@madebywild/eslint-config-typescript/README.mdx

wild's ESLint TS project config

---
name: Eslint Typescript Config
menu: Code Linting
route: /code-linting/eslint-config-typescript
---

import index from '!!raw-loader!.'
import { Code } from 'gatsby-theme-docz/src/components/Code'

# Eslint Typescript Config

WILD Eslint configuration for Typescript based projects - .ts.

## Installation

To use it in your project, you need to install the peerDependencies of this package.
We recommend to use [install-peerdeps](https://www.npmjs.com/package/install-peerdeps)

### If you're using npm >=7
peerDependencies should be installed by default

### If you're using npm >=5
```bash
npx install-peerdeps @madebywild/eslint-config-typescript --dev
```

### If you're using npm <5
```bash
npm install -g install-peerdeps && install-peerdeps @madebywild/eslint-config-typescript --dev
```

Then add this to a `.eslintrc` file:

```json
{
  "extends": "@madebywild/eslint-config-typescript"
}
```

## Rules

<Code className="javascript">
  {index}
</Code>