refactor!: update for integration with @rushstack/eslint-patch

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -1,21 +1,39 @@
-# Deprecated
-
-Please [use `eslint-plugin-prettier` directly](https://github.com/prettier/eslint-plugin-prettier#recommended-configuration).
-
-To migrate from `@vue/eslint-config-prettier`:
-1. `npm add -D eslint-config-prettier eslint-plugin-prettier`
-2. `npm remove @vue/eslint-config-prettier`
-3. Change `@vue/prettier` to `plugin:prettier/recommended` in your ESLint configuration
-4. If there's `@vue/prettier/@typescript-eslint` in the existing configuration, remove it.
-
 # @vue/eslint-config-prettier
 
-> eslint-config-prettier for Vue CLI
+> eslint-config-prettier for Vue
 
-This config is specifically designed to be used by Vue CLI setups
+This config is specifically designed to be used by `@vue/cli` & `create-vue` setups
 and is not meant for outside use (it can be used but some adaptations
 on the user side might be needed - for details see the config file).
 
 A part of its design is that this config may implicitly depend on
-other parts of Vue CLI setups, such as `eslint-plugin-vue` being
-extended in the same resulting config.
+other parts of `@vue/cli`/`create-vue` setups.
+
+## 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 add --dev @vue/eslint-config-prettier @rushstack/eslint-patch
+```
+
+Please also make sure that you have `prettier` and `eslint` installed.
+
+## Usage
+
+Add `"@vue/eslint-config-prettier"` to the `"extends"` array in your `.eslintrc.cjs` file. Make sure to put it **last**, so it gets the chance to override other configs.
+
+```js
+require("@rushstack/eslint-patch/modern-module-resolution")
+
+module.exports = {
+  extends: [
+    // ... other configs
+    "@vue/eslint-config-prettier"
+  ]
+}
+```
+
+## Further Reading
+
+The default config is based on the recommended configuration of [`eslint-plugin-prettier`](https://github.com/prettier/eslint-plugin-prettier/#recommended-configuration), which also depends on [`eslint-config-prettier`](https://github.com/prettier/eslint-config-prettier). Please refer to their corresponding documentations for more implementation details.

index.js

@@ -1,10 +1,7 @@
 module.exports = {
-  plugins: ['prettier'],
-  extends: [
-    require.resolve('eslint-config-prettier'),
-    require.resolve('eslint-config-prettier/vue')
-  ],
+  plugins: ["prettier"],
+  extends: ["plugin:prettier/recommended"],
   rules: {
-    'prettier/prettier': 'warn'
-  }
-}
+    "prettier/prettier": "warn",
+  },
+};

package.json

@@ -1,8 +1,9 @@
 {
   "name": "@vue/eslint-config-prettier",
   "version": "6.0.0",
-  "description": "eslint-config-prettier for Vue CLI",
+  "description": "eslint-config-prettier for Vue",
   "main": "index.js",
+  "files": ["index.js"],
   "publishConfig": {
     "access": "public"
   },
@@ -12,7 +13,9 @@
   },
   "keywords": [
     "vue",
-    "cli"
+    "cli",
+    "eslint",
+    "prettier"
   ],
   "author": "Evan You",
   "license": "MIT",
@@ -21,11 +24,21 @@
   },
   "homepage": "https://github.com/vuejs/eslint-config-prettier#readme",
   "dependencies": {
-    "eslint-config-prettier": "^6.0.0"
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.5.0",
+    "prettier": "^2.5.1"
   },
   "peerDependencies": {
-    "eslint": ">= 5.0.0",
-    "eslint-plugin-prettier": "^3.1.0",
-    "prettier": ">= 1.13.0"
+    "eslint": ">= 7.28.0",
+    "prettier": ">= 2.0.0"
+  },
+  "eslintConfig": {
+    "extends": ["./index.js"]
+  },
+  "scripts": {
+    "lint": "eslint index.js --fix"
   }
 }