no-deprecated-v-on-number-modifiers.js 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. /**
  2. * @fileoverview disallow using deprecated number (keycode) modifiers
  3. * @author yoyo930021
  4. */
  5. 'use strict'
  6. // ------------------------------------------------------------------------------
  7. // Requirements
  8. // ------------------------------------------------------------------------------
  9. const utils = require('../utils')
  10. const keyCodeToKey = require('../utils/keycode-to-key')
  11. // ------------------------------------------------------------------------------
  12. // Rule Definition
  13. // ------------------------------------------------------------------------------
  14. module.exports = {
  15. meta: {
  16. type: 'problem',
  17. docs: {
  18. description:
  19. 'disallow using deprecated number (keycode) modifiers (in Vue.js 3.0.0+)',
  20. categories: ['vue3-essential'],
  21. url:
  22. 'https://eslint.vuejs.org/rules/no-deprecated-v-on-number-modifiers.html'
  23. },
  24. fixable: 'code',
  25. schema: [],
  26. messages: {
  27. numberModifierIsDeprecated:
  28. "'KeyboardEvent.keyCode' modifier on 'v-on' directive is deprecated. Using 'KeyboardEvent.key' instead."
  29. }
  30. },
  31. /** @param {RuleContext} context */
  32. create(context) {
  33. return utils.defineTemplateBodyVisitor(context, {
  34. /** @param {VDirectiveKey} node */
  35. "VAttribute[directive=true][key.name.name='on'] > VDirectiveKey"(node) {
  36. const modifier = node.modifiers.find((mod) =>
  37. Number.isInteger(parseInt(mod.name, 10))
  38. )
  39. if (!modifier) return
  40. const keyCodes = parseInt(modifier.name, 10)
  41. if (keyCodes > 9 || keyCodes < 0) {
  42. context.report({
  43. node: modifier,
  44. messageId: 'numberModifierIsDeprecated',
  45. fix(fixer) {
  46. const key = keyCodeToKey[keyCodes]
  47. if (!key) return null
  48. return fixer.replaceText(modifier, `${key}`)
  49. }
  50. })
  51. }
  52. }
  53. })
  54. }
  55. }