Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New: add vue/no-unused-properties rule #871

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/rules/README.md
Expand Up @@ -155,6 +155,7 @@ For example:
| [vue/no-deprecated-scope-attribute](./no-deprecated-scope-attribute.md) | disallow deprecated `scope` attribute (in Vue.js 2.5.0+) | :wrench: |
| [vue/no-empty-pattern](./no-empty-pattern.md) | disallow empty destructuring patterns | |
| [vue/no-restricted-syntax](./no-restricted-syntax.md) | disallow specified syntax | |
| [vue/no-unused-properties](./no-unused-properties.md) | disallow unused properties, data and computed properties | |
| [vue/object-curly-spacing](./object-curly-spacing.md) | enforce consistent spacing inside braces | :wrench: |
| [vue/require-direct-export](./require-direct-export.md) | require the component to be directly exported | |
| [vue/script-indent](./script-indent.md) | enforce consistent indentation in `<script>` | :wrench: |
Expand Down
129 changes: 129 additions & 0 deletions docs/rules/no-unused-properties.md
@@ -0,0 +1,129 @@
---
pageClass: rule-details
sidebarDepth: 0
title: vue/no-unused-properties
description: disallow unused properties, data and computed properties
---
# vue/no-unused-properties
> disallow unused properties, data and computed properties

## :book: Rule Details

This rule disallows any unused properties, data and computed properties.

```vue
/* ✓ GOOD */

<template>
<div>{{ count }}</div>
</template>

<script>
export default {
props: ['count']
}
</script>
```

```vue
/* ✗ BAD (`count` property not used) */

<template>
<div>{{ cnt }}</div>
</template>

<script>
export default {
props: ['count']
}
</script>
```

```vue
/* ✓ GOOD */

<script>
export default {
data() {
return {
count: null
}
},
created() {
this.count = 2
}
}
</script>
```

```vue
/* ✓ BAD (`count` data not used) */

<script>
export default {
data() {
return {
count: null
}
},
created() {
this.cnt = 2
}
}
</script>
```

```vue
/* ✓ GOOD */

<template>
<p>{{ reversedMessage }}</p>
</template>

<script>
export default {
data() {
return {
message: 'Hello'
}
},
computed: {
reversedMessage() {
return this.message.split('').reverse().join('')
}
}
}
</script>
```

```vue
/* ✓ BAD (`reversedMessage` computed property not used) */

<template>
<p>{{ message }}</p>
</template>

<script>
export default {
data() {
return {
message: 'Hello'
}
},
computed: {
reversedMessage() {
return this.message.split('').reverse().join('')
}
}
}
</script>
```

## :wrench: Options

None.

## :mag: Implementation

- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-unused-properties.js)
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-unused-properties.js)
167 changes: 167 additions & 0 deletions lib/rules/no-unused-properties.js
@@ -0,0 +1,167 @@
/**
* @fileoverview Disallow unused properties, data and computed properties.
* @author Learning Equality
*/
'use strict'

// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------

const remove = require('lodash/remove')
const utils = require('../utils')

// ------------------------------------------------------------------------------
// Constants
// ------------------------------------------------------------------------------

const GROUP_PROPERTY = 'props'
const GROUP_DATA = 'data'
const GROUP_COMPUTED_PROPERTY = 'computed'
const GROUP_WATCHER = 'watch'

const PROPERTY_LABEL = {
[GROUP_PROPERTY]: 'property',
[GROUP_DATA]: 'data',
[GROUP_COMPUTED_PROPERTY]: 'computed property'
}

// ------------------------------------------------------------------------------
// Helpers
// ------------------------------------------------------------------------------

/**
* Extract names from references objects.
*/
const getReferencesNames = references => {
if (!references || !references.length) {
return []
}

return references.map(reference => {
if (!reference.id || !reference.id.name) {
return
}

return reference.id.name
})
}

/**
* Report all unused properties.
*/
const reportUnusedProperties = (context, properties) => {
if (!properties || !properties.length) {
return
}

properties.forEach(property => {
context.report({
node: property.node,
message: `Unused ${PROPERTY_LABEL[property.groupName]} found: "${property.name}"`
})
})
}

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

module.exports = {
meta: {
type: 'suggestion',
docs: {
description: 'disallow unused properties, data and computed properties',
category: undefined,
url: 'https://eslint.vuejs.org/rules/no-unused-properties.html'
},
fixable: null,
schema: []
},

create (context) {
let hasTemplate
let rootTemplateEnd
let unusedProperties = []
const thisExpressionsVariablesNames = []

const initialize = {
Program (node) {
if (context.parserServices.getTemplateBodyTokenStore == null) {
context.report({
loc: { line: 1, column: 0 },
message:
'Use the latest vue-eslint-parser. See also https://vuejs.github.io/eslint-plugin-vue/user-guide/#what-is-the-use-the-latest-vue-eslint-parser-error.'
})
return
}

hasTemplate = Boolean(node.templateBody)
}
}

const scriptVisitor = Object.assign(
{},
{
'MemberExpression[object.type="ThisExpression"][property.type="Identifier"][property.name]' (
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you change to support the destructuring assignment?

const {prop} = this

Also could you change to support the track the this?
I want to support assignment expressions as follows:

const vm = this
vm.prop

node
) {
thisExpressionsVariablesNames.push(node.property.name)
}
},
utils.executeOnVue(context, obj => {
unusedProperties = Array.from(
utils.iterateProperties(obj, new Set([GROUP_PROPERTY, GROUP_DATA, GROUP_COMPUTED_PROPERTY]))
)

const watchers = Array.from(utils.iterateProperties(obj, new Set([GROUP_WATCHER])))
const watchersNames = watchers.map(watcher => watcher.name)

remove(unusedProperties, property => {
return (
thisExpressionsVariablesNames.includes(property.name) ||
watchersNames.includes(property.name)
)
})

if (!hasTemplate && unusedProperties.length) {
reportUnusedProperties(context, unusedProperties)
}
})
)

const templateVisitor = {
'VExpressionContainer[expression!=null][references]' (node) {
const referencesNames = getReferencesNames(node.references)

remove(unusedProperties, property => {
return referencesNames.includes(property.name)
})
},
// save root template end location - just a helper to be used
// for a decision if a parser reached the end of the root template
"VElement[name='template']" (node) {
if (rootTemplateEnd) {
return
}

rootTemplateEnd = node.loc.end
},
"VElement[name='template']:exit" (node) {
if (node.loc.end !== rootTemplateEnd) {
return
}

if (unusedProperties.length) {
reportUnusedProperties(context, unusedProperties)
}
}
}

return Object.assign(
{},
initialize,
utils.defineTemplateBodyVisitor(context, templateVisitor, scriptVisitor)
)
}
}