-
-
Notifications
You must be signed in to change notification settings - Fork 681
New: Add vue/no-deprecated-v-on-number-modifiers
rule
#1079
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
Merged
ota-meshi
merged 1 commit into
vuejs:master
from
yoyo930021:add-no-deprecated-v-on-number-modifiers
Apr 21, 2020
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,52 @@ | ||
--- | ||
pageClass: rule-details | ||
sidebarDepth: 0 | ||
title: vue/no-deprecated-v-on-number-modifiers | ||
description: disallow using deprecated number (keycode) modifiers (in Vue.js 3.0.0+) | ||
--- | ||
# vue/no-deprecated-v-on-number-modifiers | ||
> disallow using deprecated number (keycode) modifiers (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"`. | ||
- :wrench: The `--fix` option on the [command line](https://eslint.org/docs/user-guide/command-line-interface#fixing-problems) can automatically fix some of the problems reported by this rule. | ||
|
||
## :book: Rule Details | ||
|
||
This rule reports use of deprecated `KeyboardEvent.keyCode` modifier on `v-on` directive (in Vue.js 3.0.0+) | ||
|
||
<eslint-code-block fix :rules="{'vue/no-deprecated-v-on-number-modifiers': ['error']}"> | ||
|
||
```vue | ||
<template> | ||
<!-- ✓ GOOD --> | ||
<input v-on:keyup.page-down="onArrowUp"> | ||
<input @keyup.page-down="onArrowUp"> | ||
<input @keyup.9="onArrowUp"> <!-- 9 is KeyboardEvent.key --> | ||
|
||
|
||
<!-- ✗ BAD --> | ||
<input v-on:keyup.34="onArrowUp"> | ||
<input @keyup.34="onArrowUp"> | ||
</template> | ||
``` | ||
|
||
</eslint-code-block> | ||
|
||
## :wrench: Options | ||
|
||
Nothing. | ||
|
||
## :couple: Related rules | ||
|
||
- [valid-v-on] | ||
|
||
[valid-v-on]: valid-v-on.md | ||
|
||
## :books: Further reading | ||
|
||
- [RFC: drop keycode support](https://github.com/vuejs/rfcs/blob/master/active-rfcs/0014-drop-keycode-support.md) | ||
|
||
## :mag: Implementation | ||
|
||
- [Rule source](https://github.com/vuejs/eslint-plugin-vue/blob/master/lib/rules/no-deprecated-v-on-number-modifiers.js) | ||
- [Test source](https://github.com/vuejs/eslint-plugin-vue/blob/master/tests/lib/rules/no-deprecated-v-on-number-modifiers.js) |
This file contains hidden or 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 hidden or 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 hidden or 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,58 @@ | ||
/** | ||
* @fileoverview disallow using deprecated number (keycode) modifiers | ||
* @author yoyo930021 | ||
*/ | ||
'use strict' | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Requirements | ||
// ------------------------------------------------------------------------------ | ||
|
||
const utils = require('../utils') | ||
const keyCodeToKey = require('../utils/keycode-to-key.json') | ||
|
||
// ------------------------------------------------------------------------------ | ||
// Rule Definition | ||
// ------------------------------------------------------------------------------ | ||
|
||
module.exports = { | ||
meta: { | ||
type: 'problem', | ||
docs: { | ||
description: 'disallow using deprecated number (keycode) modifiers', | ||
categories: ['vue3-essential'], | ||
url: 'https://eslint.vuejs.org/rules/no-deprecated-v-on-number-modifiers.html' | ||
}, | ||
fixable: 'code', | ||
schema: [], | ||
messages: { | ||
numberModifierIsDeprecated: "'KeyboardEvent.keyCode' modifier on 'v-on' directive is deprecated. Using 'KeyboardEvent.key' instead." | ||
} | ||
}, | ||
|
||
create (context) { | ||
return utils.defineTemplateBodyVisitor(context, { | ||
"VAttribute[directive=true][key.name.name='on']" (node) { | ||
const modifier = node.key.modifiers.find(mod => Number.isInteger(parseInt(mod.name, 10))) | ||
if (!modifier) return | ||
|
||
const keyCodes = parseInt(modifier.name, 10) | ||
if ( | ||
keyCodes > 9 || keyCodes < 0 | ||
) { | ||
context.report({ | ||
node, | ||
loc: node.loc, | ||
messageId: 'numberModifierIsDeprecated', | ||
fix: (fixer) => { | ||
const key = keyCodeToKey[keyCodes] | ||
if (!key) return | ||
|
||
return fixer.replaceTextRange(modifier.range, `${key}`) | ||
} | ||
}) | ||
} | ||
} | ||
}) | ||
} | ||
} |
This file contains hidden or 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,100 @@ | ||
{ | ||
"8": "backspace", | ||
"9": "tab", | ||
"13": "enter", | ||
"16": "shift", | ||
"17": "ctrl", | ||
"18": "alt", | ||
"19": "pause-break", | ||
"20": "caps-lock", | ||
"27": "escape", | ||
"33": "page-up", | ||
"34": "page-down", | ||
"35": "end", | ||
"36": "home", | ||
"37": "left-arrow", | ||
"38": "up-arrow", | ||
"39": "right-arrow", | ||
"40": "down-arrow", | ||
"45": "insert", | ||
"46": "delete", | ||
"48": "0", | ||
"49": "1", | ||
"50": "2", | ||
"51": "3", | ||
"52": "4", | ||
"53": "5", | ||
"54": "6", | ||
"55": "7", | ||
"56": "8", | ||
"57": "9", | ||
"65": "a", | ||
"66": "b", | ||
"67": "c", | ||
"68": "d", | ||
"69": "e", | ||
"70": "f", | ||
"71": "g", | ||
"72": "h", | ||
"73": "i", | ||
"74": "j", | ||
"75": "k", | ||
"76": "l", | ||
"77": "m", | ||
"78": "n", | ||
"79": "o", | ||
"80": "p", | ||
"81": "q", | ||
"82": "r", | ||
"83": "s", | ||
"84": "t", | ||
"85": "u", | ||
"86": "v", | ||
"87": "w", | ||
"88": "x", | ||
"89": "y", | ||
"90": "z", | ||
"91": "left-window-key", | ||
"92": "right-window-key", | ||
"93": "select-key", | ||
"96": "numpad-0", | ||
"97": "numpad-1", | ||
"98": "numpad-2", | ||
"99": "numpad-3", | ||
"100": "numpad-4", | ||
"101": "numpad-5", | ||
"102": "numpad-6", | ||
"103": "numpad-7", | ||
"104": "numpad-8", | ||
"105": "numpad-9", | ||
"106": "multiply", | ||
"107": "add", | ||
"109": "subtract", | ||
"110": "decimal-point", | ||
"111": "divide", | ||
"112": "f1", | ||
"113": "f2", | ||
"114": "f3", | ||
"115": "f4", | ||
"116": "f5", | ||
"117": "f6", | ||
"118": "f7", | ||
"119": "f8", | ||
"120": "f9", | ||
"121": "f10", | ||
"122": "f11", | ||
"123": "f12", | ||
"144": "num-lock", | ||
"145": "scroll-lock", | ||
"186": "semi-colon", | ||
"187": "equal-sign", | ||
"188": "comma", | ||
"189": "dash", | ||
"190": "period", | ||
"191": "forward-slash", | ||
"192": "grave-accent", | ||
"219": "open-bracket", | ||
"220": "back-slash", | ||
"221": "close-braket", | ||
"222": "single-quote" | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for this PR.
Almost look good to me.
I could not set KeyboardEvent.key to 9. Can you tell me which browser can reproduce it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When you keyup
9
on 60% keyborad.https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
At the bottom of the linked page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for teaching me! NUMPAD! I misunderstood the Tab key.