vue/require-explicit-emits
要求使用
emits
选项,其中包含由$emit()
触发的名称
- ⚙️ 此规则包含在所有
"plugin:vue/vue3-strongly-recommended"
、*.configs["flat/strongly-recommended"]
、"plugin:vue/vue3-recommended"
和*.configs["flat/recommended"]
中。 - 💡 此规则报告的一些问题可以通过编辑器 建议 手动修复。
📖 规则详细信息
此规则报告未通过 emits
选项声明的事件触发器。(emits
选项是 Vue.js 3.0.0+ 中的新增功能)
显式 emits
声明用作自文档代码。这对于其他开发人员来说很有用,他们可以立即了解组件应该发出哪些事件。此外,随着 Vue.js 3.0.0+ 中属性透传更改,组件上的 v-on
监听器默认情况下将透传为本机监听器。将其声明为 emits
中的组件专用事件,以避免不必要地注册本机监听器。
🔧 选项
json
{
"vue/require-explicit-emits": ["error", {
"allowProps": false
}]
}
"allowProps"
... 如果为true
,则允许在props
中定义的事件名称。默认值为false
"allowProps": true
👫 相关规则
📚 进一步阅读
🚀 版本
此规则是在 eslint-plugin-vue v7.0.0 中引入的