order-in-models.md

Organize your models

Rule name: order-in-models

Configuration

ember/order-in-models: [2, {
  order: [
    'attribute',
    'relationship',
    'single-line-function',
    'multi-line-function',
  ]
}]

If you want some of properties to be treated equally in order you can group them into arrays, like so:

order: [
  'attribute',
  'relationship',
  ['single-line-function', 'multi-line-function'],
]

You can find full list of properties that you can use to configure this rule here.

Description

You should write code grouped and ordered in this way:

1. Attributes
2. Relations
3. Single line computed properties
4. Multiline computed properties
5. Other structures (custom methods etc.)

// GOOD
export default Model.extend({
  // 1. Attributes
  shape: attr('string'),

  // 2. Relations
  behaviors: hasMany('behaviour'),

  // 3. Computed Properties
  mood: computed('health', 'hunger', function() {
    const result = this.get('health') * this.get('hunger');
    return result;
  })
});

// BAD
export default Model.extend({
  mood: computed('health', 'hunger', function() {
    const result = this.get('health') * this.get('hunger');
    return result;
  }),

  hat: attr('string'),

  behaviors: hasMany('behaviour'),

  shape: attr('string')
});