跳至内容

vue/component-api-style

强制组件 API 风格

📖 规则详情

此规则旨在使您在项目中定义 Vue 组件时使用的 API 风格保持一致。

例如,如果您只想允许 <script setup> 和 Composition API。
(这是此规则的默认值。)

正在加载...
正在加载...
正在加载...

🔧 选项

json
{
  "vue/component-api-style": ["error",
    ["script-setup", "composition"] // "script-setup", "composition", "composition-vue2", or "options"
  ]
}
  • 数组选项 ... 定义您要允许的 API 风格。默认值为 ["script-setup", "composition"]。您可以使用以下值。
    • "script-setup" ... 如果设置,则允许 <script setup>.
    • "composition" ... 如果设置,则允许 Composition API (不是 <script setup>)。
    • "composition-vue2" ... 如果设置,则允许 Vue 2 的 Composition API (不是 <script setup>)。特别是,它允许 renderrenderTrackedrenderTriggeredsetup 一起使用。
    • "options" ... 如果设置,则允许 Options API。

["options"]

正在加载...
正在加载...
正在加载...

🚀 版本

此规则是在 eslint-plugin-vue v7.18.0 中引入的

🔍 实现