@tutods/eslint-config
v1.17.2
Published
ESLint configuration for JavaScript, TypeScript, React, Node.js, TailwindCSS projects, allowing to use other configs like sort imports, sort keys and more.
Downloads
87
Maintainers
Readme
ESLint Config (@tutods/eslint-config
)
▶️ Installation
Using NPM:
npm i -D @tutods/eslint-config
Using Yarn:
yarn add -D @tutods/eslint-config
Using PNPM:
pnpm add -D @tutods/eslint-config
📄 Usage
With this package, multiple configurations are exported. You need to pick the ones you will use.
Note: probably some configurations use others, like
/react
extends/javascript
and/typescript
configuration.
Configurations available
/javascript
;/typescript
;/react
;/next
;/tailwind
;/node
;/imports
;/prettier
;/sort-imports
;/sort-keys
Use ESLint configuration
For use any of these ESLint configurations, you need to create the file .eslintrc
on the root directory of you
project and use the "extends": []
to load the configurations you want.
See the example below.
Example:
file:
.eslintrc
{ "extends": [ "@tutods/eslint-config/next", "@tutods/eslint-config/tailwind", "@tutods/eslint-config/sort-keys" ] }
Note: This ESLint configuration uses Next.js (with TS) + TailwindCSS + sort keys and destructure keys configurations.
Peers Dependencies
Depending on the configuration you choose, you need to install some dependencies, examples:
/react
configuration
For use my React configuration, you need to install the following packages:
javascript
(for.js
and.jsx
files);typescript
(for.ts
and.tsx
files);@typescript-eslint/eslint-plugin
;@typescript-eslint/parser
;
eslint-plugin-jsx-a11y
;eslint-plugin-react
;eslint-plugin-react-hooks
.
If you (for example) use the
/next
config, all the dependencies listed above will be needed, because that's config extends the/react
config.Note: if you are extending
next/core-web-vitals
, you don't need to install theeslint-plugin-react-hooks
pacakge.
/prettier
configuration
For use my Prettier configuration, you need to install the following packages:
prettier
;eslint-config-prettier
;eslint-plugin-prettier
.