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

📖 Usage

Use eslint.config.js file to configure rules. This is the default in ESLint v9, but can be used starting from ESLint v8.57.0. See also: https://eslint.org/docs/latest/use/configure/configuration-files-new.

// eslint.config.js
import pluginVue from 'eslint-plugin-vue'
import vuetify from "eslint-plugin-vuetify";

export default [
  ...pluginVue.configs['flat/recommended'],
  vuetify.configs.base,
  {
    rules: {
      // override/add rules settings here, such as:
      'vuetify/no-deprecated-classes': 'off',
      'vuetify/icon-button-variant': 'error',
    }
  }
]

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 vuetify.configs.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)
• Prevent the use of deprecated slot names ([no-deprecated-slots])

Grid system

These rules are designed to help migrate to the new grid system in Vuetify v2. They are included in the vuetify.configs.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

Copyright (c) 2016-present Vuetify LLC