|
| 1 | +import { createRequire } from 'node:module'; |
| 2 | +import { |
| 3 | + type RsbuildConfig, |
| 4 | + type RsbuildPlugin, |
| 5 | + type Rspack, |
| 6 | + rspack, |
| 7 | +} from '@rsbuild/core'; |
| 8 | +import { |
| 9 | + REACT_DIRECTIVE_REGEX, |
| 10 | + SHEBANG_PREFIX, |
| 11 | + SHEBANG_REGEX, |
| 12 | +} from '../constant'; |
| 13 | +import { importMetaUrlShim } from './shims'; |
| 14 | +const require = createRequire(import.meta.url); |
| 15 | + |
| 16 | +const PLUGIN_NAME = 'rsbuild:entry'; |
| 17 | + |
| 18 | +const matchFirstLine = (source: string, regex: RegExp) => { |
| 19 | + const [firstLine] = source.split('\n'); |
| 20 | + if (!firstLine) { |
| 21 | + return false; |
| 22 | + } |
| 23 | + const matched = regex.exec(firstLine); |
| 24 | + if (!matched) { |
| 25 | + return false; |
| 26 | + } |
| 27 | + |
| 28 | + return matched[0]; |
| 29 | +}; |
| 30 | + |
| 31 | +class PostEntryPlugin { |
| 32 | + private enabledImportMetaUrlShim: boolean; |
| 33 | + private shebangEntries: Record<string, string> = {}; |
| 34 | + private reactDirectives: Record<string, string> = {}; |
| 35 | + private importMetaUrlShims: Record<string, { startsWithUseStrict: boolean }> = |
| 36 | + {}; |
| 37 | + |
| 38 | + constructor({ |
| 39 | + importMetaUrlShim = true, |
| 40 | + }: { |
| 41 | + importMetaUrlShim: boolean; |
| 42 | + }) { |
| 43 | + this.enabledImportMetaUrlShim = importMetaUrlShim; |
| 44 | + } |
| 45 | + |
| 46 | + apply(compiler: Rspack.Compiler) { |
| 47 | + compiler.hooks.entryOption.tap(PLUGIN_NAME, (_context, entries) => { |
| 48 | + for (const name in entries) { |
| 49 | + const entry = (entries as Rspack.EntryStaticNormalized)[name]; |
| 50 | + if (!entry) continue; |
| 51 | + |
| 52 | + let first: string | undefined; |
| 53 | + if (Array.isArray(entry)) { |
| 54 | + first = entry[0]; |
| 55 | + } else if (Array.isArray(entry.import)) { |
| 56 | + first = entry.import[0]; |
| 57 | + } else if (typeof entry === 'string') { |
| 58 | + first = entry; |
| 59 | + } |
| 60 | + |
| 61 | + if (typeof first !== 'string') continue; |
| 62 | + |
| 63 | + const content = compiler.inputFileSystem!.readFileSync!( |
| 64 | + first.split('?')[0]!, |
| 65 | + { encoding: 'utf-8' }, |
| 66 | + ); |
| 67 | + |
| 68 | + // Shebang |
| 69 | + if (content.startsWith(SHEBANG_PREFIX)) { |
| 70 | + const shebangMatch = matchFirstLine(content, SHEBANG_REGEX); |
| 71 | + if (shebangMatch) { |
| 72 | + this.shebangEntries[name] = shebangMatch; |
| 73 | + } |
| 74 | + } |
| 75 | + |
| 76 | + // React directive |
| 77 | + const reactDirective = matchFirstLine(content, REACT_DIRECTIVE_REGEX); |
| 78 | + if (reactDirective) { |
| 79 | + this.reactDirectives[name] = reactDirective; |
| 80 | + } |
| 81 | + |
| 82 | + // import.meta.url shim |
| 83 | + if (this.enabledImportMetaUrlShim) { |
| 84 | + this.importMetaUrlShims[name] = { |
| 85 | + startsWithUseStrict: |
| 86 | + // This is a hypothesis that no comments will occur before "use strict;". |
| 87 | + // But it should cover most cases. |
| 88 | + content.startsWith('use strict;') || |
| 89 | + content.startsWith('"use strict";'), |
| 90 | + }; |
| 91 | + } |
| 92 | + } |
| 93 | + }); |
| 94 | + |
| 95 | + compiler.hooks.thisCompilation.tap(PLUGIN_NAME, (compilation) => { |
| 96 | + compilation.hooks.chunkAsset.tap(PLUGIN_NAME, (chunk, filename) => { |
| 97 | + const name = chunk.name; |
| 98 | + if (!name) return; |
| 99 | + |
| 100 | + const shebangEntry = this.shebangEntries[name]; |
| 101 | + if (shebangEntry) { |
| 102 | + this.shebangEntries[filename] = shebangEntry; |
| 103 | + } |
| 104 | + |
| 105 | + const reactDirective = this.reactDirectives[name]; |
| 106 | + if (reactDirective) { |
| 107 | + this.reactDirectives[filename] = reactDirective; |
| 108 | + } |
| 109 | + |
| 110 | + const importMetaUrlShimInfo = this.importMetaUrlShims[name]; |
| 111 | + if (importMetaUrlShimInfo) { |
| 112 | + this.importMetaUrlShims[filename] = importMetaUrlShimInfo; |
| 113 | + } |
| 114 | + }); |
| 115 | + }); |
| 116 | + |
| 117 | + compiler.hooks.make.tap(PLUGIN_NAME, (compilation) => { |
| 118 | + compilation.hooks.processAssets.tap(PLUGIN_NAME, (assets) => { |
| 119 | + const chunkAsset = Object.keys(assets); |
| 120 | + for (const name of chunkAsset) { |
| 121 | + if (this.enabledImportMetaUrlShim) { |
| 122 | + compilation.updateAsset(name, (old) => { |
| 123 | + const importMetaUrlShimInfo = this.importMetaUrlShims[name]; |
| 124 | + if (importMetaUrlShimInfo) { |
| 125 | + const replaceSource = new rspack.sources.ReplaceSource(old); |
| 126 | + |
| 127 | + if (importMetaUrlShimInfo.startsWithUseStrict) { |
| 128 | + replaceSource.replace( |
| 129 | + 0, |
| 130 | + 11, // 'use strict;'.length, |
| 131 | + `"use strict";\n${importMetaUrlShim}`, |
| 132 | + ); |
| 133 | + } else { |
| 134 | + replaceSource.insert(0, importMetaUrlShim); |
| 135 | + } |
| 136 | + |
| 137 | + return replaceSource; |
| 138 | + } |
| 139 | + |
| 140 | + return old; |
| 141 | + }); |
| 142 | + } |
| 143 | + } |
| 144 | + }); |
| 145 | + |
| 146 | + compilation.hooks.processAssets.tap( |
| 147 | + { |
| 148 | + name: PLUGIN_NAME, |
| 149 | + // Just after minify stage, to avoid from being minified. |
| 150 | + stage: rspack.Compilation.PROCESS_ASSETS_STAGE_OPTIMIZE_SIZE + 1, |
| 151 | + }, |
| 152 | + (assets) => { |
| 153 | + const chunkAsset = Object.keys(assets); |
| 154 | + for (const name of chunkAsset) { |
| 155 | + const shebangValue = this.shebangEntries[name]; |
| 156 | + const reactDirectiveValue = this.reactDirectives[name]; |
| 157 | + |
| 158 | + if (shebangValue || reactDirectiveValue) { |
| 159 | + compilation.updateAsset(name, (old) => { |
| 160 | + const replaceSource = new rspack.sources.ReplaceSource(old); |
| 161 | + // Shebang |
| 162 | + if (shebangValue) { |
| 163 | + replaceSource.insert(0, `${shebangValue}\n`); |
| 164 | + } |
| 165 | + |
| 166 | + // React directives |
| 167 | + if (reactDirectiveValue) { |
| 168 | + replaceSource.insert(0, `${reactDirectiveValue}\n`); |
| 169 | + } |
| 170 | + |
| 171 | + return replaceSource; |
| 172 | + }); |
| 173 | + } |
| 174 | + } |
| 175 | + }, |
| 176 | + ); |
| 177 | + }); |
| 178 | + } |
| 179 | +} |
| 180 | + |
| 181 | +const entryModuleLoaderPlugin = (): RsbuildPlugin => ({ |
| 182 | + name: PLUGIN_NAME, |
| 183 | + setup(api) { |
| 184 | + api.modifyBundlerChain((config, { CHAIN_ID }) => { |
| 185 | + const rule = config.module.rule(CHAIN_ID.RULE.JS); |
| 186 | + rule |
| 187 | + .use('shebang') |
| 188 | + .loader(require.resolve('./entryModuleLoader.js')) |
| 189 | + .options({}); |
| 190 | + }); |
| 191 | + }, |
| 192 | +}); |
| 193 | + |
| 194 | +export const composePostEntryChunkConfig = ({ |
| 195 | + importMetaUrlShim, |
| 196 | +}: { |
| 197 | + importMetaUrlShim: boolean; |
| 198 | +}): RsbuildConfig => { |
| 199 | + return { |
| 200 | + plugins: [entryModuleLoaderPlugin()], |
| 201 | + tools: { |
| 202 | + rspack: { |
| 203 | + plugins: [ |
| 204 | + new PostEntryPlugin({ |
| 205 | + importMetaUrlShim: importMetaUrlShim, |
| 206 | + }), |
| 207 | + ], |
| 208 | + }, |
| 209 | + }, |
| 210 | + }; |
| 211 | +}; |
0 commit comments