Security News
The Unpaid Backbone of Open Source: Solo Maintainers Face Increasing Security Demands
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
@vue/eslint-config-prettier
Advanced tools
@vue/eslint-config-prettier is an ESLint configuration package that disables rules that might conflict with Prettier, a code formatting tool. This package ensures that your Vue.js project adheres to Prettier's formatting rules without any conflicts from ESLint.
Disabling conflicting ESLint rules
By extending `@vue/eslint-config-prettier` in your ESLint configuration, you disable all ESLint rules that are unnecessary or might conflict with Prettier. This ensures that Prettier's formatting rules take precedence.
{
"extends": [
"@vue/eslint-config-prettier"
]
}
Integration with Vue.js projects
This configuration extends both Vue's essential linting rules and Prettier's rules, ensuring that your Vue.js project is linted according to best practices while also being formatted by Prettier.
{
"extends": [
"plugin:vue/essential",
"@vue/eslint-config-prettier"
]
}
eslint-config-prettier is a popular package that turns off all ESLint rules that are unnecessary or might conflict with Prettier. It is not specific to Vue.js and can be used with any JavaScript project.
eslint-plugin-prettier integrates Prettier into ESLint. It runs Prettier as an ESLint rule and reports differences as individual ESLint issues. This package can be used alongside eslint-config-prettier for a comprehensive setup.
eslint-config-airbnb is a widely-used ESLint configuration that follows Airbnb's JavaScript style guide. While it does not specifically integrate with Prettier, it can be used in conjunction with eslint-config-prettier to avoid conflicts.
eslint-config-prettier for Vue
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
/create-vue
setups.
Before ESLint Flat Config becomes stable, in order to work around a known limitation in ESLint, we recommend you to use this package alongside @rushstack/eslint-patch
, so that you don't have to install too many dependencies:
npm add --dev @vue/eslint-config-prettier @rushstack/eslint-patch
Please also make sure that you have prettier
and eslint
installed.
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.
require("@rushstack/eslint-patch/modern-module-resolution")
module.exports = {
extends: [
// ... other configs
"@vue/eslint-config-prettier"
]
}
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
.
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 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:
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.
The default config is based on the recommended configuration of eslint-plugin-prettier
, which also depends on eslint-config-prettier
. Please refer to their corresponding documentations for more implementation details.
8.0.0 (2023-07-20)
<a name="7.1.0"></a>
FAQs
eslint-config-prettier for Vue
We found that @vue/eslint-config-prettier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Solo open source maintainers face burnout and security challenges, with 60% unpaid and 60% considering quitting.
Security News
License exceptions modify the terms of open source licenses, impacting how software can be used, modified, and distributed. Developers should be aware of the legal implications of these exceptions.
Security News
A developer is accusing Tencent of violating the GPL by modifying a Python utility and changing its license to BSD, highlighting the importance of copyleft compliance.