require_trailing_commas 린트 규칙: 여러 줄로 나뉜 파라미터·인자 목록에 마지막 쉼표 넣기

require_trailing_commas 린트 규칙: 여러 줄로 나뉜 파라미터·인자 목록에 마지막 쉼표 넣기

여러 줄에 걸쳐 나열되는 파라미터 목록이나 인자 목록에는 **마지막 요소 뒤에도 쉼표(trailing comma)**를 붙이는 걸 권장해요. 이 린트 규칙은 그렇게 하도록 도와주는 규칙입니다. 한 줄에 다 들어가면 굳이 마지막 쉼표가 필요 없고, 여러 줄로 접힌 경우에만 붙이는 거예요.

출처: require_trailing_commas

본문

설명

여러 줄로 나뉘는 모든 파라미터 목록과 인자 목록에는 마지막 쉼표를 사용해요.

한 줄에 다 들어가는 목록(여는 괄호와 닫는 괄호까지 모두 한 줄)이라면 마지막 쉼표가 필요 없어요.

BAD:

void run() {
  method('does not fit on one line',
      'test test test test test test test test test test test');
}

GOOD:

void run() {
  method(
    'does not fit on one line',
    'test test test test test test test test test test test',
  );
}

예외: 인자 목록의 마지막 인자가 위치 기반(positional) 인자인데, 그 값이 중괄호를 쓰는 함수 리터럴이거나 맵 리터럴, 집합 리터럴, 리스트 리터럴이라면 마지막 쉼표를 붙이지 않아도 돼요. 다만 이 예외는 마지막 인자가 한 줄에 다 들어가지 않을 때만 적용돼요.

참고: 이 린트 규칙은 코드가 dart format으로 정리되어 있다는 전제를 두고 있어요. 그래서 아직 정리되지 않은 코드에서는 가끔 잘못된 경고(오탐)가 나올 수 있답니다.

활성화 방법

require_trailing_commas 규칙을 활성화하려면 analysis_options.yaml 파일의 linter > rules 아래에 규칙을 추가하면 돼요.

linter:
  rules:
    - require_trailing_commas

대신 YAML 맵 문법으로 린트 규칙을 설정하고 있다면, linter > rules 아래에 require_trailing_commas: true를 추가하면 돼요.

linter:
  rules:
    require_trailing_commas: true

더 알아보기