feat: hmr event api

Author: twlite

packages/commandkit/src/cli/development.ts

@@ -7,6 +7,7 @@ import { watch } from 'chokidar';
 import { debounce } from '../utils/utilities';
 import colors from '../utils/colors';
 import { ChildProcess } from 'node:child_process';
+import { setTimeout as sleep } from 'node:timers/promises';
 
 async function buildAndStart(configPath: string, skipStart = false) {
   const config = await loadConfigFile(configPath);

packages/commandkit/src/plugins/RuntimePlugin.ts

@@ -3,6 +3,7 @@ import { PluginCommon, PluginOptions } from './PluginCommon';
 import type { CommandKitPluginRuntime } from './runtime/CommandKitPluginRuntime';
 import { PreparedAppCommandExecution } from '../app';
 import { CommandKitEnvironment } from '../context/environment';
+import { CommandKitHMREvent } from '../utils/dev-hooks';
 
 export abstract class RuntimePlugin<
   T extends PluginOptions = PluginOptions,
@@ -106,6 +107,16 @@ export abstract class RuntimePlugin<
   public async onCommandsRouterInit(
     ctx: CommandKitPluginRuntime,
   ): Promise<void> {}
+
+  /**
+   * Called when HMR event is received
+   * @param ctx The context
+   * @param event The event
+   */
+  public async performHMR(
+    ctx: CommandKitPluginRuntime,
+    event: CommandKitHMREvent,
+  ): Promise<void> {}
 }
 
 export function isRuntimePlugin(plugin: unknown): plugin is RuntimePlugin {

packages/commandkit/src/utils/dev-hooks.ts

@@ -4,13 +4,20 @@ import { COMMANDKIT_IS_DEV } from './constants';
 
 interface IpcMessageCommand {
   event: string;
-  path?: string;
+  path: string;
+}
+
+export interface CommandKitHMREvent {
+  event: string;
+  path: string;
+  accept: () => void;
+  preventDefault: () => void;
 }
 
 export function registerDevHooks(commandkit: CommandKit) {
   if (!COMMANDKIT_IS_DEV) return;
 
-  process.on('message', (message) => {
+  process.on('message', async (message) => {
     if (typeof message !== 'object' || message === null) return;
 
     const { event, path } = message as IpcMessageCommand;
@@ -20,6 +27,29 @@ export function registerDevHooks(commandkit: CommandKit) {
       Logger.info(`Received HMR event: ${event}${path ? ` for ${path}` : ''}`);
     }
 
+    let accepted = false,
+      prevented = false;
+
+    const hmrEvent: CommandKitHMREvent = {
+      accept() {
+        accepted = true;
+      },
+      preventDefault() {
+        prevented = false;
+      },
+      path,
+      event,
+    };
+
+    await commandkit.plugins.execute(async (ctx, plugin) => {
+      // some plugin accepted the event
+      if (accepted) return;
+      await plugin.performHMR?.(ctx, hmrEvent);
+    });
+
+    // plugin took care of it
+    if (prevented) return;
+
     switch (event) {
       case 'reload-commands':
         commandkit.commandHandler.reloadCommands();