Skip to content

vue/multi-word-component-names

require component names to be always multi-word

  • ⚙️ This rule is included in the following preset configs:
    • *.configs["flat/essential"]
    • *.configs["flat/vue2-essential"]
    • *.configs["flat/strongly-recommended"]
    • *.configs["flat/vue2-strongly-recommended"]
    • *.configs["flat/recommended"]
    • *.configs["flat/vue2-recommended"]
    • "plugin:vue/essential"
    • "plugin:vue/vue2-essential"
    • "plugin:vue/strongly-recommended"
    • "plugin:vue/vue2-strongly-recommended"
    • "plugin:vue/recommended"
    • "plugin:vue/vue2-recommended"

📖 Rule Details

This rule require component names to be always multi-word, except for root App components, and built-in components provided by Vue, such as <transition> or <component>. This prevents conflicts with existing and future HTML elements, since all HTML elements are single words.

Now loading...
Now loading...
Now loading...
Now loading...
Now loading...
Now loading...
Now loading...

🔧 Options

json
{
  "vue/multi-word-component-names": ["error", {
    "ignores": []
  }]
}
  • ignores (string[]) ... The component names to ignore. Sets the component name to allow.

ignores: ["Todo"]

Now loading...
Now loading...
Now loading...

📚 Further Reading

🚀 Version

This rule was introduced in eslint-plugin-vue v7.20.0

🔍 Implementation