webpack-livereload-plugin触发MainTemplate.hooks.startup报错求助
React与Express联调项目webpack运行报错解决方案
跟随教程学习React与后端联调开发,完成服务端中间件配置后,运行项目始终触发报错,自主排查未解决。
完整报错堆栈
C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\MainTemplate.js:100 throw new Error( ^ Error: MainTemplate.hooks.startup has been removed (use RuntimeGlobals.startup instead) at Object.tap (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\MainTemplate.js:100:12) at LiveReloadPlugin.applyCompilation (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack-livereload-plugin\index.js:164:42) at Hook.eval (eval at create (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\node_modules\tapable\lib\HookCodeFactory.js:19:10), <anonymous>:100:1) at Hook.CALL_DELEGATE [as _call] (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\node_modules\tapable\lib\Hook.js:14:14) at Compiler.newCompilation (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\Compiler.js:993:26) at C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\Compiler.js:1035:29) at Hook.eval [as callAsync] (eval at create (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\node_modules\tapable\lib\HookCodeFactory.js:33:10), <anonymous>:6:1) at Hook.CALL_ASYNC_DELEGATE [as _callAsync] (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\node_modules\tapable\lib\Hook.js:18:14) at Compiler.compile (C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\Compiler.js:1030:28) at C:\Users\Danjos02\Desktop\Cursos\React-Curso\react-node-project\node_modules\webpack\lib\Watching.js:112:19
已开展的排查操作
- 替换为教程配套的原始webpack配置文件,报错仍未消除
- 初步判断问题非业务代码层面导致
- 刚接触当前技术栈,暂无法定位问题根因
- 查阅资料判断,报错大概率来自
webpack-livereload-plugin插件的版本兼容问题,尚未找到有效修复方案
项目核心配置
webpack.config.js
import webpack from 'webpack'; import htmlWebpackPlugin from 'html-webpack-plugin'; import LiveReloadPlugin from 'webpack-livereload-plugin'; export default { entry: './src/client/index.js', output: { path: '/', filename: 'bundle.js' }, module: { rules: [ { use: 'babel-loader', test: /\.js$/, exclude: /node_modules/ }, { use: ['style-loader', 'css-loader'], test: /\.css$/ }, { test: /\.scss$/, use: [ { loader: 'style-loader' }, { loader: 'css-loader', options: { sourceMap: true } }, { loader: 'sass-loader', options: { sourceMap: true } } ] } ] }, plugins: [ new htmlWebpackPlugin({ template: 'src/client/index.html' }), new LiveReloadPlugin() ] }
server.js
import express from 'express'; import webpack from 'webpack'; import webpackDevMiddleware from 'webpack-dev-middleware'; import webpackConfig from '../webpack.config'; // initializing packages const app = express(); // settings app.set('port', process.env.PORT || 3000); // middlwares app.use(webpackDevMiddleware(webpack(webpackConfig))); // routes app.get('/', (req, res) => { res.send('Hello World'); }); app.get('/api', (req, res) => { res.json({api: 'works!'}); }); // starting the server app.listen(app.get('port'), () => { console.log(`Server on port ${app.get('port')}`); });
问题根因与修复方案
根因:项目所用的webpack-livereload-plugin旧版本仅适配webpack 4,与当前项目安装的webpack 5不兼容。webpack 5已彻底移除MainTemplate.hooks.startup旧API,插件调用不存在的API时就会直接抛出运行时错误。
修复按以下步骤操作即可:
- 第一步:对齐依赖版本,二选一执行:
- 保留当前webpack 5环境,执行安装命令升级livereload插件至兼容版本:
npm install webpack-livereload-plugin@latest --save-dev - 匹配旧教程的运行环境,执行安装命令统一替换为webpack 4生态的依赖包:
npm install webpack@4 webpack-dev-middleware@4 html-webpack-plugin@4 webpack-livereload-plugin@3 --save-dev
- 保留当前webpack 5环境,执行安装命令升级livereload插件至兼容版本:
- 第二步:修正webpack输出配置。当前配置里的
output.path直接写了根目录/,在Windows系统下会指向磁盘根目录,很容易触发权限报错,需要改成项目下的dist目录,引入path模块做绝对路径解析:import path from 'path'; // ... output: { path: path.resolve(__dirname, 'dist'), filename: 'bundle.js', publicPath: '/' } - 第三步:修正服务端中间件配置。当前server.js里仅挂载了
webpack-dev-middleware,没有传入稳定的编译器实例,也没有开启文件监听配置,livereload插件无法正常触发刷新逻辑,修改为以下结构:// 初始化webpack编译器实例 const compiler = webpack(webpackConfig); app.use(webpackDevMiddleware(compiler, { publicPath: webpackConfig.output.publicPath, watchOptions: { aggregateTimeout: 300, poll: 1000 } })); - 第四步:清理缓存重新安装。修改完成后删除项目下的
node_modules文件夹和package-lock.json文件,重新执行npm install安装依赖,再启动服务即可。
注意:配套教程的代码通常对应固定版本的依赖包,不要随意安装最新版依赖,否则极易出现版本不兼容问题。安装依赖前可以先对照教程提供的package.json文件,对齐核心工具包的版本号。
内容的提问来源于stack exchange,提问作者DansFuture
相关产品推荐
相关产品推荐

