@etchteam/eslint-config 3.1.2 → 3.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +3 -3
  2. package/README.md +14 -19
  3. package/package.json +6 -2
package/CHANGELOG.md CHANGED
@@ -1,4 +1,4 @@
1
- ## <small>3.1.2 (2026-04-06)</small>
1
+ ## <small>3.1.4 (2026-04-08)</small>
2
2
 
3
- * Merge pull request #552 from etchteam/dependabot/npm_and_yarn/eslint/compat-2.0.4 ([9c8c482](https://github.com/etchteam/eslint/commit/9c8c482)), closes [#552](https://github.com/etchteam/eslint/issues/552)
4
- * fix: Bump @eslint/compat from 2.0.3 to 2.0.4 ([ec8bf59](https://github.com/etchteam/eslint/commit/ec8bf59))
3
+ * Merge pull request #558 from etchteam/fix/storybook-optional-peer-dep ([8c83178](https://github.com/etchteam/eslint/commit/8c83178)), closes [#558](https://github.com/etchteam/eslint/issues/558)
4
+ * fix: move eslint-plugin-storybook to optional peer dependency ([035c668](https://github.com/etchteam/eslint/commit/035c668))
package/README.md CHANGED
@@ -7,7 +7,7 @@ The eslint config that we use at [Etch](https://etch.co)
7
7
  ## Install
8
8
 
9
9
  ```bash
10
- npm i -D eslint@^9.0.0 prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y
10
+ npm i -D eslint@^9.0.0 prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-storybook
11
11
  ```
12
12
 
13
13
  ## Usage
@@ -27,7 +27,7 @@ For projects that don't need the full config, use environment-specific imports t
27
27
  ### Next.js
28
28
 
29
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
30
+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-storybook @next/eslint-plugin-next eslint-plugin-react-hooks
31
31
  ```
32
32
 
33
33
  ```javascript
@@ -51,7 +51,7 @@ export default nodejs;
51
51
  ### Angular
52
52
 
53
53
  ```bash
54
- npm i -D eslint prettier @etchteam/eslint-config angular-eslint
54
+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-storybook angular-eslint
55
55
  ```
56
56
 
57
57
  ```javascript
@@ -63,7 +63,7 @@ export default angular;
63
63
  ### Preact
64
64
 
65
65
  ```bash
66
- npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y
66
+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-storybook
67
67
  ```
68
68
 
69
69
  ```javascript
@@ -75,7 +75,7 @@ export default preact;
75
75
  ### Web Components (Lit)
76
76
 
77
77
  ```bash
78
- npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-lit
78
+ npm i -D eslint prettier @etchteam/eslint-config eslint-plugin-storybook eslint-plugin-lit
79
79
  ```
80
80
 
81
81
  ```javascript
@@ -138,29 +138,24 @@ export default [
138
138
  | `web-components` | base + json + yaml + storybook + Lit rules |
139
139
  | `nestjs` | base + json + yaml + NestJS rules + Jest globals |
140
140
 
141
- ### Required Plugins
141
+ ### Required Peer Dependencies
142
142
 
143
- The **base**, **json**, **yaml**, and **storybook** modules have all their plugins included as package dependencies — no extra installs needed.
143
+ The **base**, **json**, and **yaml** modules have all their plugins included as package dependencies — no extra installs needed.
144
144
 
145
- Environment-specific configs require additional plugins to be installed as peer dependencies:
145
+ Other configs require additional plugins to be installed as peer dependencies:
146
146
 
147
147
  | Config | Additional plugins to install |
148
148
  |--------|-------------------------------|
149
- | Default (`@etchteam/eslint-config`) | `eslint-plugin-react` `eslint-plugin-jsx-a11y` |
149
+ | Default (`@etchteam/eslint-config`) | `eslint-plugin-react` `eslint-plugin-jsx-a11y` `eslint-plugin-storybook` |
150
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` |
151
+ | `storybook` | `eslint-plugin-storybook` |
152
+ | `nextjs` | `eslint-plugin-react` `eslint-plugin-jsx-a11y` `eslint-plugin-storybook` `@next/eslint-plugin-next` `eslint-plugin-react-hooks` |
152
153
  | `nodejs` | None |
153
- | `preact` | `eslint-plugin-react` `eslint-plugin-jsx-a11y` |
154
- | `angular` | `angular-eslint` |
155
- | `web-components` | `eslint-plugin-lit` |
154
+ | `preact` | `eslint-plugin-react` `eslint-plugin-jsx-a11y` `eslint-plugin-storybook` |
155
+ | `angular` | `eslint-plugin-storybook` `angular-eslint` |
156
+ | `web-components` | `eslint-plugin-storybook` `eslint-plugin-lit` |
156
157
  | `nestjs` | `@darraghor/eslint-plugin-nestjs-typed` |
157
158
 
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
-
164
159
  ## With lint-staged
165
160
 
166
161
  ### New project
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@etchteam/eslint-config",
3
- "version": "3.1.2",
3
+ "version": "3.1.4",
4
4
  "description": "Etch's standard eslint config",
5
5
  "type": "module",
6
6
  "main": "src/index.mjs",
@@ -50,6 +50,7 @@
50
50
  "eslint-plugin-lit": "^2.2.1",
51
51
  "eslint-plugin-react": "^7.37.5",
52
52
  "eslint-plugin-react-hooks": "^7.0.1",
53
+ "eslint-plugin-storybook": "^10.3.5",
53
54
  "husky": "^9.0.11",
54
55
  "lint-staged": "^16.0.0"
55
56
  },
@@ -62,7 +63,6 @@
62
63
  "eslint-plugin-json": "^4.0.1",
63
64
  "eslint-plugin-prettier": "^5.5.0",
64
65
  "eslint-plugin-security": "^4.0.0",
65
- "eslint-plugin-storybook": "^10.0.1",
66
66
  "eslint-plugin-unused-imports": "^4.1.3",
67
67
  "eslint-plugin-yml": "^3.0.0",
68
68
  "eslint-plugin-you-dont-need-lodash-underscore": "^6.14.0",
@@ -77,6 +77,7 @@
77
77
  "eslint-plugin-jsx-a11y": ">=6.0.0",
78
78
  "eslint-plugin-lit": ">=2.0.0",
79
79
  "eslint-plugin-react": ">=7.0.0",
80
+ "eslint-plugin-storybook": ">=10.0.0",
80
81
  "eslint-plugin-react-hooks": ">=5.0.0",
81
82
  "prettier": ">=3.0.0",
82
83
  "typescript": ">=4.8.4"
@@ -103,6 +104,9 @@
103
104
  "eslint-plugin-react-hooks": {
104
105
  "optional": true
105
106
  },
107
+ "eslint-plugin-storybook": {
108
+ "optional": true
109
+ },
106
110
  "typescript": {
107
111
  "optional": true
108
112
  }