新安webpack插件后编译报错compiler.plugin is not a function

        安装使用generate-asset-webpack-plugin时报错TypeError:compiler.plugin is not a function,网上搜索了一下大概就是webpack5与这些插件不匹配。推荐的方法几乎都是换一个适配的插件版本,但我所需要的这个插件在npm上最近更新时间是7年前💔。等不着作者适配于是决定自己改。

  •  先看解决办法:主要也只是webpack升级后,触发钩子的写法变了而已

        找到报错的文件,搜索“compiler.plugin”定位到问题所在,修改写法(如下),打个补丁,提交一下✔️。

原先代码:

 compiler.plugin('emit', function (compilation, cb) {})

修改后:

  compiler.hooks.emit.tapAsync('GenerateAssetWebpackPlugin',(compilation,callback)=>{})

  •  在接触到问题之前对于webpack的使用仅在于配置代理服务器 😢 ,后面就大概记录一下修改的思考过程与新get到的知识点。【以下的“类似于”仅因为自己接触知识点的前后顺序,不在于本身发布前后顺序,我猜测wabpack肯定比vue早出现😂

🌷 看到compiler的时候还不知道这是个啥东西,怎么就调了一个plugin方法。在当前文件没搜到后就开始了百度之旅(刚开始还以为plugin是创作者自定义的)。然后就了解到webpack的CompilerCompilation 对象,个人理解Compiler粒度更大,类似于编译器实例,生命周期类似于APP的应用周期,整个生命周期只会执行一次(惨兮兮只有一条命)。

🌷 plugin是定义在webpack原型apply上的一个方法,用于调用webpack的钩子函数(类似于vue中mounted、created这种函数,会在特定的时间段进行调用),第一个参数为钩子函数名称,第二个参数为回调函数。关于钩子的种类及定义可查看文档compiler 钩子

 🌷 但在webpack5中,plugin方法被取消了!所以报错is not a function。输出一下complier对象也会发现无这个属性【具体complier有什么属性可以看看依赖里的这个文件node_modules\webpack\lib\Compiler.js

