@vue/eslint-config-prettier - npm Package Compare versions

Comparing version 7.0.0 to 7.1.0

package.json

 {
   "name": "@vue/eslint-config-prettier",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "eslint-config-prettier for Vue",
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "skip-formatting.js"
   ],
@@ -46,5 +47,4 @@ "publishConfig": {
   "scripts": {
-    "lint": "eslint index.js --fix"
-  },
-  "readme": "# @vue/eslint-config-prettier\n\n> eslint-config-prettier for Vue\n\nThis config is specifically designed to be used by `@vue/cli` & `create-vue` setups\nand is not meant for outside use (it can be used but some adaptations\non the user side might be needed - for details see the config file).\n\nA part of its design is that this config may implicitly depend on\nother parts of `@vue/cli`/`create-vue` setups.\n\n## Installation\n\nIn 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:\n\n```sh\nnpm add --dev @vue/eslint-config-prettier @rushstack/eslint-patch\n```\n\nPlease also make sure that you have `prettier` and `eslint` installed.\n\n## Usage\n\nAdd `\"@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.\n\n```js\nrequire(\"@rushstack/eslint-patch/modern-module-resolution\")\n\nmodule.exports = {\n  extends: [\n    // ... other configs\n    \"@vue/eslint-config-prettier\"\n  ]\n}\n```\n\n## Further Reading\n\nThe 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.\n"
-}
+    "lint": "eslint *.js --fix"
+  }
+}

README.md

@@ -14,3 +14,3 @@ # @vue/eslint-config-prettier
 
-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:
+Before [ESLint Flat Config](https://eslint.org/docs/latest/use/configure/configuration-files-new) becomes stable, 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:
 
@@ -38,4 +38,35 @@ ```sh
 
+This configuration is the most straightward way to use ESLint with Prettier.
+
+It disables all rules that are unnecessary or might conflict with Prettier.
+It also enables the `eslint-plugin-prettier` plugin, which runs Prettier as an ESLint rule and reports differences as individual ESLint issues.
+
+By default all formatting issues are reported as warnings, and will be automatically fixed during `eslint --fix`.
+
+## Use Separate Commands for Linting and Formatting
+
+While the above setup is very straightforward, it is not necessarily the best way.
+
+Running prettier inside the linter slows down the linting process, might clutter the editor with annoying warnings, and adds one layer of indirection where things may break.
+[Prettier's official documentation](https://prettier.io/docs/en/integrating-with-linters.html) recommends using separate commands for linting and formatting, i.e., Prettier for code formatting concerns and ESLint for code-quality concerns.
+
+So we offered an additional ruleset to support this workflow:
+
+```js
+require("@rushstack/eslint-patch/modern-module-resolution")
+
+module.exports = {
+  extends: [
+    // ... other configs
+    "@vue/eslint-config-prettier/skip-formatting"
+  ]
+}
+```
+
+Formatting issues won't be reported with this config.
+
+You can run `prettier --check .` separately to check for formatting issues, or `prettier --write .` to fix them.
+
 ## 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.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5368

increased by0.77%

Number of package files

5

increased by25%

Lines of code

13

increased by85.71%

Number of lines in readme file

71

increased by77.5%

Number of medium supply chain risk alerts

0

decreased by-100%

No dependency changes