file_names 진단: 소스 파일 이름은 lowercase_with_underscores로

file_names 진단: 소스 파일 이름은 lowercase_with_underscores로

소스 파일의 이름을 소문자와 밑줄(lowercase_with_underscores) 방식으로 짓도록 안내하는 린트 규칙이에요. 여러 운영체제·도구에서 파일 이름이 안전하게 쓰이도록 도와주는 규칙이에요.

출처: file_names

본문

설명

소스 파일의 이름은 소문자와 밑줄 방식으로 짓도록(DO) 해요.

일부 파일 시스템은 대소문자를 구분하지 않아서, 많은 프로젝트가 파일 이름을 전부 소문자로 만들기를 요구해요. 이때 단어를 구분해 주는 문자를 쓰면 그 형태에서도 이름을 읽기 쉽게 유지할 수 있어요. 구분자로 밑줄을 쓰면 그 이름이 여전히 유효한 Dart 식별자(identifier) 가 되어, 언어가 나중에 기호 임포트(symbolic imports)를 지원하게 되면 유용할 수 있어요.

BAD:

  • SliderMenu.dart
  • filesystem.dart
  • file-system.dart

GOOD:

  • slider_menu.dart
  • file_system.dart

엄격한 .dart 확장자가 아닌 파일은 무시돼요. 예를 들어 다음 이름들은 괜찮아요(OK).

  • file-system.g.dart
  • SliderMenu.css.dart

라이브러리 이름에도 똑같은 방식의 네이밍을 적용하려면 library_names 린트를 쓸 수 있어요.

활성화 방법

file_names 규칙을 쓰려면 analysis_options.yaml 파일의 linter > rules 아래에 규칙을 추가하면 돼요.

linter:
  rules:
    - file_names

대신 YAML 맵(map) 문법으로 린터 규칙을 설정한다면, linter > rules 아래에 file_names: true를 추가해요.

linter:
  rules:
    file_names: true

더 알아보기