Skip to content

Commit

Permalink
📦 Properly document eslint-config-prettier
Browse files Browse the repository at this point in the history
eslint-plugin-prettier actually configures eslint-config-prettier, and
it's an optional peer dependency so it must be explicitly installed
too.
  • Loading branch information
sergei-maertens committed Jan 7, 2025
1 parent d75d1e0 commit 99b888a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ npm install \
eslint-plugin-import \
eslint-plugin-jsx-a11y \
eslint-plugin-prettier \
eslint-config-prettier \
eslint-plugin-react \
eslint-plugin-react-hooks \
eslint-plugin-storybook \
Expand Down Expand Up @@ -65,6 +66,7 @@ For company-wide consistency, we really encourage you to use the recommended con
* [React](#react) plugins
* [Typescript](#typescript) plugins
* `eslint-plugin-import`
* `eslint-config-prettier`
* `eslint-plugin-prettier`
* `eslint-plugin-storybook`

Expand Down
30 changes: 30 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,42 @@
"eslint-import-resolver-typescript": ">=3.7.0",
"eslint-plugin-import": ">=2.31.0",
"eslint-plugin-jsx-a11y": ">=6.10.2",
"eslint-config-prettier": ">=9.0.0",
"eslint-plugin-prettier": ">=5.2.1",
"eslint-plugin-react": ">=7.37.3",
"eslint-plugin-react-hooks": ">=5.1.0",
"eslint-plugin-storybook": ">=0.11.2",
"typescript-eslint": ">=8.19.0"
},
"peerDependenciesMeta": {
"eslint-import-resolver-typescript": {
"optional": true
},
"eslint-plugin-import": {
"optional": true
},
"eslint-plugin-jsx-a11y": {
"optional": true
},
"eslint-config-prettier": {
"optional": true
},
"eslint-plugin-prettier": {
"optional": true
},
"eslint-plugin-react": {
"optional": true
},
"eslint-plugin-react-hooks": {
"optional": true
},
"eslint-plugin-storybook": {
"optional": true
},
"typescript-eslint": {
"optional": true
}
},
"devDependencies": {
"eslint-import-resolver-typescript": "^3.7.0",
"eslint-plugin-import": "^2.31.0",
Expand Down

0 comments on commit 99b888a

Please sign in to comment.