lifecycle-order.md

lifecycle-order

Ensures that Component lifecycle methods are ordered consistently

Rationale

A consistent ordering for Component lifecycle methods can make Components easier to read, navigate, and edit.

Ordering lifecycle methods by their natural call order (call-order) makes the functionality of each self-documenting.

Config

This rule optionally accepts a single argument, which is a string. It should be one of the following values:

• call-order
• alphabetical

If no argument is provided, this rule will enforce the default functionality (which matches that of call-order.)

Config examples

{ "lifecycle-sort": [true, "call-order"] }

{ "lifecycle-sort": [true, "alphabetical"] }

Schema

{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "alphabetical",
      "call-order"
    ]
  },
  "minLength": 0,
  "maxLength": 2
}

Code Examples

• Order lifecycle methods by their natural call order (call-order or default)

  ⚙️ Config

  "rules": { "lifecycle-sort": [true, "call-order"] }

  ✅ Pass

  componentWillLoad() { }
  componentDidLoad() { }
  componentWillUpdate() { }
  componentDidUpdate() { }
  componentDidUnload() { }

• Order lifecycle methods alphabetically (alphabetical) ⚙️ Config

  "rules": { "lifecycle-sort": [true, "alphabetical"] }

  ✅ Pass

  componentDidLoad() { }
  componentDidUnload() { }
  componentDidUpdate() { }
  componentWillLoad() { }
  componentWillUpdate() { }