YAML 포맷터

포맷 전과 후

지저분한 입력:

server:
  port:   8080
  hosts: ["api.example.com",  "api2.example.com"]
  timeout:  30
  debug: true

포맷 결과(공백 2칸, 블록 스타일):

server:
  port: 8080
  hosts:
    - api.example.com
    - api2.example.com
  timeout: 30
  debug: true

포맷 옵션

따옴표 규칙

대개는 최소 따옴표가 정답입니다. 따옴표 없이 두면 위험한 경우가 아니라면 문자열은 그대로 유지됩니다. 포맷터는 다음의 경우 따옴표를 자동으로 추가합니다:

• 문자열로 쓰인 레거시 불리언: yes, no, on, off, y, n. YAML 1.2는 이미 문자열로 읽지만, 많은 파서가 아직 YAML 1.1을 따르며 그 경우 따옴표 없는 no는 false가 됩니다. 포맷터는 출력에서 항상 따옴표를 붙이므로, 유명한 노르웨이 버그(국가 목록의 NO가 false로 읽히는 문제)가 파일을 사용하는 쪽을 물 수 없습니다.
• 문자열로 쓰인 숫자: '007', '3.14'. 따옴표가 없으면 정수나 실수로 파싱됩니다.
• :, #, [, { 같은 문자를 포함하거나 공백으로 시작하는 문자열. 그대로 출력하면 구조가 바뀝니다.

실행할 때마다 적용되는 정리

• 줄 끝 공백. 제거됩니다.
• 뒤섞이거나 고르지 않은 들여쓰기. 선택한 들여쓰기 너비로 정규화됩니다.
• 컬렉션 안의 빈 줄. 제거됩니다.
• 들여쓰기의 탭. YAML은 탭을 금지합니다. 파서가 문제 줄을 짚어 주는 명확한 오류와 함께 입력을 거부하므로, 다른 파서가 거부할 파일을 내보내는 대신 바로 고칠 수 있습니다.

주석, 앵커, 병합 키

포맷은 문서 모델을 정규화하므로, 커밋 전에 알아 둘 한계가 있습니다:

• 주석은 제거됩니다. 파서가 문서를 데이터로 해석하므로 # 주석은 포맷 후 남지 않습니다. 주석이 중요하다면 사본을 보관하세요.
• 앵커와 별칭은 해석됩니다. 별칭으로 공유되던 노드는 계속 공유되지만 &ref_0 같은 생성된 이름으로 다시 출력되며, 원래 앵커 이름은 유지되지 않습니다.
• 병합 키(<<:)는 해석되어 병합된 값이 채워진 일반 매핑이 됩니다.

다중 문서 스트림

여러 문서가 담긴 스트림을 지원합니다. 각 문서는 독립적으로 포맷된 뒤 --- 구분자로 다시 이어지며, 한 번에 최대 100개 문서까지 처리합니다.