falconGitHub

prefer-trailing-comma

Same as prefer-trailing-comma in Dart Code Metrics

Group
Style
Path
lint/style/prefer-trailing-comma
Default
Off, opt in
Origin
Dart Code Metrics
Rule
411 of 512

Flags multi-line argument lists that are missing a trailing comma.

A trailing comma is required only when the argument list is already broken across lines — when the last significant token sits on an earlier line than the closing ). This mirrors the Dart 3.x tall-style formatter.

Invalid

example.dartdart
// Bad: multi-line argument list without trailing comma
void example() {
  functionCall(
    'first',
    'second',
    'third'
  );

  final obj = MyClass(
    fieldA,
    fieldB,
    fieldC
  );

  anotherFunc(
    argOne,
    argTwo,
    argThree
  );
}

void moreExamples() {
  final nested = Container(
    child: Column(
      children: [1, 2, 3],
    ),
  );

  buildUI(
    param1,
    param2,
    param3
  );
}

void oneMore() {
  final data = Provider(
    child: Text(
      'Hello World',
    ),
  );
}

void needTrailingComma() {
  configureApp(
    debug: true,
    verbose: false,
    timeout: 30
  );
}
Add a trailing comma to the argument list.
6 'third'
7 );
Add a trailing comma to the argument list.
12 fieldC
13 );
Add a trailing comma to the argument list.
18 argThree
19 );
Add a trailing comma to the argument list.
32 param3
33 );
Add a trailing comma to the argument list.
48 timeout: 30
49 );

Valid

example.dartdart
// Good: multi-line lists/calls with trailing commas
void example() {
  functionCall(
    'first',
    'second',
    'third',
  );
}

class MyClass {
  void methodCall(
    String arg1,
    int arg2,
    bool arg3,
  ) {
    print('$arg1 $arg2 $arg3');
  }
}

final result = complex(
  value1,
  value2,
  nested(
    item1,
    item2,
  ),
);

List<String> items = [
  'a',
  'b',
  'c',
];

// OK: single-line calls don't need trailing commas
void single() {
  print('hello');
  functionCall('a', 'b', 'c');
}

// OK: single argument on multiple lines
void singleArg(
  String veryLongArgumentName,
) {
  print(veryLongArgumentName);
}

// OK: constructor with trailing comma
final obj = MyClass(
  field1: 'value',
  field2: 42,
);

// OK: map with trailing comma
final map = {
  'key1': 'value1',
  'key2': 'value2',
};

// OK: empty call is fine
void emptyCall() {
  noArgs();
}

Configure prefer-trailing-comma

Set its severity in falcon.json. See the configuration guide.

falcon.jsonjson
{
  "linter": {
    "rules": {
      "style": {
        "prefer-trailing-comma": "error"
      }
    }
  }
}

Or silence one occurrence with a suppression comment; the reason is required.

example.dartdart
// falcon-ignore lint/style/prefer-trailing-comma: <reason>