Skip to content

Commit

Permalink
fix(docs): recommend usage of eslint-patch
Browse files Browse the repository at this point in the history
  • Loading branch information
Tjark-Kuehl committed Jun 16, 2022
1 parent b268390 commit ab3c4ad
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 20 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,13 @@
- **Includes all the mentioned above**

## Installation
In order to work around [a known limitation in ESLint](https://github.com/eslint/eslint/issues/3458), we recommend you to use this package alongside `@rushstack/eslint-patch`, so that you don't have to install too many dependencies:
```sh
npm i -D eslint-config-liebe@latest
npm i -D eslint-config-liebe@latest @rushstack/eslint-patch

or

yarn add -D eslint-config-liebe@latest
yarn add -D eslint-config-liebe@latest @rushstack/eslint-patch
```

after that you have to install all the peerDependencies of this package by using:
Expand All @@ -45,18 +46,26 @@ npm info "eslint-config-liebe@latest" peerDependencies

Include the configs you need in your .eslintrc:
```.eslintrc.js
require("@rushstack/eslint-patch/modern-module-resolution")

module.exports = {
extends: [
'liebe/base',
'liebe/testing',
],
]
}
```

or just

```.eslintrc.js
require("@rushstack/eslint-patch/modern-module-resolution")

module.exports = {
extends: [
'liebe/all',
],
]
}
```

## Changelog
Expand Down
16 changes: 0 additions & 16 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,6 @@
"lint-staged": "13.0.1",
"semantic-release": "19.0.3"
},
"peerDependencies": {
"@typescript-eslint/eslint-plugin": "^5.25.0",
"@typescript-eslint/parser": "^5.25.0",
"eslint": "^8",
"eslint-config-airbnb-base": "^15.0.0",
"eslint-config-airbnb-typescript": "^16.2.0 || ^17.0.0",
"eslint-import-resolver-typescript": "^2.7.1",
"eslint-plugin-eslint-comments": "^3.2.0",
"eslint-plugin-import": "^2.26.0",
"eslint-plugin-jest": "^26.2.2",
"eslint-plugin-json": "^3.1.0",
"eslint-plugin-promise": "^6.0.0",
"eslint-plugin-simple-import-sort": "^7.0.0",
"eslint-plugin-sonarjs": "^0.11.0 || ^0.13.0",
"eslint-plugin-unicorn": "^40.1.0 || ^42.0.0"
},
"lint-staged": {
"*.js": "eslint --cache"
},
Expand Down

0 comments on commit ab3c4ad

Please sign in to comment.