[Flutter] Linter (with. flutter_lints)

Flutter 협업을 진행하면서, 코드 컨벤션을 맞추기로 했어요!

스터디 단계이기 때문에 먼저 대중적으로 사용 되는 Flutter Linter를 찾아보았더니,

 Flutte는 자체적으로 권장 Lint파일을 제공한다고 하네요!!

 

📌  이번 글은

Flutter Linter 적용법 입니다. 

 

flutter_lints

이 패키지에는 Flutter 앱, 패키지 및 플러그인에 권장되는 lint 세트가 포함되어 있어 좋은 코딩 방법을 권장합니다.
Flutter v2.3.0 이후 flutter create로 생성된 Flutter 앱, 패키지 및 플러그인은 Lint가 미리 정의된 analysis_options.yaml 파일과 함께 기본 제공됩니다

GitHub - flutter/packages: A collection of useful packages maintained by the Flutter team

 

 

flutter create 시 자동 생성되는 pubspec.yaml 파일을 번역한 포스팅이 있는데

중간에 flutter_lints 패키지 내용이 있었네요!

# https://sunidev.tistory.com/51 -> pubspec.yaml 일부
dev_dependencies:
  flutter_test:
    sdk: flutter

  # 아래의 "flutter_lints" 패키지에는 다음과 같은 용도로 권장되는 lint 세트가 포함되어 있습니다.
  # 좋은 코딩 실행을 장려한다. 패키지에서 제공하는 lint 세트는 다음과 같습니다.
  # 사용자의 루트에 있는 'analysis_options.yaml' 파일에서 활성화되었습니다.
  # package. 특정 lint을 비활성화하는 방법에 대한 자세한 내용은 해당 파일을 참조하십시오.
  # 규칙 및 추가 규칙 활성화
  flutter_lints: ^1.0.0

 

analysis_options.yaml

프로젝트 폴더를 만들면 analysis_options.yaml 파일도 자동 생성됩니다.

 

기본 코드

한글로 번역하였습니다.

# 이 파일은 Dart 코드를 정적으로 해석하는 Analyzer를 설정합니다.
# error, warning, lint를 체크합니다.
#
# Analyzer에 의해 발견된 이슈는 Dart-enabled IDEs (https://dart.dev/tools#ides-and-editors)의 UI에 나타납니다.
# analyzer는 'flutter analyzer'를 실행하여 커맨드 라인에서 호출할 수도 있습니다.

# 다음 라인은 올바른 코딩 방법을 권장하도록 설계된 Flutter앱, 패키지 및 플러그인에 대해 lint를 활성화 합니다.
include: package:flutter_lints/flutter.yaml

linter:
  # 이 프로젝트에 적용되는 lint 규칙은 아래 섹션에서 커스터마이즈하여 
  # 위의 `package:flutter_lints/flutter.yaml`에서 규칙을 비활성화하거나 추가 규칙을 활성화할 수 있습니다.
  # 사용 가능한 모든 lint 목록과 메뉴얼은 https://dart-lang.github.io/linter/lints/index.html 에서 공개됩니다.
  #
  # 아래 섹션의 프로젝트 전체에 대해 lint 규칙을 비활성화 하는 대신
  # line 또는 lint를 생성하는 파일에서 `// ignore: name_of_lint` 및 
  # `// ignore_for_file: name_of_lint`구문을 사용하여 
  # 코드 또는 특정 dart파일에 대해 lint 규칙을 억제할 수도 있습니다.
  rules:
    # avoid_print: false  # `avoid_print` 규칙을 사용하지 않도록 설정하는 주석
    # prefer_single_quotes: true # `prefer_single_quotes` 규칙을 사용하지 않도록 설정하는 주석

# 이 파일에 대한 자세한 내용은 https://dart.dev/guides/language/analysis-options를 참조하십시오.