Sometimes, we want to set up ESLint and Prettier in Vue.js projects and format code automatically with Prettier with VS Code.
In this article, we’ll look at how to set up ESLint and Prettier in Vue.js projects and format code automatically with Prettier with VS Code.
How to Set Up ESLint and Prettier in Vue.js Projects and Format Code Automatically with Prettier with VS Code?
To set up ESLint and Prettier in Vue.js projects and format code automatically with Prettier with VS Code, we install a few packages and VS Code extensions and change a few settings.
First, we install a few packages into our Vue project by running:
npm i -D babel-eslint eslint eslint-plugin-import eslint-plugin-node eslint-plugin-promise eslint-plugin-prettier
We install the ESLint with plugins for Vue projects.
Then we install extensions by pressing ctrl+shift+p in VS Code and search for ‘Extensions: Install Extension’.
Next, in the extensions search box on the left, we search for Prettier, ESLint, and Vetur and install them by clicking install.
After that, we press ctrl+shift+p in VS Code and search for ‘Preferences: Open Settings (JSON).
And then we paste the following into settings.json
:
{
"[css]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"files.eol": "\n",
"files.trimTrailingWhitespace": true,
"editor.renderControlCharacters": false,
"editor.renderWhitespace": "none",
"javascript.updateImportsOnFileMove.enabled": "always",
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true
},
"[html]": {
"editor.defaultFormatter": "vscode.html-language-features",
"editor.formatOnSave": true
},
"[scss]": {
"editor.defaultFormatter": "sibiraj-s.vscode-scss-formatter",
"editor.formatOnSave": true
},
"typescript.updateImportsOnFileMove.enabled": "always",
"html.format.wrapLineLength": 80,
"files.insertFinalNewline": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true,
"source.fixAll.stylelint": true
},
"editor.formatOnSave": true,
"vetur.format.defaultFormatter.html": "js-beautify-html",
"[vue]": {
"editor.defaultFormatter": "octref.vetur"
},
"editor.tabSize": 2,
"editor.defaultFormatter": "esbenp.prettier-vscode",
"[python]": {
"editor.formatOnType": true
},
"extensions.ignoreRecommendations": true,
"vue.codeActions.savingTimeLimit": 2000
}
to enable auto formatting and linting of Vue projects.
Finally, we create an .eslintrc.js
file in the Vue project’s root and add:
module.exports = {
root: true,
env: {
node: true,
es2022: true,
},
extends: ["eslint:recommended", "plugin:vue/vue3-recommended", "prettier"],
rules: {
"no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
"no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off",
},
};
into the file to enable the extensions needed for auto linting and formatting.
Conclusion
To set up ESLint and Prettier in Vue.js projects and format code automatically with Prettier with VS Code, we install a few packages and VS Code extensions and change a few settings.