eslint-plugin-vuetify

This package is for migrating from Vuetify v2 to v3, use eslint-plugin-vuetify@vuetify-2 for v1 to v2.

Support the maintainer of this plugin:

Kael Watts-Deuchar

💿 Install

You should have eslint and eslint-plugin-vue set up first.

yarn add eslint-plugin-vuetify -D
# OR
npm install eslint-plugin-vuetify --save-dev

// .eslintrc.js
module.exports = {
  extends: [
    'plugin:vue/base',
    'plugin:vuetify/base'
  ]
}

If you are using the new "flat" config system introduced in eslint v8.21.0 and made the default starting in v9.0.0. Then instead of an .eslintrc.js file you will have a eslint.config.js file. In that case you will use the following snippet instead.

// eslint.config.js
import pluginVuetify from "eslint-plugin-vuetify/configs/flat/base.js"
// To use the `recommended` configuration (including extra rules for the grid system) replace `base.js` with `recommended.js`

export default [
  pluginVuetify
]

NOTE This plugin does not affect pug templates due to a limitation in vue-eslint-parser. I suggest converting your pug templates to HTML with pug-to-html in order to use this plugin.

Rules

Deprecations

These rules will help you avoid deprecated components, props, and classes. They are included in the plugin:vuetify/base preset.

Prevent the use of components that have been removed from Vuetify (no-deprecated-components)
Prevent the use of props that have been removed from Vuetify (no-deprecated-props)
Prevent the use of events that have been removed from Vuetify (no-deprecated-events)
Prevent the use of classes that have been removed from Vuetify (no-deprecated-classes)
Prevent the use of the old theme class syntax (no-deprecated-colors)
Prevent the use of deprecated import paths (no-deprecated-imports)
Ensure icon buttons have a variant defined (icon-button-variant)

Grid system

These rules are designed to help migrate to the new grid system in Vuetify v2. They are included in the plugin:vuetify/recommended preset.

Warn about unknown attributes not being converted to classes on new grid components (grid-unknown-attributes)

💪 Supporting Vuetify

Vuetify is an open source MIT project that has been made possible due to the generous contributions by community backers. If you are interested in supporting this project, please consider:

Becoming a sponsor on Github (supports Kael)
Becoming a backer on OpenCollective (supports the Dev team)
Become a subscriber on Tidelift
Make a one-time payment with Paypal
Book time with John

📑 License

MIT

jewpaltz/eslint-plugin-vuetify