https://github.com/nfour/eslint-config-nfour
https://github.com/nfour/eslint-config-nfour
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nfour/eslint-config-nfour
- Owner: nfour
- Created: 2021-03-09T01:35:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-05-09T01:39:21.000Z (about 2 years ago)
- Last Synced: 2024-10-11T23:11:36.843Z (almost 2 years ago)
- Language: JavaScript
- Size: 230 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# eslint-config-nfour
> Some opinionated style & type rules built on top of [eslint-config-standard-typescript-prettier](https://github.com/nfour/eslint-config-standard-typescript-prettier)
>
> See [./.eslintrc.js](./.eslintrc.js)
## Why
**Pros**:
- [x] You do not need to install ANY eslint dependencies explicitly in your project
- [x] Eslint dependencies work together out of the box
- [x] Eslint config with simplified defaults
**Cons**:
- [x] If this package becomes outdated you may need to manually manage dependencies again
## Install
Install it.
```bash
pnpm add -D eslint-config-nfour
```
Wire it up.
```bash
echo "module.exports = require('eslint-config-nfour')" > .eslintrc.js
# OR with react rules...
echo "module.exports = require('eslint-config-nfour/.eslintrc.react')" > .eslintrc.js
```
Configure `.prettierrc.js` with something like:
```js
module.exports = {
...require('eslint-config-nfour/.prettierrc'),
semi: false,
}
```
Done.
## How it works
Thanks to `require('@rushstack/eslint-patch/modern-module-resolution');`, plugins can be included relative to the configs, not the consuming project, so you don't need to install any eslint plugins/config peer dependencies.