class_members_ordering

Details

DO arrange class members in a consistent order.

Regular classes

Class members should be ordered in the following sequence:

1. Public static fields
2. Private static fields
3. Public instance fields
4. Private instance fields
5. Public constructors
6. Public named constructors
7. Private constructors
8. Private named constructors
9. Public getters
10. Private getters
11. Public setters
12. Private setters
13. Public static methods
14. Public instance methods
15. Private static methods
16. Private instance methods

Widgets and states

When a class extends Widget or State, constructors come first:

1. Public constructors
2. Public named constructors
3. Private constructors
4. Private named constructors
5. Public static fields
6. Private static fields
7. Public instance fields
8. Private instance fields
9. Public getters
10. Private getters
11. Public setters
12. Private setters
13. Public static methods
14. Public instance methods
15. Private static methods
16. Private instance methods

class A {
  void method() {}

  int field;

  A({required this.field});
}

class A {
  final int field;

  A({required this.field});

  void method() {}
}

import 'package:flutter/widgets.dart';

class A extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }

  final String field;

  const A({
    super.key,
    required this.field,
  });
}

import 'package:flutter/widgets.dart';

class A extends StatelessWidget {
  const A({
    super.key,
    required this.field,
  });

  final String field;

  @override
  Widget build(BuildContext context) {
    return const Placeholder();
  }
}

Usage

To enable the class_members_ordering rule, add class_members_ordering under plugins > pyramid_lint > diagnostics in your analysis_options.yaml file:

plugins:
  pyramid_lint: <version>
    diagnostics:
      class_members_ordering: true