@paperfeed/eslint-config v1.0.4
An eslint config with no hassle.
The default config @paperfeed
(located in next.js) is fine-tuned for a Typescript React project and adds a lot of fixable rules. Sorting is automatic and beautiful.
It makes use of @rushstack/eslint-patch
so you won't have to add any dependencies to your project. Just install eslint with this config, and you're good to go!
Recommended usage:
Just add @paperfeed
to your extends in your eslint config.
{
extends: ['@paperfeed']
}
If you wish to use NextJS you can instead use @paperfeed/eslint-config/next
I also recommend adding prettier npm install -D prettier
with the following config in your package.json
"prettier": {
"trailingComma": "es5",
"semi": false,
"singleQuote": true
}
and set both to run on save in your IDE.
From version 1.0.1 onwards the following is no longer required:
In the project you want to use it in run npm i -D @rushstack/eslint-patch
and edit your eslint config to contain the following:
// .eslintrc.js:
require('@rushstack/eslint-patch/modern-module-resolution')
module.exports = {
extends: ['@paperfeed'],
}
Available Configs
@paperfeed
: Optimized for a React project@paperfeed/eslint-config/vanilla
: Optimized for a vanilla javascript/node project@paperfeed/eslint-config/next
: Optimized for a NextJS project (uses core-web-vitals configuration)@paperfeed/eslint-config/next/no-conflict
: Optimized for a NextJS project where you want to extend 'next/recommended' or 'next/core-web-vitals' manually