feat: nitro app plugins

README.md

@@ -203,6 +203,34 @@ export default definenitroConfig({
 
 All assets in `public/` directory will be automatically served.
 
+## Nitro plugins
+
+In order to extend nitro's runtime behavior, we can register plugins.
+
+They will be synchronously on first nitro initialization given `nitroApp` context which can be used to hook into lifecycle events.
+
+**Example:** Simple plugin
+
+```js
+// plugins/test.ts
+import { defineNitroPlugin } from '#nitro'
+
+export default defineNitroPlugin((nitroApp) => {
+  console.log('Nitro plugin', nitroApp)
+})
+```
+
+```js
+// nitro.config.ts
+import { definenitroConfig } from 'nitropack'
+
+export default definenitroConfig({
+  plugins: [
+    '~/plugins/test'
+  ]
+})
+```
+
 ## Deployment Presets
 
 Currently supported presets:
@@ -353,6 +381,12 @@ Watch options for development mode. See [chokidar](https://github.com/paulmillr/
 
 Auto import options. See [unjs/unimport](https://github.com/unjs/unimport) for more information.
 
+#### `plugins`
+
+- Default: `[]`
+
+Array of paths to nitro plugins. They will be executed by order on first initialization.
+
 ### Routing
 
 #### `baseURL`

playground/nitro.config.ts

@@ -8,5 +8,8 @@ export default defineNitroConfig({
   // baseURL: '/app',
   routes: {
     '/api/swr': { swr: true }
-  }
+  },
+  plugins: [
+    '~/plugins/test'
+  ]
 })

playground/plugins/test.ts

@@ -0,0 +1,5 @@
+import { defineNitroPlugin } from '#nitro'
+
+export default defineNitroPlugin((_nitroApp) => {
+  console.log('Nitro plugin!')
+})

src/imports.ts

@@ -8,7 +8,9 @@ export const nitroImports: Preset[] = [
       'defineCachedEventHandler',
       'useConfig',
       'useStorage',
-      'useNitroApp'
+      'useNitroApp',
+      'defineNitroPlugin',
+      'nitroPlugin'
     ]
   },
   {

src/options.ts

@@ -30,6 +30,7 @@ const NitroDefaults: NitroConfig = {
   storage: {},
   publicAssets: [],
   serverAssets: [],
+  plugins: [],
   autoImport: {
     presets: nitroImports
   },

src/rollup/config.ts

@@ -17,6 +17,7 @@ import * as unenv from 'unenv'
 import type { Preset } from 'unenv'
 import { sanitizeFilePath } from 'mlly'
 import unimportPlugin from 'unimport/unplugin'
+import { hash } from 'ohash'
 import type { Nitro } from '../types'
 import { resolveAliases } from '../utils'
 import { runtimeDir } from '../dirs'
@@ -205,6 +206,17 @@ export const getRollupConfig = (nitro: Nitro) => {
     '#polyfill': env.polyfill.map(p => `import '${p}';`).join('\n')
   }))
 
+  // Plugins
+  rollupConfig.plugins.push(virtual({
+    '#nitro/virtual/plugins': `
+${nitro.options.plugins.map(plugin => `import _${hash(plugin)} from '${plugin}';`).join('\n')}
+
+export const plugins = [
+  ${nitro.options.plugins.map(plugin => `_${hash(plugin)}`).join(',\n')}
+]
+    `
+  }))
+
   // https://github.com/rollup/plugins/tree/master/packages/alias
   rollupConfig.plugins.push(alias({
     entries: resolveAliases({

src/runtime/app.ts

@@ -7,6 +7,7 @@ import { createHooks, Hookable } from 'hookable'
 import { useConfig } from './config'
 import { timingMiddleware } from './timing'
 import { cachedEventHandler } from './cache'
+import { plugins } from '#nitro/virtual/plugins'
 import handleError from '#nitro/error'
 import { handlers } from '#nitro/virtual/server-handlers'
 
@@ -59,12 +60,18 @@ function createNitroApp (): NitroApp {
   const $fetch = createFetch({ fetch: localFetch, Headers })
   globalThis.$fetch = $fetch
 
-  return {
+  const app: NitroApp = {
     hooks,
     h3App,
     localCall,
     localFetch
   }
+
+  for (const plugin of plugins) {
+    plugin(app)
+  }
+
+  return app
 }
 
 export const nitroApp: NitroApp = createNitroApp()

src/runtime/index.ts

@@ -2,3 +2,4 @@ export { useStorage } from '#nitro/virtual/storage'
 export { useConfig } from './config'
 export { defineCachedFunction, defineCachedEventHandler } from './cache'
 export { useNitroApp } from './app'
+export * from './plugin'

src/runtime/plugin.ts

@@ -0,0 +1,11 @@
+import type { NitroApp } from './app'
+
+export interface NitroAppPlugin {
+  (nitro: NitroApp): void
+}
+
+export function defineNitroPlugin (def: NitroAppPlugin) {
+  return def
+}
+
+export const nitroPlugin = defineNitroPlugin

src/runtime/virtual/plugins.d.ts

@@ -0,0 +1,3 @@
+import type { NitroAppPlugin } from '../plugin'
+
+export const plugins: NitroAppPlugin[] = []

src/types/nitro.ts

@@ -101,6 +101,7 @@ export interface NitroOptions {
   serverAssets: ServerAssetDir[]
   publicAssets: PublicAssetDir[]
   autoImport: UnimportOptions
+  plugins: string[]
 
   // Dev
   dev: boolean