Repository files navigation

Official ESLint plugin for Vue.js

Please refer to theofficial website.

This plugin followsSemantic Versioning.However, please note that we do not followESLint's Semantic Versioning Policy.In minor version releases, this plugin may change the sharable configs provided by the plugin or the default behavior of the plugin's rules in order to add features to the plugin. Because we want to add many features to the plugin soon, so that users can easily take advantage of new features in Vue and Nuxt.

According to our policy, any minor update may report more linting errors than the previous release. As such, we recommend using thetilde (~) inpackage.json to guarantee the results of your builds.

This project usesGitHub Releases.

Contributing is welcome! See theESLint Vue Plugin Developer Guide.

Be sure to read theofficial ESLint guide before you start writing a new rule.

To see what an abstract syntax tree (AST) of your code looks like, you may useAST Explorer. After openingAST Explorer, selectVue as the syntax andvue-eslint-parser as the parser.

The default JavaScript parser must be replaced becauseVue.js single file components are not plain JavaScript, but a custom file format.vue-eslint-parser is a replacement parser that generates an enhanced AST with nodes that represent specific parts of the template syntax, as well as the contents of the<script> tag.

To learn more about certain nodes in a produced AST, see theESTree project page and thevue-eslint-parser AST documentation.

vue-eslint-parser provides a few useful parser services to help traverse the produced AST and access template tokens:

• context.parserServices.defineTemplateBodyVisitor(visitor, scriptVisitor)
• context.parserServices.getTemplateBodyTokenStore()

Check out anexample rule to see usage of these services.

Be aware that depending on the code samples you write in tests, theRuleTester parser property must be set accordingly (this can be done on a test by test basis). See anexample here.

If you're stuck, remember there are many rules available for reference. If you can't find the right solution, don't hesitate to reach out inissues – we're happy to help!

See theLICENSE file for license rights and limitations (MIT).