|
| 1 | +--- |
| 2 | +pageClass: rule-details |
| 3 | +sidebarDepth: 0 |
| 4 | +title: vue/no-unused-properties |
| 5 | +description: disallow unused properties |
| 6 | +--- |
| 7 | +# vue/no-unused-properties |
| 8 | +> disallow unused properties |
| 9 | +
|
| 10 | +## :book: Rule Details |
| 11 | + |
| 12 | +This rule is aimed at eliminating unused properties. |
| 13 | + |
| 14 | +::: warning Note |
| 15 | +This rule cannot be checked for use in other components (e.g. `mixins`, Property access via `$refs`) and use in places where the scope cannot be determined. |
| 16 | +::: |
| 17 | + |
| 18 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error']}"> |
| 19 | + |
| 20 | +```vue |
| 21 | +<!-- ✓ GOOD --> |
| 22 | +<template> |
| 23 | + <div>{{ count }}</div> |
| 24 | +</template> |
| 25 | +<script> |
| 26 | + export default { |
| 27 | + props: ['count'] |
| 28 | + } |
| 29 | +</script> |
| 30 | +``` |
| 31 | + |
| 32 | +</eslint-code-block> |
| 33 | + |
| 34 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error']}"> |
| 35 | + |
| 36 | +```vue |
| 37 | +<!-- ✗ BAD (`count` property not used) --> |
| 38 | +<template> |
| 39 | + <div>{{ cnt }}</div> |
| 40 | +</template> |
| 41 | +<script> |
| 42 | + export default { |
| 43 | + props: ['count'] |
| 44 | + } |
| 45 | +</script> |
| 46 | +``` |
| 47 | + |
| 48 | +</eslint-code-block> |
| 49 | + |
| 50 | +## :wrench: Options |
| 51 | + |
| 52 | +```json |
| 53 | +{ |
| 54 | + "vue/no-unused-properties": ["error", { |
| 55 | + "groups": ["props"] |
| 56 | + }] |
| 57 | +} |
| 58 | +``` |
| 59 | + |
| 60 | +- `"groups"` (`string[]`) Array of groups to search for properties. Default is `["props"]`. The value of the array is some of the following strings: |
| 61 | + - `"props"` |
| 62 | + - `"data"` |
| 63 | + - `"computed"` |
| 64 | + - `"methods"` |
| 65 | + - `"setup"` |
| 66 | + |
| 67 | +### `"groups": ["props", "data"]` |
| 68 | + |
| 69 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error', {groups: ['props', 'data']}]}"> |
| 70 | + |
| 71 | +```vue |
| 72 | +<!-- ✓ GOOD --> |
| 73 | +<script> |
| 74 | + export default { |
| 75 | + data() { |
| 76 | + return { |
| 77 | + count: null |
| 78 | + } |
| 79 | + }, |
| 80 | + created() { |
| 81 | + this.count = 2 |
| 82 | + } |
| 83 | + } |
| 84 | +</script> |
| 85 | +``` |
| 86 | + |
| 87 | +</eslint-code-block> |
| 88 | + |
| 89 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error', {groups: ['props', 'data']}]}"> |
| 90 | + |
| 91 | +```vue |
| 92 | +<!-- ✓ BAD (`count` data not used) --> |
| 93 | +<script> |
| 94 | + export default { |
| 95 | + data() { |
| 96 | + return { |
| 97 | + count: null |
| 98 | + } |
| 99 | + }, |
| 100 | + created() { |
| 101 | + this.cnt = 2 |
| 102 | + } |
| 103 | + } |
| 104 | +</script> |
| 105 | +``` |
| 106 | + |
| 107 | +</eslint-code-block> |
| 108 | + |
| 109 | +### `"groups": ["props", "computed"]` |
| 110 | + |
| 111 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error', {groups: ['props', 'computed']}]}"> |
| 112 | + |
| 113 | +```vue |
| 114 | +<!-- ✓ GOOD --> |
| 115 | +<template> |
| 116 | + <p>{{ reversedMessage }}</p> |
| 117 | +</template> |
| 118 | +<script> |
| 119 | + export default { |
| 120 | + data() { |
| 121 | + return { |
| 122 | + message: 'Hello' |
| 123 | + } |
| 124 | + }, |
| 125 | + computed: { |
| 126 | + reversedMessage() { |
| 127 | + return this.message.split('').reverse().join('') |
| 128 | + } |
| 129 | + } |
| 130 | + } |
| 131 | +</script> |
| 132 | +``` |
| 133 | + |
| 134 | +</eslint-code-block> |
| 135 | + |
| 136 | +<eslint-code-block :rules="{'vue/no-unused-properties': ['error', {groups: ['props', 'computed']}]}"> |
| 137 | + |
| 138 | +```vue |
| 139 | +<!-- ✓ BAD (`reversedMessage` computed property not used) --> |
| 140 | +<template> |
| 141 | + <p>{{ message }}</p> |
| 142 | +</template> |
| 143 | +<script> |
| 144 | + export default { |
| 145 | + data() { |
| 146 | + return { |
| 147 | + message: 'Hello' |
| 148 | + } |
| 149 | + }, |
| 150 | + computed: { |
| 151 | + reversedMessage() { |
| 152 | + return this.message.split('').reverse().join('') |
| 153 | + } |
| 154 | + } |
| 155 | + } |
| 156 | +</script> |
| 157 | +``` |
| 158 | + |
| 159 | +</eslint-code-block> |
| 160 | + |
| 161 | +## :mag: Implementation |
| 162 | + |
| 163 | +- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-unused-properties.js) |
| 164 | +- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-unused-properties.js) |
0 commit comments