개발 생산성 도구 기초집LESSON 05

Formatter: 코드 스타일을 자동으로 맞추는 이유

난이도초급

예상 시간45분

선수지식3강 Workspace, 사용하는 언어 환경

5강. Formatter: 코드 스타일을 자동으로 맞추는 이유

1. 이번 강의에서 해결할 문제

들여쓰기와 따옴표를 리뷰마다 손으로 고치거나 서로 다른 Formatter 버전이 파일 전체를 번갈아 바꿉니다. 프로젝트가 선택한 하나의 명령을 기준으로 삼습니다.

2. 학습 목표

3. 핵심 개념

Formatter는 공백, 줄바꿈, 들여쓰기처럼 동작을 바꾸지 않아야 하는 표현을 일관되게 만듭니다. 로직 버그를 보장하지 않습니다. 웹의 Prettier, Python의 Black, Java의 Spotless·google-java-format 등 선택지는 다르며 프로젝트에 이미 선언된 도구를 우선합니다.

Prettier 공식 문서도 전역 도구보다 프로젝트 로컬의 고정 버전과 --check를 권장합니다. 설치·옵션은 현재 공식 설치 문서를 확인하세요.

4. 단계별 실습

PowerShell · 실행 위치: 프로젝트 루트

# Web: package.json에 format script가 있을 때만 실행
if (Test-Path .\package.json) {
    $package = Get-Content .\package.json -Raw | ConvertFrom-Json
    $package.scripts | Format-List
    if ($package.scripts.'format:check') { npm.cmd run format:check }
}

# Python: 프로젝트 환경에 Black이 이미 있을 때만 확인
if (Test-Path .\.venv\Scripts\python.exe) {
    & .\.venv\Scripts\python.exe -m pip show black
}

# Java: Wrapper의 사용 가능한 task에서 format 관련 이름 확인
if (Test-Path .\gradlew.bat) {
    .\gradlew.bat tasks --all | Select-String -Pattern 'format|spotless'
}

예상 결과: 프로젝트가 선언한 Formatter 또는 관련 Task만 표시·실행됩니다. 없으면 설치하지 않고 미선택으로 기록합니다. 관리자 권한은 필요하지 않습니다.

자동 수정 전후:

git status --short
# 프로젝트 README에 적힌 format 명령을 실행
git diff --check
git diff

Git 상세 사용법은 Git · GitHub 기초집을 참고합니다.

5. 도구와 설정이 동작하는 이유

check 모드는 파일을 바꾸지 않고 스타일 불일치를 종료 코드로 알려 자동 점검에 적합합니다. write 모드는 실제 파일을 변경하므로 작업 범위와 diff를 확인해야 의도하지 않은 대량 변경을 막을 수 있습니다.

6. 자주 하는 실수와 해결법

7. 직접 실습

8. 이해 점검 질문 3개

9. 핵심 요약

MINI QUIZ