123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367 |
- const { validate: validateOptions } = require('schema-utils');
- const { getRefreshGlobalScope, getWebpackVersion } = require('./globals');
- const {
- getAdditionalEntries,
- getIntegrationEntry,
- getRefreshGlobal,
- getSocketIntegration,
- injectRefreshEntry,
- injectRefreshLoader,
- makeRefreshRuntimeModule,
- normalizeOptions,
- } = require('./utils');
- const schema = require('./options.json');
- class ReactRefreshPlugin {
-
- constructor(options = {}) {
- validateOptions(schema, options, {
- name: 'React Refresh Plugin',
- baseDataPath: 'options',
- });
-
- this.options = normalizeOptions(options);
- }
-
- apply(compiler) {
-
- if (
-
-
- (compiler.options.mode !== 'development' ||
-
-
- (process.env.NODE_ENV && process.env.NODE_ENV === 'production')) &&
- !this.options.forceEnable
- ) {
- return;
- }
- const webpackVersion = getWebpackVersion(compiler);
- const logger = compiler.getInfrastructureLogger(this.constructor.name);
-
-
- const webpack = compiler.webpack || require('webpack');
- const {
- DefinePlugin,
- EntryDependency,
- EntryPlugin,
- ModuleFilenameHelpers,
- NormalModule,
- ProvidePlugin,
- RuntimeGlobals,
- Template,
- } = webpack;
-
-
-
- const addEntries = getAdditionalEntries({
- devServer: compiler.options.devServer,
- options: this.options,
- });
- if (EntryPlugin) {
-
-
- addEntries.prependEntries.forEach((entry) => {
- new EntryPlugin(compiler.context, entry, { name: undefined }).apply(compiler);
- });
- const integrationEntry = getIntegrationEntry(this.options.overlay.sockIntegration);
- const socketEntryData = [];
- compiler.hooks.make.tap(
- { name: this.constructor.name, stage: Number.POSITIVE_INFINITY },
- (compilation) => {
-
-
- for (const [name, entryData] of compilation.entries.entries()) {
- const index = entryData.dependencies.findIndex(
- (dep) => dep.request && dep.request.includes(integrationEntry)
- );
- if (index !== -1) {
- socketEntryData.push({ name, index });
- }
- }
- }
- );
-
-
-
- addEntries.overlayEntries.forEach((entry, idx, arr) => {
- compiler.hooks.finishMake.tapPromise(
- { name: this.constructor.name, stage: Number.MIN_SAFE_INTEGER + (arr.length - idx - 1) },
- (compilation) => {
-
- if (compilation.compiler !== compiler) {
- return Promise.resolve();
- }
- const injectData = socketEntryData.length ? socketEntryData : [{ name: undefined }];
- return Promise.all(
- injectData.map(({ name, index }) => {
- return new Promise((resolve, reject) => {
- const options = { name };
- const dep = EntryPlugin.createDependency(entry, options);
- compilation.addEntry(compiler.context, dep, options, (err) => {
- if (err) return reject(err);
-
-
-
-
- if (name && typeof index !== 'undefined') {
- const entryData = compilation.entries.get(name);
- entryData.dependencies.splice(
- index + 1,
- 0,
- entryData.dependencies.splice(entryData.dependencies.length - 1, 1)[0]
- );
- }
- resolve();
- });
- });
- })
- ).then(() => {});
- }
- );
- });
- } else {
- compiler.options.entry = injectRefreshEntry(compiler.options.entry, addEntries);
- }
-
- const refreshGlobal = getRefreshGlobalScope(RuntimeGlobals || {});
-
- const definedModules = {
-
- $RefreshReg$: `${refreshGlobal}.register`,
- $RefreshSig$: `${refreshGlobal}.signature`,
- 'typeof $RefreshReg$': 'function',
- 'typeof $RefreshSig$': 'function',
-
- __react_refresh_library__: JSON.stringify(
- Template.toIdentifier(
- this.options.library ||
- compiler.options.output.uniqueName ||
- compiler.options.output.library
- )
- ),
- };
-
- const providedModules = {
- __react_refresh_utils__: require.resolve('./runtime/RefreshUtils'),
- };
- if (this.options.overlay === false) {
-
- definedModules.__react_refresh_error_overlay__ = false;
- definedModules.__react_refresh_polyfill_url__ = false;
- definedModules.__react_refresh_socket__ = false;
- } else {
- definedModules.__react_refresh_polyfill_url__ = this.options.overlay.useURLPolyfill || false;
- if (this.options.overlay.module) {
- providedModules.__react_refresh_error_overlay__ = require.resolve(
- this.options.overlay.module
- );
- }
- if (this.options.overlay.sockIntegration) {
- providedModules.__react_refresh_socket__ = getSocketIntegration(
- this.options.overlay.sockIntegration
- );
- }
- }
- new DefinePlugin(definedModules).apply(compiler);
- new ProvidePlugin(providedModules).apply(compiler);
- const match = ModuleFilenameHelpers.matchObject.bind(undefined, this.options);
- let loggedHotWarning = false;
- compiler.hooks.compilation.tap(
- this.constructor.name,
- (compilation, { normalModuleFactory }) => {
-
- if (compilation.compiler !== compiler) {
- return;
- }
-
- switch (webpackVersion) {
- case 4: {
- const outputOptions = compilation.mainTemplate.outputOptions;
- compilation.mainTemplate.hooks.require.tap(
- this.constructor.name,
-
- (source, chunk, hash) => {
-
-
- let filename = outputOptions.filename;
- if (typeof filename === 'function') {
-
-
-
- filename = filename({
- contentHashType: 'javascript',
- chunk,
- hash,
- });
- }
-
-
-
-
-
- if (!filename || !filename.includes('.js')) {
- return source;
- }
-
- const lines = source.split('\n');
-
- const moduleInitializationLineNumber = lines.findIndex((line) =>
- line.includes('modules[moduleId].call(')
- );
-
-
-
- if (moduleInitializationLineNumber === -1) {
- return source;
- }
- const moduleInterceptor = Template.asString([
- `${refreshGlobal}.setup(moduleId);`,
- 'try {',
- Template.indent(lines[moduleInitializationLineNumber]),
- '} finally {',
- Template.indent(`${refreshGlobal}.cleanup(moduleId);`),
- '}',
- ]);
- return Template.asString([
- ...lines.slice(0, moduleInitializationLineNumber),
- '',
- outputOptions.strictModuleExceptionHandling
- ? Template.indent(moduleInterceptor)
- : moduleInterceptor,
- '',
- ...lines.slice(moduleInitializationLineNumber + 1, lines.length),
- ]);
- }
- );
- compilation.mainTemplate.hooks.requireExtensions.tap(
- this.constructor.name,
-
- (source) => {
- return Template.asString([source, '', getRefreshGlobal(Template)]);
- }
- );
- normalModuleFactory.hooks.afterResolve.tap(
- this.constructor.name,
-
- (data) => {
- return injectRefreshLoader(data, {
- match,
- options: { const: false, esModule: false },
- });
- }
- );
- compilation.hooks.normalModuleLoader.tap(
-
- { name: this.constructor.name, stage: Number.POSITIVE_INFINITY },
-
-
- (context) => {
- if (!context.hot && !loggedHotWarning) {
- logger.warn(
- [
- 'Hot Module Replacement (HMR) is not enabled!',
- 'React Refresh requires HMR to function properly.',
- ].join(' ')
- );
- loggedHotWarning = true;
- }
- }
- );
- break;
- }
- case 5: {
-
- compilation.dependencyFactories.set(EntryDependency, normalModuleFactory);
- const ReactRefreshRuntimeModule = makeRefreshRuntimeModule(webpack);
- compilation.hooks.additionalTreeRuntimeRequirements.tap(
- this.constructor.name,
-
- (chunk, runtimeRequirements) => {
- runtimeRequirements.add(RuntimeGlobals.interceptModuleExecution);
- runtimeRequirements.add(RuntimeGlobals.moduleCache);
- runtimeRequirements.add(refreshGlobal);
- compilation.addRuntimeModule(chunk, new ReactRefreshRuntimeModule());
- }
- );
- normalModuleFactory.hooks.afterResolve.tap(
- this.constructor.name,
-
- (resolveData) => {
- injectRefreshLoader(resolveData.createData, {
- match,
- options: {
- const: compilation.runtimeTemplate.supportsConst(),
- esModule: this.options.esModule,
- },
- });
- }
- );
- NormalModule.getCompilationHooks(compilation).loader.tap(
-
- { name: this.constructor.name, stage: Infinity },
-
-
- (context) => {
- if (!context.hot && !loggedHotWarning) {
- logger.warn(
- [
- 'Hot Module Replacement (HMR) is not enabled!',
- 'React Refresh requires HMR to function properly.',
- ].join(' ')
- );
- loggedHotWarning = true;
- }
- }
- );
- break;
- }
- default: {
-
- }
- }
- }
- );
- }
- }
- module.exports.ReactRefreshPlugin = ReactRefreshPlugin;
- module.exports = ReactRefreshPlugin;
|