eslint-plugin-vue

Appearance

On this page

vue/no-unused-properties ​

disallow unused properties

📖 Rule Details ​

This rule is aimed at eliminating unused properties.

Note

This rule cannot check for use of properties by other components (e.g. mixins, property access via $refs) and use in places where the scope cannot be determined. Some access to properties might be implied, for example accessing data or computed via a variable such as this[varName]. In this case, the default is to assume all properties, methods, etc. are 'used'. See the unreferencedOptions for a more strict interpretation of 'use' in these cases.

Now loading...
Now loading...

🔧 Options ​

json
{
  "vue/no-unused-properties": ["error", {
    "groups": ["props"],
    "deepData": false,
    "ignorePublicMembers": false,
    "unreferencedOptions": []
  }]
}
  • groups (string[]) Array of groups to search for properties. Default is ["props"]. The value of the array is some of the following strings:
    • "props"
    • "data"
    • "computed"
    • "methods"
    • "setup"
  • deepData (boolean) If true, the object of the property defined in data will be searched deeply. Default is false. Include "data" in groups to use this option.
  • ignorePublicMembers (boolean) If true, members marked with a JSDoc /** @public */ tag will be ignored. Default is false.
  • unreferencedOptions (string[]) Array of access methods that should be interpreted as leaving properties unreferenced. Currently, two such methods are available: unknownMemberAsUnreferenced, and returnAsUnreferenced. See examples below.

"groups": ["props", "data"] ​

Now loading...
Now loading...

{ "groups": ["props", "data"], "deepData": true } ​

Now loading...

"groups": ["props", "computed"] ​

Now loading...
Now loading...

{ "groups": ["props", "methods"], "ignorePublicMembers": true } ​

Now loading...

{ "groups": ["computed"], "unreferencedOptions": ["unknownMemberAsUnreferenced"] } ​

Now loading...

{ "groups": ["computed"], "unreferencedOptions": ["returnAsUnreferenced"] } ​

Now loading...

🚀 Version ​

This rule was introduced in eslint-plugin-vue v7.0.0

🔍 Implementation ​