Skip to main content

primary-parameters-ordering

effort: 2m
dart 3.13+
configurable
has IDE fix
has auto-fix
pro+

Enforces consistent order for primary constructor parameters.

⚙️ Config​

Set order to configure the order for primary constructor parameters.

Default values

The default config for order is:

  • final-declaring
  • var-declaring
  • regular

Supported modifiers (can be used in any order):

  • overridden or protected
  • public or private
  • required
  • super
  • nullable
  • initialized
  • var or final
  • positional or named or optional (when not specified, applies to all parameters)
  • declaring or regular

Additionally, to apply a specific order to a particular parameter, specify its name as follows:

  • build-parameter
  • child-parameter
note

Named entries require the parameter modifier.

The alphabetize option will enforce that parameters within the same category are alphabetically sorted by name.

⚙️ Config Example​

analysis_options.yaml
dcm:
rules:
- primary-parameters-ordering:
alphabetize: true
order:
- final-declaring
- public-required
- regular
- public-nullable-positional
- overridden-public-required
- custom-parameter