refactor(hmr): pass context object to handleHotUpdate plugin hook

instead of multiple args BREAKING CHANGE: `handleHotUpdate` plugin hook now receives a single `HmrContext` argument instead of multiple args.
vitejs · Jan 2, 2021 · 6c26125 · 6c26125
1 parent d18e950
commit 6c26125
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 10 deletions.
diff --git a/packages/plugin-vue/src/handleHotUpdate.ts b/packages/plugin-vue/src/handleHotUpdate.ts
@@ -6,19 +6,19 @@ import {
   setPrevDescriptor
 } from './utils/descriptorCache'
 import { getResolvedScript, setResolvedScript } from './script'
-import { ModuleNode, ViteDevServer } from 'vite'
+import { ModuleNode, HmrContext } from 'vite'
 
 const debug = _debug('vite:hmr')
 
 /**
  * Vite-specific HMR handling
  */
-export async function handleHotUpdate(
-  file: string,
-  modules: ModuleNode[],
-  read: () => string | Promise<string>,
-  server: ViteDevServer
-): Promise<ModuleNode[] | void> {
+export async function handleHotUpdate({
+  file,
+  modules,
+  read,
+  server
+}: HmrContext): Promise<ModuleNode[] | void> {
   const prevDescriptor = getDescriptor(file, false)
   if (!prevDescriptor) {
     // file hasn't been requested yet (e.g. async component)

diff --git a/packages/plugin-vue/src/index.ts b/packages/plugin-vue/src/index.ts
@@ -65,11 +65,11 @@ export default function vuePlugin(rawOptions: Options = {}): Plugin {
   return {
     name: 'vite:vue',
 
-    handleHotUpdate(file, mods, read, server) {
-      if (!filter(file)) {
+    handleHotUpdate(ctx) {
+      if (!filter(ctx.file)) {
         return
       }
-      return handleHotUpdate(file, mods, read, server)
+      return handleHotUpdate(ctx)
     },
 
     config(config) {