eslint-plugin-vue

Appearance

vue/no-restricted-component-names ​

disallow specific component names

  • 💡 Some problems reported by this rule are manually fixable by editor suggestions.

📖 Rule Details ​

This rule allows you to specify component names that you don't want to use in your application.

Now loading...
Now loading...

🔧 Options ​

This rule takes a list of strings, where each string is a component name or pattern to be restricted:

json
{
  "vue/no-restricted-component-names": ["error", "foo", "/^Disallow/"]
}

Alternatively, you can specify an object with a name property and an optional message and suggest property:

json
{
  "vue/no-restricted-component-names": [
    "error",
    {
      "name": "Disallow",
      "message": "Please do not use `Disallow` as a component name",
      "suggest": "allow"
    },
    {
      "name": "/^custom/",
      "message": "Please do not use component names starting with 'custom'"
    }
  ]
}
Now loading...

🚀 Version ​

This rule was introduced in eslint-plugin-vue v9.15.0

🔍 Implementation ​