vetur VS lint-staged

If you use the Vetur extension for Vue language features, you are out of luck. There is a long-standing request for adding this behaviour to Vetur.

The first step is to enable the Volar extension and disable the Vetur extension. Volar is the new recommended extension to use with Vue 3 and typescript.

Volar is supposed to be the upcoming replacement for Vetur, the Vue.js lsp server. It looks like it's significantly better than Vetur; has anyone tried it in lsp-mode in emacs?

There is a known bug in Vetur, the Vue VSCode extension, where it takes forever (sometimes several minutes!) to lint Vue files on save.

Now, we can create regular ol' Vue SFCs, or single file components. By creating the whole component in one file, we get the flexibility of thinking of our components as one functional unit made up of HTML, JavaScript, and CSS. We can also write components in TypeScript or SASS if we want to. We can also get syntax highlighting since SFCs end up being fundamentally HTML documents. And with VSCode plugins like (Vetur)[https://vuejs.github.io/vetur/], development in SFCs has a lot of benefits going for it.

You didn’t give much info, but from what I can tell from your screenshot you are writing in Vue and therefore are probably using Vetur. In that case the only info I could find was an issue from 4 years ago that seems to say you should just turn off style validation.

Vetur - Vue tooling for VS Code

Lint Staged: https://github.com/lint-staged/lint-staged

lint-staged is the second important tools we need here, install it via NPM.

We were already using lint-staged and have a pre-commit hook in place using Husky in our project for linter and prettier. So it made sense to add a check here.

Now you can config it in your package.json, here is the guide doc:

In the world of software development, maintaining consistent code quality and ensuring that the codebase adheres to predefined patterns and guidelines is crucial. However, manually enforcing these standards can be time-consuming and error-prone. This is where automation tools like Husky, Lint-Staged, Commitlint, and Commitizen come to the rescue. In this post, we will explore how these tools can be combined to streamline your development workflow.

This is wasted work that can and should be automated. Adding a linter and formatter on CI and a pre-commit hook such as lint-staged can do wonders.

lint-staged is a package that can be used to run formatting and linting commands on staged files in a Git repo.

To answer your next question: I lint and format on save, and I use Git hooks installed by Husky and executed through Lint-Staged (this tool helps ensure your Git hooks only run on modified files, etc) to ensure there are no lint or formatting errors whenever making a commit or pushing code. This is helpful for teams, as some developers tend to forget to run lint tasks, or don't have the Prettier extension installed in their IDE. If there are lint errors, the commit is rejected until fixed. YMMV - you'll need to fine-tune the strictness of this based on the team's needs.

Uses Husky Git hooks and Lint-staged pre-commit hooks.

Something else to consider is applying linting and formatting before every git commit. A package like Lint-staged only lints and formats on staged items, ensuring all pushed code follows the standards in the repo. This allows developers to have their own formatting preferences when developing, while the code homogenizes on push. Linting pre-commit also avoids strict rules like no-console or no-unused-vars restricting a developer when writing code, when it should only apply in production. Imagine not being able to console log anything during development!