|
| 1 | +import * as path from 'path' |
| 2 | +import * as fs from 'fs' |
| 3 | +import { it, describe, expect, vi, afterEach, Mock, beforeAll } from 'vitest' |
| 4 | +import { build, toArray, webpackVersion } from '../utils' |
| 5 | +import { createUnplugin, UnpluginOptions, VitePlugin } from 'unplugin' |
| 6 | + |
| 7 | +function createUnpluginWithCallback (writeBundleCallback: UnpluginOptions['writeBundle']) { |
| 8 | + return createUnplugin(() => ({ |
| 9 | + name: 'test-plugin', |
| 10 | + writeBundle: writeBundleCallback |
| 11 | + })) |
| 12 | +} |
| 13 | + |
| 14 | +function generateMockWriteBundleHook (outputPath: string) { |
| 15 | + return () => { |
| 16 | + // We want to check that at the time the `writeBundle` hook is called, all |
| 17 | + // build-artifacts have already been written to disk. |
| 18 | + |
| 19 | + const bundleExists = fs.existsSync(path.join(outputPath, 'output.js')) |
| 20 | + const sourceMapExists = fs.existsSync(path.join(outputPath, 'output.js.map')) |
| 21 | + |
| 22 | + expect(bundleExists).toBe(true) |
| 23 | + expect(sourceMapExists).toBe(true) |
| 24 | + |
| 25 | + return undefined |
| 26 | + } |
| 27 | +} |
| 28 | + |
| 29 | +// We extract this check because all bundlers should behave the same |
| 30 | +function checkWriteBundleHook (writeBundleCallback: Mock): void { |
| 31 | + expect(writeBundleCallback).toHaveBeenCalledOnce() |
| 32 | +} |
| 33 | + |
| 34 | +describe('writeBundle hook', () => { |
| 35 | + beforeAll(() => { |
| 36 | + fs.rmSync(path.resolve(__dirname, 'test-out'), { recursive: true, force: true }) |
| 37 | + }) |
| 38 | + |
| 39 | + afterEach(() => { |
| 40 | + vi.restoreAllMocks() |
| 41 | + }) |
| 42 | + |
| 43 | + it('vite', async () => { |
| 44 | + expect.assertions(3) |
| 45 | + const mockWriteBundleHook = vi.fn(generateMockWriteBundleHook(path.resolve(__dirname, 'test-out/vite'))) |
| 46 | + const plugin = createUnpluginWithCallback(mockWriteBundleHook).vite |
| 47 | + // we need to define `enforce` here for the plugin to be run |
| 48 | + const plugins = toArray(plugin()).map((plugin): VitePlugin => ({ ...plugin, enforce: 'pre' })) |
| 49 | + |
| 50 | + await build.vite({ |
| 51 | + clearScreen: false, |
| 52 | + plugins: [plugins], |
| 53 | + build: { |
| 54 | + lib: { |
| 55 | + entry: path.resolve(__dirname, 'test-src/entry.js'), |
| 56 | + name: 'TestLib', |
| 57 | + fileName: 'output', |
| 58 | + formats: ['cjs'] |
| 59 | + }, |
| 60 | + outDir: path.resolve(__dirname, 'test-out/vite'), |
| 61 | + sourcemap: true |
| 62 | + } |
| 63 | + }) |
| 64 | + |
| 65 | + checkWriteBundleHook(mockWriteBundleHook) |
| 66 | + }) |
| 67 | + |
| 68 | + it('rollup', async () => { |
| 69 | + expect.assertions(3) |
| 70 | + const mockResolveIdHook = vi.fn(generateMockWriteBundleHook(path.resolve(__dirname, 'test-out/rollup'))) |
| 71 | + const plugin = createUnpluginWithCallback(mockResolveIdHook).rollup |
| 72 | + |
| 73 | + const rollupBuild = await build.rollup({ |
| 74 | + input: path.resolve(__dirname, 'test-src/entry.js') |
| 75 | + }) |
| 76 | + |
| 77 | + await rollupBuild.write({ |
| 78 | + plugins: [plugin()], |
| 79 | + file: path.resolve(__dirname, 'test-out/rollup/output.js'), |
| 80 | + format: 'cjs', |
| 81 | + exports: 'named', |
| 82 | + sourcemap: true |
| 83 | + }) |
| 84 | + |
| 85 | + checkWriteBundleHook(mockResolveIdHook) |
| 86 | + }) |
| 87 | + |
| 88 | + it('webpack', async () => { |
| 89 | + expect.assertions(3) |
| 90 | + const mockResolveIdHook = vi.fn(generateMockWriteBundleHook(path.resolve(__dirname, 'test-out/webpack'))) |
| 91 | + const plugin = createUnpluginWithCallback(mockResolveIdHook).webpack |
| 92 | + |
| 93 | + const webpack4Options = { |
| 94 | + entry: path.resolve(__dirname, 'test-src/entry.js'), |
| 95 | + cache: false, |
| 96 | + output: { |
| 97 | + path: path.resolve(__dirname, 'test-out/webpack'), |
| 98 | + filename: 'output.js', |
| 99 | + libraryTarget: 'commonjs' |
| 100 | + }, |
| 101 | + plugins: [plugin()], |
| 102 | + devtool: 'source-map' |
| 103 | + } |
| 104 | + |
| 105 | + const webpack5Options = { |
| 106 | + entry: path.resolve(__dirname, 'test-src/entry.js'), |
| 107 | + plugins: [plugin()], |
| 108 | + devtool: 'source-map', |
| 109 | + output: { |
| 110 | + path: path.resolve(__dirname, 'test-out/webpack'), |
| 111 | + filename: 'output.js', |
| 112 | + library: { |
| 113 | + type: 'commonjs' |
| 114 | + } |
| 115 | + } |
| 116 | + } |
| 117 | + |
| 118 | + await new Promise((resolve) => { |
| 119 | + build.webpack(webpackVersion!.startsWith('4') ? webpack4Options : webpack5Options, |
| 120 | + resolve |
| 121 | + ) |
| 122 | + }) |
| 123 | + |
| 124 | + checkWriteBundleHook(mockResolveIdHook) |
| 125 | + }) |
| 126 | + |
| 127 | + it('esbuild', async () => { |
| 128 | + expect.assertions(3) |
| 129 | + const mockResolveIdHook = vi.fn(generateMockWriteBundleHook(path.resolve(__dirname, 'test-out/esbuild'))) |
| 130 | + const plugin = createUnpluginWithCallback(mockResolveIdHook).esbuild |
| 131 | + |
| 132 | + await build.esbuild({ |
| 133 | + entryPoints: [path.resolve(__dirname, 'test-src/entry.js')], |
| 134 | + plugins: [plugin()], |
| 135 | + bundle: true, // actually traverse imports |
| 136 | + outfile: path.resolve(__dirname, 'test-out/esbuild/output.js'), |
| 137 | + format: 'cjs', |
| 138 | + sourcemap: true |
| 139 | + }) |
| 140 | + |
| 141 | + checkWriteBundleHook(mockResolveIdHook) |
| 142 | + }) |
| 143 | +}) |
0 commit comments