eslint-plugin-vue

    7.15.0 • Public • Published

    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 ESLint's 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 couldn't 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 what's inside the <script> tag.

    To know more about certain nodes in produced ASTs, go here:

    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 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!

    🔒 License

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

    Install

    npm i eslint-plugin-vue

    DownloadsWeekly Downloads

    1,878,952

    Version

    7.15.0

    License

    MIT

    Unpacked Size

    994 kB

    Total Files

    236

    Last publish

    Collaborators

    • avatar
    • avatar
    • avatar
    • avatar
    • avatar