feat: compose addon hooks (#2007)

ikkz · web-flow · commit 08b6360b6e9e · 2024-08-18T08:12:12.000Z
resolves #1999
diff --git a/packages/rolldown/src/utils/compose-js-plugins.ts b/packages/rolldown/src/utils/compose-js-plugins.ts
@@ -9,8 +9,6 @@ import { AssertNever } from './type-assert'
 
 const unsupportedHookName = [
   'augmentChunkHash',
-  'banner',
-  'footer',
   'generateBundle',
   'moduleParsed',
   'onLog',
@@ -23,8 +21,6 @@ const unsupportedHookName = [
   // FIXME: Conflict with the `skip` option in `PluginContext#resolve`. Since we can't detect it in advance,
   // we have to bailout all plugins with `resolveId` hook.
   'resolveId',
-  'intro',
-  'outro',
 ] as const
 const unsupportedHooks: Set<string> = new Set(unsupportedHookName)
 
@@ -108,6 +104,16 @@ function createComposedPlugin(plugins: Plugin[]): Plugin {
           }
           break
         }
+        case 'banner':
+        case 'footer':
+        case 'intro':
+        case 'outro': {
+          const hook = plugin[pluginProp]
+          if (hook) {
+            ;(batchedHooks[pluginProp] ??= []).push(hook)
+          }
+          break
+        }
         default: {
           // All known hooks should be handled above.
           // User-defined custom properties will hit this branch and it's ok. Just ignore them.
@@ -236,6 +242,29 @@ function createComposedPlugin(plugins: Plugin[]): Plugin {
         }
         break
       }
+      case 'banner':
+      case 'footer':
+      case 'intro':
+      case 'outro': {
+        const hooks = batchedHooks[hookName]
+        if (hooks?.length) {
+          composed[hookName] = async function (chunk) {
+            const ret: string[] = []
+            for (const hook of hooks) {
+              {
+                const { handler } = normalizeHook(hook)
+                ret.push(
+                  typeof handler === 'string'
+                    ? handler
+                    : await handler.call(this, chunk),
+                )
+              }
+            }
+            return ret.join('\n')
+          }
+        }
+        break
+      }
       default: {
         // Supported hooks should be handled above, otherwise it should be filtered out in the beginning.
         type _ExhaustiveCheck = AssertNever<typeof hookName>
diff --git a/packages/rolldown/tests/compose-plugins.test.ts b/packages/rolldown/tests/compose-plugins.test.ts
@@ -20,4 +20,43 @@ describe('compose-plugins', () => {
     const composed = composePlugins(plugins)
     expect(composed.length).toBe(1)
   })
+
+  it('should compose `banner`, `footer`, `intro`, `outro` hooks', () => {
+    const plugins: Plugin[] = [
+      {
+        name: 'test-plugin-1',
+        banner: '/*banner1*/',
+      },
+      {
+        name: 'test-plugin-2',
+        banner: () => '/*banner2*/',
+      },
+      {
+        name: 'test-plugin-3',
+        footer: '/*footer1*/',
+      },
+      {
+        name: 'test-plugin-4',
+        footer: () => '/*footer2*/',
+      },
+      {
+        name: 'test-plugin-5',
+        intro: '/*intro1*/',
+      },
+      {
+        name: 'test-plugin-6',
+        intro: () => '/*intro2*/',
+      },
+      {
+        name: 'test-plugin-7',
+        outro: '/*outro1*/',
+      },
+      {
+        name: 'test-plugin-8',
+        outro: () => '/*outro2*/',
+      },
+    ]
+    const composed = composePlugins(plugins)
+    expect(composed.length).toBe(1)
+  })
 })
diff --git a/packages/rolldown/tests/fixtures/plugin/multi-addon/_config.ts b/packages/rolldown/tests/fixtures/plugin/multi-addon/_config.ts
@@ -0,0 +1,51 @@
+import { expect } from 'vitest'
+import path from 'node:path'
+import { defineTest } from '@tests'
+
+const entry = path.join(__dirname, './main.js')
+
+export default defineTest({
+  config: {
+    input: entry,
+    plugins: [
+      {
+        name: 'test-plugin-1',
+        banner: '/*banner1*/',
+      },
+      {
+        name: 'test-plugin-2',
+        banner: () => '/*banner2*/',
+      },
+      {
+        name: 'test-plugin-3',
+        footer: '/*footer1*/',
+      },
+      {
+        name: 'test-plugin-4',
+        footer: () => '/*footer2*/',
+      },
+      {
+        name: 'test-plugin-5',
+        intro: '/*intro1*/',
+      },
+      {
+        name: 'test-plugin-6',
+        intro: () => '/*intro2*/',
+      },
+      {
+        name: 'test-plugin-7',
+        outro: '/*outro1*/',
+      },
+      {
+        name: 'test-plugin-8',
+        outro: () => '/*outro2*/',
+      },
+    ],
+  },
+  afterTest: (output) => {
+    expect(output.output[0].code).toMatch(/\/\*banner1\*\/\n\/\*banner2\*\//)
+    expect(output.output[0].code).toMatch(/\/\*footer1\*\/\n\/\*footer2\*\//)
+    expect(output.output[0].code).toMatch(/\/\*intro1\*\/\n\/\*intro2\*\//)
+    expect(output.output[0].code).toMatch(/\/\*outro1\*\/\n\/\*outro2\*\//)
+  },
+})
diff --git a/packages/rolldown/tests/fixtures/plugin/multi-addon/main.js b/packages/rolldown/tests/fixtures/plugin/multi-addon/main.js
@@ -0,0 +1 @@
+console.log()
