YAML 포맷터

Source: Dev.to

왜 올바른 포맷이 중요한가

• 애플리케이션, CI/CD 파이프라인, 배포 과정에서 설정 실패를 방지합니다.
• 가독성 및 유지보수성을 향상시켜 팀 작업을 원활하게 합니다.
• 디버깅 속도를 높여 부모‑자식 관계를 명확히 보여줍니다.

핵심 포맷팅 혜택

• 들여쓰기를 바로잡고 공백을 보장합니다(탭은 허용되지 않음).
• 계층 구조와 리스트 항목을 정렬합니다.
• 스타일을 정규화합니다(예: 인라인 YAML을 블록 형식으로 변환, 일관된 인용 적용).
• 구문을 검증합니다: 누락된 콜론, 잘못된 중첩 및 기타 오류를 감지합니다.

선택적 향상 기능

• 키를 알파벳 순으로 정렬합니다.
• 프로젝트 전체에 적용되는 포맷 규칙을 강제합니다.

공통 기능

• 붙여넣기 & 포맷 – 복사한 YAML을 즉시 포맷합니다.
• 구문 오류 강조 – 문제를 시각적으로 표시합니다.
• 원클릭 복사 출력 – 포맷된 결과를 쉽게 재사용합니다.
• 실시간 포맷 – 입력 중이거나 저장 시 자동으로 포맷합니다.

인기 도구

이 도구들은 빌드 파이프라인에 통합되어 자동 검사를 수행할 수 있습니다.

사용 예시

# yamllint으로 YAML 파일 검사
yamllint file.yaml

# Prettier로 YAML 파일 포맷
prettier --write file.yaml

전후 샘플

Before (잘못된 들여쓰기):

services:
app:
image:node
ports:
- "3000:3000"

After (올바르게 포맷됨):

services:
  app:
    image: node
    ports:
      - "3000:3000"

일반적인 사용 사례

• Docker 설정 파일(docker-compose.yml)
• Kubernetes 매니페스트
• GitHub Actions 워크플로우
• CI/CD 파이프라인 정의
• Helm 차트
• 일반 애플리케이션 설정 파일

올바른 포맷은 런타임 설정 오류를 방지하고, YAML 파일을 사람이 읽기 쉽게 만들며, 일관된 표준을 강제하고, 디버깅 및 배포 문제를 감소시켜 팀 프로젝트 협업을 궁극적으로 향상시킵니다.