This repository has been archived on 2020-11-02. You can view files and clone it, but cannot push or open issues or pull requests.
TripSit_Suite/node_modules/eslint-plugin-vue
cranberry ed23347e56 Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00
..
lib Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00
node_modules/.bin Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00
LICENSE Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00
README.md Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00
package.json Initial comission of TheLounge base files 2020-11-01 22:46:04 +00:00

README.md

eslint-plugin-vue

NPM version NPM downloads CircleCI License

Official ESLint plugin for Vue.js

📖 Documentation

See the official website.

Versioning Policy

This plugin is following Semantic Versioning and ESLints Semantic Versioning Policy.

📰 Changelog

This project uses GitHub Releases.

🍻 Contribution Guide

Contribution is welcome!

See The ESLint Vue Plugin Developer Guide.

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.

Since single file components in Vue are not plain JavaScript, the default parser couldnt be used, so a new one was introduced. vue-eslint-parser generates enhanced AST with nodes that represent specific parts of the template syntax, as well as whats inside the <script> tag.

To know more about certain nodes in produced ASTs, go here: - ESTree docs - vue-eslint-parser AST docs

The vue-eslint-parser provides a few useful parser services that help traverse the produced AST and access tokens of the template: - context.parserServices.defineTemplateBodyVisitor(visitor, scriptVisitor) - context.parserServices.getTemplateBodyTokenStore()

Check out an example rule to get a better understanding of how these work.

Please be aware that regarding what kind of code examples youll write in tests, youll have to accordingly set up the parser in RuleTester (you can do it on a per test case basis). See an example here.

If youll stuck, remember there are plenty of rules you can learn from already. If you cant find the right solution, dont hesitate to reach out in issues were happy to help!

🔒 License

See the LICENSE file for license rights and limitations (MIT).