feat: [v2] add "startup" hook to plugins (#411)

Author: stevenle

.changeset/twelve-months-explain.md

@@ -0,0 +1,5 @@
+---
+'@blinkk/root': patch
+---
+
+feat: [v2] add "startup" hook to plugins

packages/root/src/cli/build.ts

@@ -82,6 +82,14 @@ export async function build(rootProjectDir?: string, options?: BuildOptions) {
   }
 
   const rootPlugins = rootConfig.plugins || [];
+
+  // Run any "startup" hooks.
+  for (const plugin of rootPlugins) {
+    if (typeof plugin.hooks?.startup === 'function') {
+      await plugin.hooks.startup({command: 'build', rootConfig});
+    }
+  }
+
   const viteConfig = rootConfig.vite || {};
   const vitePlugins = [
     ...(viteConfig.plugins || []),

packages/root/src/cli/dev.ts

@@ -126,6 +126,13 @@ export async function createDevServer(options?: {
     {type: 'dev', rootConfig}
   );
 
+  // Run any "startup" hooks.
+  for (const plugin of plugins) {
+    if (typeof plugin.hooks?.startup === 'function') {
+      await plugin.hooks.startup({command: 'dev', rootConfig});
+    }
+  }
+
   return server;
 }
 

packages/root/src/cli/preview.ts

@@ -113,6 +113,14 @@ export async function createPreviewServer(options: {
     plugins,
     {type: 'preview', rootConfig}
   );
+
+  // Run any "startup" hooks.
+  for (const plugin of plugins) {
+    if (typeof plugin.hooks?.startup === 'function') {
+      await plugin.hooks.startup({command: 'preview', rootConfig});
+    }
+  }
+
   return server;
 }
 

packages/root/src/cli/start.ts

@@ -108,6 +108,14 @@ export async function createProdServer(options: {
     plugins,
     {type: 'prod', rootConfig}
   );
+
+  // Run any "startup" hooks.
+  for (const plugin of plugins) {
+    if (typeof plugin.hooks?.startup === 'function') {
+      await plugin.hooks.startup({command: 'start', rootConfig});
+    }
+  }
+
   return server;
 }
 

packages/root/src/core/plugin.ts

@@ -15,12 +15,20 @@ export interface ConfigureServerOptions {
 }
 
 export interface PluginHooks {
+  /**
+   * Startup hook called when root is initialized.
+   */
+  startup?: (options: {
+    command: string;
+    rootConfig: RootConfig;
+  }) => void | Promise<void>;
+
   /**
    * Post-render hook that's called before the HTML is rendered to the response
    * object. If a string is returned from this hook, it will replace the
    * rendered HTML.
    */
-  preRender: (html: string) => void | string | Promise<string>;
+  preRender?: (html: string) => void | string | Promise<string>;
 }
 
 export interface Plugin {