From 068d93b9e5bbe15670751cf9701d2c88cf2ba78a Mon Sep 17 00:00:00 2001
From: Evan You <yyx990803@gmail.com>
Date: Tue, 6 Apr 2021 17:38:43 -0400
Subject: [PATCH] wip: keyCode compat

---
 .../runtime-core/src/compat/deprecations.ts   | 11 +++-
 packages/runtime-core/src/index.ts            |  1 +
 packages/runtime-dom/src/directives/vOn.ts    | 50 ++++++++++++++++---
 3 files changed, 53 insertions(+), 9 deletions(-)

diff --git a/packages/runtime-core/src/compat/deprecations.ts b/packages/runtime-core/src/compat/deprecations.ts
index a371649c..73eca672 100644
--- a/packages/runtime-core/src/compat/deprecations.ts
+++ b/packages/runtime-core/src/compat/deprecations.ts
@@ -29,7 +29,9 @@ export const enum DeprecationTypes {
 
   PROPS_DEFAULT_THIS,
 
-  CUSTOM_DIR
+  CUSTOM_DIR,
+
+  V_ON_KEYCODE_MODIFIER
 }
 
 type DeprecationData = {
@@ -190,6 +192,13 @@ const deprecations: Record<DeprecationTypes, DeprecationData> = {
       `Custom directive hook "${legacyHook}" has been removed. ` +
       `Use "${newHook}" instead.`,
     link: `https://v3.vuejs.org/guide/migration/custom-directives.html`
+  },
+
+  [DeprecationTypes.V_ON_KEYCODE_MODIFIER]: {
+    message:
+      `Using keyCode as v-on modifier is no longer supported. ` +
+      `Use kebab-case key name modifiers instead.`,
+    link: `https://v3.vuejs.org/guide/migration/keycode-modifiers.html`
   }
 }
 
diff --git a/packages/runtime-core/src/index.ts b/packages/runtime-core/src/index.ts
index b0bc0645..54a589f8 100644
--- a/packages/runtime-core/src/index.ts
+++ b/packages/runtime-core/src/index.ts
@@ -286,3 +286,4 @@ export const ssrUtils = (__NODE_JS__ ? _ssrUtils : null) as typeof _ssrUtils
 // checks
 export { warnDeprecation, DeprecationTypes } from './compat/deprecations'
 export { createCompatVue, CompatVue } from './compat/global'
+export { LegacyConfig } from './compat/globalConfig'
diff --git a/packages/runtime-dom/src/directives/vOn.ts b/packages/runtime-dom/src/directives/vOn.ts
index ce4a4d0c..93d62ec6 100644
--- a/packages/runtime-dom/src/directives/vOn.ts
+++ b/packages/runtime-dom/src/directives/vOn.ts
@@ -1,4 +1,10 @@
-import { hyphenate } from '@vue/shared'
+import {
+  DeprecationTypes,
+  warnDeprecation,
+  getCurrentInstance,
+  LegacyConfig
+} from '@vue/runtime-core'
+import { hyphenate, isArray } from '@vue/shared'
 
 const systemModifiers = ['ctrl', 'shift', 'alt', 'meta']
 
@@ -51,15 +57,43 @@ const keyNames: Record<string, string | string[]> = {
  * @private
  */
 export const withKeys = (fn: Function, modifiers: string[]) => {
+  let keyCodes: LegacyConfig['keyCodes']
+  if (__COMPAT__) {
+    keyCodes = ((getCurrentInstance()!.appContext
+      .config as any) as LegacyConfig).keyCodes
+    if (__DEV__ && modifiers.some(m => /^\d+$/.test(m))) {
+      warnDeprecation(DeprecationTypes.V_ON_KEYCODE_MODIFIER)
+    }
+  }
+
   return (event: KeyboardEvent) => {
-    if (!('key' in event)) return
-    const eventKey = hyphenate(event.key)
-    if (
-      // None of the provided key modifiers match the current event key
-      !modifiers.some(k => k === eventKey || keyNames[k] === eventKey)
-    ) {
+    if (!('key' in event)) {
       return
     }
-    return fn(event)
+
+    const eventKey = hyphenate(event.key)
+    if (modifiers.some(k => k === eventKey || keyNames[k] === eventKey)) {
+      return fn(event)
+    }
+
+    if (__COMPAT__) {
+      const keyCode = String(event.keyCode)
+      if (modifiers.some(mod => mod == keyCode)) {
+        return fn(event)
+      }
+      if (keyCodes) {
+        for (const mod of modifiers) {
+          const codes = keyCodes[mod]
+          if (codes) {
+            const matches = isArray(codes)
+              ? codes.some(code => String(code) === keyCode)
+              : String(codes) === keyCode
+            if (matches) {
+              return fn(event)
+            }
+          }
+        }
+      }
+    }
   }
 }