From ab3c4ad6b19627dbc1deb73f7bd442c58454ca6f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tjark=20K=C3=BChl?= Date: Thu, 16 Jun 2022 14:26:41 +0200 Subject: [PATCH] fix(docs): recommend usage of eslint-patch --- README.md | 17 +++++++++++++---- package.json | 16 ---------------- 2 files changed, 13 insertions(+), 20 deletions(-) diff --git a/README.md b/README.md index ef276500..93bee6c9 100644 --- a/README.md +++ b/README.md @@ -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: @@ -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 diff --git a/package.json b/package.json index 7caa642c..4564e134 100644 --- a/package.json +++ b/package.json @@ -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" },