🌷 既然触发生命周期的方法变了,更新一下为最新版本的写法就好了。查看文档作出修改,至少问题就解决了~

  •  看一下源码部分,以便更好的理解(node_modules\webpack\lib\Compiler.js
  1. 在类中一开始就定义了一个不可修改的钩子函数集合hooks,所以会区分complier钩子与compilation钩子。毕竟complier和compilation是两个不同类
  2. 这里new的AsyncSeriesHook 又是什么​呢?字面意思是异步串行钩子,搜一下

      

 

 所以这里输出的这些函数都是tapable中的😮,具体看文档  tapable,简单过一下定义后就看看那个插件generate-asset-webpack-plugin吧。webpack太长了关于其什么阶段调用了什么钩子就等把webpack基础概念和原理补完再看👻

  • generate-asset-webpack-plugin

         这个代码挺少就看完了,查看官网自定义插件。自定义插件 | webpack 中文文档 | webpack 中文文档 | webpack 中文网

🧩 一个 JavaScript 命名函数或 JavaScript 类。

🧩 在插件函数的 prototype 上定义一个 apply 方法。

🧩 指定一个绑定到 webpack 自身的事件钩子。【这里就是指定的emit钩子

🧩 处理 webpack 内部实例的特定数据。【使用fs模块处理的

🧩 功能完成后调用 webpack 提供的回调。【callback结束异步操作

        其他的还好,主要是不理解为什么不直接在插件函数原型上定义apply ,而要去调用一个自执行函数并使用 defineProperty给apply方法定义一些数据属性,是为了将apply()方法做响应式嘛?😵是的话这么做有啥好处呢?

<think>嗯,我现在遇到了一个Webpack的错误,提示“TypeError: compiler.plugin is not a function”。这让我有点困惑,因为之前用Webpack的时候没碰到过这个问题。首先,我需要弄清楚这个错误是在什么情况下发生的。用户提到的引用里有一个类似的错误,是关于cli.isMultipleCompiler的问题,可能和Webpack版本有关吗? 我记得Webpack在版本升级后,有些API可能会被废弃或更改。比如,Webpack 4和Webpack 5之间有很多变化。可能compiler.plugin这个方法是旧版本中的,现在被移除了。所以,如果插件还在使用compiler.plugin,而我的Webpack版本较新,就会报错。 接下来,我需要确认我的Webpack版本。可以通过npm list webpack或者查看package.json中的版本来确定。假设我的项目使用的是Webpack 5,而插件可能只兼容Webpack 4或更早版本。这时候,解决办法可能是升级插件到支持Webpack 5的版本,或者修改插件代码,使用新的API。 另外,可能安装的插件版本不对。比如,某些插件可能有针对不同Webpack版本的分支或更新版本。需要检查插件的文档或GitHub仓库,看看有没有相关的迁移指南。例如,html-webpack-pluginWebpack 5中可能需要特定版本。 如果插件本身没有更新,可能需要手动修改代码。比如,替换compiler.plugin为新的hooks系统。Webpack 5推荐使用compiler.hooks.someHook.tap来注册插件钩子。所以,原来的代码可能用的是compiler.plugin('hook-name', callback),现在需要改成compiler.hooks.hookName.tap('PluginName', callback)。 还有可能需要检查其他依赖,比如webpack-cli的版本是否与Webpack兼容。有时候,升级webpack的同时,也需要升级相关的CLI工具,否则可能会有兼容性问题。 另外,用户提到的错误中,引用了webpack-cli的路径,可能涉及到serve命令的问题。但当前问题中的错误是compiler.plugin的问题,这可能和插件相关,而不是CLI本身。所以重点还是在插件Webpack版本的兼容性上。 总结可能的解决步骤:首先检查Webpack版本和插件版本是否兼容;升级插件Webpack到适配版本;如果无法升级,修改插件代码使用新API;检查其他依赖如webpack-cli是否需要更新。此外,查看错误堆栈,确定是哪个插件导致的,然后针对该插件进行处理。 比如,如果错误出现在html-webpack-plugin中,可能需要升级到v5.0.0以上。或者,如果是自定义插件,需要将compiler.plugin替换为hooks。例如,将compiler.plugin('done', callback)改为compiler.hooks.done.tap('PluginName', callback)。 另外,可能需要清理node_modules和lock文件,重新安装依赖,确保所有包版本正确。有时候,旧版本的残留文件会导致问题。 最后,如果所有方法都不奏效,可能需要查找社区中是否有类似问题的解决方案,或者在GitHub上提交issue寻求帮助。</think>### 如何修复 Webpack 的 `TypeError: compiler.plugin is not a function` 错误? #### 错误原因分析 此错误通常是由于以下原因引起的: 1. **Webpack 版本升级**:Webpack 5 移除了 `compiler.plugin` API,改用基于 `hooks` 的新事件系统[^1]。 2. **插件未适配新版本**:使用的插件未更新到兼容 Webpack 5 的版本,仍依赖旧版 API。 --- #### 解决方案步骤 1. **检查 Webpack 版本** ```bash npm list webpack ``` - 如果版本为 **5.x.x**,则需要升级插件或修改插件代码。 2. **升级相关插件** - 常见插件兼容性要求: | 插件名称 | Webpack 5 兼容版本 | |----------------------|-------------------| | `html-webpack-plugin` | ≥5.0.0 | | `terser-webpack-plugin` | ≥5.0.0 | - 示例升级命令: ```bash npm install html-webpack-plugin@latest --save-dev ``` 3. **修改插件代码(适用于自定义插件)** - **旧版代码**(Webpack 4): ```javascript compiler.plugin('done', function(stats) { /* ... */ }); ``` - **新版代码**(Webpack 5): ```javascript compiler.hooks.done.tap('PluginName', (stats) => { /* ... */ }); ``` 4. **清理并重新安装依赖** ```bash rm -rf node_modules package-lock.json npm install ``` --- #### 示例修复案例 **问题插件**:`html-webpack-plugin@4.x` - **错误表现**: ``` TypeError: compiler.plugin is not a function ``` - **修复步骤**: 1. 升级到 v5.x: ```bash npm install html-webpack-plugin@5.5.0 --save-dev ``` 2. 检查 Webpack 配置文件中是否移除废弃选项(如 `templateOptions`)。 --- #### 验证修复 运行构建命令并观察是否报错: ```bash npx webpack --mode production ``` --- ### 相关问题 1. **Webpack 5 与 Webpack 4 的主要区别是什么?** 2. **如何兼容旧版 Webpack 插件到新版本?** 3. **如何调试 Webpack 构建过程中的插件错误?** : 【Webpack 5 迁移指南】官方文档明确说明 `compiler.plugin` 已废弃,需改用 `hooks` 系统。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值