Official ESLint plugin for Vue.js
See the official website.
❗️ Attention - this is documentation for version
This branch contains
eslint-plugin-vue@nextwhich is a pre-released
7.0, but it's not the default version that you get with
npm install eslint-plugin-vue. In order to install this you need to specify either
npm install eslint-plugin-vue@next.
Please try it and report any issues that you might have encountered.
If you want to check previous releases go here.
⚓️ Versioning Policy
This project uses GitHub Releases.
🍻 Contribution Guide
Contribution is welcome!
Working with Rules
Before you start writing a new rule, please read the official ESLint guide.
Next, in order to get an idea how does the AST of the code that you want to check looks like, use the astexplorer.net. The astexplorer.net is a great tool to inspect ASTs, also Vue templates are supported.
After opening astexplorer.net, select
Vue as the syntax and
vue-eslint-parser as the parser.
vue-eslint-parser generates enhanced AST with nodes that represent specific parts of the template syntax, as well as what's inside the
To know more about certain nodes in produced ASTs, go here:
vue-eslint-parser provides a few useful parser services that help traverse the produced AST and access tokens of the template:
Check out an example rule to get a better understanding of how these work.
Please be aware that regarding what kind of code examples you'll write in tests, you'll have to accordingly set up the parser in
RuleTester (you can do it on a per test case basis). See an example here.
If you'll stuck, remember there are plenty of rules you can learn from already. If you can't find the right solution, don't hesitate to reach out in issues – we're happy to help!
See the LICENSE file for license rights and limitations (MIT).