Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add
vue/no-deprecated-destroyed-lifecycle
rule (#1211)
* Add `vue/no-deprecated-destroyed-lifecycle` rule * Add testcases and fix bug
- Loading branch information
Showing
6 changed files
with
524 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/no-deprecated-destroyed-lifecycle | ||
description: disallow using deprecated `destroyed` and `beforeDestroy` lifecycle hooks (in Vue.js 3.0.0+) | ||
--- | ||
# vue/no-deprecated-destroyed-lifecycle | ||
> disallow using deprecated `destroyed` and `beforeDestroy` lifecycle hooks (in Vue.js 3.0.0+) | ||
- :gear: This rule is included in all of `"plugin:vue/vue3-essential"`, `"plugin:vue/vue3-strongly-recommended"` and `"plugin:vue/vue3-recommended"`. | ||
|
||
## :book: Rule Details | ||
|
||
This rule reports use of deprecated `destroyed` and `beforeDestroy` lifecycle hooks. (in Vue.js 3.0.0+). | ||
|
||
<eslint-code-block :rules="{'vue/no-deprecated-destroyed-lifecycle': ['error']}"> | ||
|
||
```vue | ||
<script> | ||
export default { | ||
/* ✓ GOOD */ | ||
beforeMount () {}, | ||
mounted () {}, | ||
beforeUnmount () {}, | ||
unmounted () {}, | ||
/* ✗ BAD */ | ||
beforeDestroy () {}, | ||
destroyed () {} | ||
} | ||
</script> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-deprecated-destroyed-lifecycle.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-deprecated-destroyed-lifecycle.js) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,101 @@ | ||
/** | ||
* @author Yosuke Ota | ||
* See LICENSE file in root directory for full license. | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: | ||
'disallow using deprecated `destroyed` and `beforeDestroy` lifecycle hooks (in Vue.js 3.0.0+)', | ||
categories: ['vue3-essential'], | ||
url: | ||
'https://eslint.vuejs.org/rules/no-deprecated-destroyed-lifecycle.html' | ||
}, | ||
fixable: null, | ||
schema: [], | ||
messages: { | ||
deprecatedDestroyed: | ||
'The `destroyed` lifecycle hook is deprecated. Use `unmounted` instead.', | ||
deprecatedBeforeDestroy: | ||
'The `beforeDestroy` lifecycle hook is deprecated. Use `beforeUnmount` instead.', | ||
insteadUnmounted: 'Instead, change to `unmounted`.', | ||
insteadBeforeUnmount: 'Instead, change to `beforeUnmount`.' | ||
} | ||
}, | ||
/** @param {RuleContext} context */ | ||
create(context) { | ||
return utils.executeOnVue(context, (obj) => { | ||
const destroyed = utils.findProperty(obj, 'destroyed') | ||
|
||
if (destroyed) { | ||
context.report({ | ||
node: destroyed.key, | ||
messageId: 'deprecatedDestroyed', | ||
// I don't know if they have exactly the same function, so don't do autofix. | ||
suggest: [ | ||
{ | ||
messageId: 'insteadUnmounted', | ||
fix(fixer) { | ||
return fix(fixer, destroyed, 'unmounted') | ||
} | ||
} | ||
] | ||
}) | ||
} | ||
|
||
const beforeDestroy = utils.findProperty(obj, 'beforeDestroy') | ||
if (beforeDestroy) { | ||
context.report({ | ||
node: beforeDestroy.key, | ||
messageId: 'deprecatedBeforeDestroy', | ||
// I don't know if they have exactly the same function, so don't do autofix. | ||
suggest: [ | ||
{ | ||
messageId: 'insteadBeforeUnmount', | ||
fix(fixer) { | ||
return fix(fixer, beforeDestroy, 'beforeUnmount') | ||
} | ||
} | ||
] | ||
}) | ||
} | ||
|
||
/** | ||
* @param {RuleFixer} fixer | ||
* @param {Property} property | ||
* @param {string} newName | ||
*/ | ||
function fix(fixer, property, newName) { | ||
if (property.computed) { | ||
if ( | ||
property.key.type === 'Literal' || | ||
property.key.type === 'TemplateLiteral' | ||
) { | ||
return fixer.replaceTextRange( | ||
[property.key.range[0] + 1, property.key.range[1] - 1], | ||
newName | ||
) | ||
} | ||
return null | ||
} | ||
if (property.shorthand) { | ||
return fixer.insertTextBefore(property.key, `${newName}:`) | ||
} | ||
return fixer.replaceText(property.key, newName) | ||
} | ||
}) | ||
} | ||
} |
Oops, something went wrong.