https://github.com/sylv/eslint-config

A shareable config for ESLint that I use across projects.
https://github.com/sylv/eslint-config

config eslint linting style-guide styleguide

Last synced: 2 days ago
JSON representation

A shareable config for ESLint that I use across projects.

• Host: GitHub
• URL: https://github.com/sylv/eslint-config
• Owner: sylv
• License: mit
• Created: 2021-08-25T04:37:05.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2021-08-26T08:29:27.000Z (over 3 years ago)
• Last Synced: 2024-11-20T19:17:03.866Z (about 2 months ago)
• Topics: config, eslint, linting, style-guide, styleguide
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config

> A [shareable config](https://eslint.org/docs/developer-guide/shareable-configs) for [ESLint](https://eslint.org/). 

I never liked existing configs, they always have rules that I find unnecessary causing each project to end up with a dozen rules being disabled because they end up getting in the way. This config aims to fix that, for me anyway. I'm sure other people will find issues with what I've chosen, but eventually this config will be the default for all my projects without each project having a a separate config with a dozen plugins and a dozen more rules disabled.

TypeScript and React support is included. React-specific rules are only enabled for files ending with `jsx` or `tsx` because I'm concerned about performance and realistically the only thing without those extensions *might* be hooks.

# usage

- `pnpm add --save-dev eslint eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-unicorn @typescript-eslint/eslint-plugin`

- Create a `.eslintrc` file with the content below

```jsonc

{

    "extends": "@ryanke",

    "parserOptions": {

        "project": "./tsconfig.json"

    }

}

```

I intend on some rules being disabled depending on the project. In particular, `@typescript-eslint/explicit-function-return-type` will cause issues for some projects. For libraries I'd keep this on, but otherwise you will probably want to turn it off once it gets annoying.

# assumptions

- React projects will always be TypeScript.

# todo

- [ ] Benchmark linter performance and remove unnecessary or expensive rules

- [ ] `NextJS` preset that disables some more annoying rules. `sylv/micro` is a good example of rules that are annoying with NextJS.