Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 1.77 KB

order-in-components.md

File metadata and controls

77 lines (61 loc) · 1.77 KB
Raw

enforce order of properties in components (vue/order-in-components)

  • ⚙️ This rule is included in "plugin:vue/recommended".
  • 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

This rule makes sure you keep declared order of properties in components.

📖 Rule Details

Recommended order of properties can be found here.

Examples of incorrect code for this rule:

name: 'app',
data () {
  return {
    msg: 'Welcome to Your Vue.js App'
  }
},
props: {
  propA: Number,
}

Examples of correct code for this rule:

export default {
  name: 'app',
  props: {
    propA: Number,
  },
  data () {
    return {
      msg: 'Welcome to Your Vue.js App'
    }
  },
}

Options

If you want you can change the order providing the optional configuration in your .eslintrc file. Setting responsible for the above order looks like this:

"vue/order-in-components": ["error", {
  "order": [
    "el",
    "name",
    "parent",
    "functional",
    ["delimiters", "comments"],
    ["components", "directives", "filters"],
    "extends",
    "mixins",
    "inheritAttrs",
    "model",
    ["props", "propsData"],
    "data",
    "computed",
    "watch",
    "LIFECYCLE_HOOKS",
    "methods",
    ["template", "render"],
    "renderError"
  ]
}]

If you want some of properties to be treated equally in order you can group them into arrays, like we did with delimiters and comments.

Related links