eslint-config-ts-standard-next/README.md

Chempo's ESLint Config for NextJS with TypeScript projects with best practices

# eslint-config-ts-standard-next [![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

## 🔖 Description

Eslint config with standard-typescript (+other plugins) and extra opinionated configs applying best practices and focused on declarative code

# 📖 Summary

> Linting and best practices rules for:
>
> - JavaScript and JSX
> - TypeScript and TSX
> - TSDoc
> - React and react hooks
> - NextJS
> - Accessibility (JSX a11y)
> - Package.json convention
> - JSON files
> - YAML
> - Markdown

## 📦 Installation

```zsh
# Install the config in the dev dependencies
$ npm install -D eslint-config-ts-standard-next
```

## 🚀 Usage

Add to your `eslint config` file the config extending it like the example below:

```jsonc
{
  "extends": [ "ts-standard-next" ]
}
```

or add it directly in your `package.json`

```jsonc
// package.json
{
  "eslintConfig": {
    "extends": [ "ts-standard-next" ]
  }
}
```

---

## 🤓 Happy Code

> Created with Typescript! ⚡ and latin music 🎺🎵

### This README.md file has been written keeping in mind

- [GitHub Markdown](https://guides.github.com/features/mastering-markdown/)
- [Emoji Cheat Sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)