vue/match-component-file-name

require component name property to match its file name

This rule reports if a component name property does not match its file name.

You can define an array of file extensions this rule should verify for the component's name.

📖 Rule Details

This rule has some options.

{
  "vue/match-component-file-name": ["error", {
    "extensions": ["jsx"],
    "shouldMatchCase": false
  }]
}

By default this rule will only verify components in a file with a .jsx extension.

You can use any combination of ".jsx", ".vue" and ".js" extensions.

You can also enforce same case between the component's name and its file name.

If you are defining multiple components within the same file, this rule will be ignored.

// file name: src/MyComponent.jsx export default { /* ✓ GOOD */ name: 'MyComponent', render() { return <h1>Hello world</h1> } }
Now loading...
// file name: src/MyComponent.jsx export default { /* ✓ GOOD */ name: 'my-component', render() { return <div /> } }
Now loading...
// file name: src/MyComponent.jsx export default { /* ✗ BAD */ name: 'MComponent', // note the missing y render() { return <h1>Hello world</h1> } }
Now loading...
// file name: src/MyComponent.jsx /* no name property defined */ export default { render() { return <h1>Hello world</h1> } }
Now loading...
<!-- file name: src/MyComponent.vue --> <script> export default { /* The default does not verify to `.vue`. */ name: 'MComponent', template: '<div />' } </script>
Now loading...

🔧 Options

{
  "vue/match-component-file-name": ["error", {
    "extensions": ["jsx"],
    "shouldMatchCase": false
  }]
}
  • "extensions": [] ... array of file extensions to be verified. Default is set to ["jsx"].
  • "shouldMatchCase": false ... boolean indicating if component's name should also match its file name case. Default is set to false.

{extensions: ["vue"]}

<!-- file name: src/MyComponent.vue --> <script> export default { /* ✓ GOOD */ name: 'MyComponent', template: '<div />' } </script>
Now loading...
<!-- file name: src/MyComponent.vue --> <script> export default { /* ✗ BAD */ name: 'MComponent', template: '<div />' } </script>
Now loading...
<!-- file name: src/MyComponent.vue --> <script> /* no name property defined */ export default { template: '<div />' } </script>
Now loading...

{extensions: ["js"]}

// file name: src/MyComponent.js new Vue({ /* ✓ GOOD */ name: 'MyComponent', template: '<div />' })
Now loading...
// file name: src/MyComponent.js /* ✓ GOOD */ Vue.component('MyComponent', { template: '<div />' })
Now loading...
// file name: src/MyComponent.js new Vue({ /* ✗ BAD */ name: 'MComponent', template: '<div />' })
Now loading...
// file name: src/MyComponent.js /* ✗ BAD */ Vue.component('MComponent', { template: '<div />' })
Now loading...
// file name: src/components.js /* defines multiple components, so this rule is ignored */ Vue.component('MyComponent', { template: '<div />' }) Vue.component('OtherComponent', { template: '<div />' }) new Vue({ name: 'ThirdComponent', template: '<div />' })
Now loading...
// file name: src/MyComponent.js /* no name property defined */ new Vue({ template: '<div />' })
Now loading...

{shouldMatchCase: true}

// file name: src/MyComponent.jsx export default { /* ✓ GOOD */ name: 'MyComponent', render() { return <div /> } }
Now loading...
// file name: src/my-component.jsx export default { /* ✓ GOOD */ name: 'my-component', render() { return <div /> } }
Now loading...
// file name: src/MyComponent.jsx export default { /* ✗ BAD */ name: 'my-component', render() { return <div /> } }
Now loading...
// file name: src/my-component.jsx export default { /* ✗ BAD */ name: 'MyComponent', render() { return <div /> } }
Now loading...

📚 Further reading

🔍 Implementation

Last Updated: 2/3/2019, 3:08:47 AM