eslint-config-vtex-react
v9.1.0
Published
VTEX's eslint config for React
Downloads
32,758
Maintainers
Readme
eslint-config-vtex-react
This package provides VTEX's .eslintrc
for React projects as an extensible shared config.
Not all React applications live in the same context, different rules are needed for different scenarios. To solve this, three presets are provided:
vtex-react
- Base react configuration. Can be used in any React project.vtex-react/io
- To be used in VTEX IO React applications.vtex-react/native
- To be used inreact-native
applications.
Installation
Assuming you already have ESLint installed, run:
yarn add -D eslint-config-vtex-react typescript prettier
Usage
After installing the module, just add it to your extends
array inside your .eslintrc
.
// .eslintrc
{
"extends": ["vtex-react"]
}
As any other eslint preset, it's possible to override some rules and configurations. We encourage trying to keep the closest possible to the preset rules, but every project is different and sometimes overriding is needed, use it carefully.