@@ -7,7 +7,7 @@ The eslint config that we use at [Etch](https://etch.co)
77## Install
88
99``` bash
10- npm i -D eslint@^9.0.0 prettier @etchteam/eslint-config
10+ npm i -D eslint@^9.0.0 prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y
1111```
1212
1313## Usage
@@ -26,6 +26,10 @@ For projects that don't need the full config, use environment-specific imports t
2626
2727### Next.js
2828
29+ ``` bash
30+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y @next/eslint-plugin-next eslint-plugin-react-hooks
31+ ```
32+
2933``` javascript
3034import nextjs from ' @etchteam/eslint-config/nextjs' ;
3135
@@ -34,6 +38,10 @@ export default nextjs;
3438
3539### Node.js / Express
3640
41+ ``` bash
42+ npm i -D eslint prettier @etchteam/eslint-config
43+ ```
44+
3745``` javascript
3846import nodejs from ' @etchteam/eslint-config/nodejs' ;
3947
@@ -42,6 +50,10 @@ export default nodejs;
4250
4351### Angular
4452
53+ ``` bash
54+ npm i -D eslint prettier @etchteam/eslint-config angular-eslint
55+ ```
56+
4557``` javascript
4658import angular from ' @etchteam/eslint-config/angular' ;
4759
@@ -50,6 +62,10 @@ export default angular;
5062
5163### Preact
5264
65+ ``` bash
66+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y
67+ ```
68+
5369``` javascript
5470import preact from ' @etchteam/eslint-config/preact' ;
5571
@@ -58,6 +74,10 @@ export default preact;
5874
5975### Web Components (Lit)
6076
77+ ``` bash
78+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-lit
79+ ```
80+
6181``` javascript
6282import webComponents from ' @etchteam/eslint-config/web-components' ;
6383
@@ -66,6 +86,10 @@ export default webComponents;
6686
6787### NestJS
6888
89+ ``` bash
90+ npm i -D eslint prettier @etchteam/eslint-config @darraghor/eslint-plugin-nestjs-typed
91+ ```
92+
6993``` javascript
7094import nestjs from ' @etchteam/eslint-config/nestjs' ;
7195
@@ -114,6 +138,29 @@ export default [
114138| ` web-components ` | base + json + yaml + storybook + Lit rules |
115139| ` nestjs ` | base + json + yaml + NestJS rules + Jest globals |
116140
141+ ### Required Plugins
142+
143+ The ** base** , ** json** , ** yaml** , and ** storybook** modules have all their plugins included as package dependencies — no extra installs needed.
144+
145+ Environment-specific configs require additional plugins to be installed as peer dependencies:
146+
147+ | Config | Additional plugins to install |
148+ | --------| -------------------------------|
149+ | Default (` @etchteam/eslint-config ` ) | ` eslint-plugin-react ` ` eslint-plugin-jsx-a11y ` |
150+ | ` react ` | ` eslint-plugin-react ` ` eslint-plugin-jsx-a11y ` |
151+ | ` nextjs ` | ` eslint-plugin-react ` ` eslint-plugin-jsx-a11y ` ` @next/eslint-plugin-next ` ` eslint-plugin-react-hooks ` |
152+ | ` nodejs ` | None |
153+ | ` preact ` | ` eslint-plugin-react ` ` eslint-plugin-jsx-a11y ` |
154+ | ` angular ` | ` angular-eslint ` |
155+ | ` web-components ` | ` eslint-plugin-lit ` |
156+ | ` nestjs ` | ` @darraghor/eslint-plugin-nestjs-typed ` |
157+
158+ For example, to use the Next.js config:
159+
160+ ``` bash
161+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y @next/eslint-plugin-next eslint-plugin-react-hooks
162+ ```
163+
117164## With lint-staged
118165
119166### New project
0 commit comments