terraform fmt 명령

terraform fmt 명령

terraform fmt 명령은 Terraform 구성 파일 내용을 표준 형식과 스타일에 맞게 포맷하는 명령이에요. Terraform 언어 스타일 규칙의 일부와 가독성을 위한 사소한 조정을 함께 적용해요.

출처: 문서

본문

소개 (Introduction)

Terraform 구성을 생성하는 Terraform 명령은 terraform fmt이 적용하는 스타일을 따르는 구성 파일을 생성해요. 일관성을 위해 파일에서도 이 스타일을 따르세요.

표준 형식은 Terraform 버전 사이에 사소한 방식으로 변경될 수 있으므로, Terraform 업그레이드 후에는 새 버전을 도입하면서 하는 다른 변경들과 함께 모듈에 terraform fmt을 적극적으로 실행할 것을 권장해요.

우리는 terraform fmt의 새 포맷 규칙을 Terraform 새 버전의 파괴적 변경으로 간주하지 않지만, Terraform 문서에 표시된 스타일 예제를 이미 따르는 구성에 대한 변경은 최소화해요. terraform fmt 명령에 프로그래밍된 새 포맷 규칙은 보통 문서의 기존 규칙을 포함하도록 확장되는 경우가 많아요. terraform fmt이 아직 자동으로 적용하지 않는 결정에 대해서도 문서화된 스타일을 따를 것을 권장해요.

포맷 결정은 항상 주관적이라 terraform fmt이 내리는 결정에 동의하지 않을 수도 있어요. 이 명령은 의도적으로 고집스럽고 사용자 지정 옵션이 없는데, 그 주된 목표가 선택된 스타일이 모두의 취향일 수는 없더라도 서로 다른 Terraform 코드베이스 간의 스타일 일관성을 장려하는 것이기 때문이에요.

Terraform 모듈을 작성할 때 terraform fmt이 적용하는 스타일 규칙을 따를 것을 권장하지만, 결과가 특히 마음에 들지 않는다면 이 명령을 사용하지 않고 타사 포맷 도구를 사용할 수도 있어요. 타사 도구를 사용하기로 선택했다면 Terraform이 자동으로 생성한 파일에도 이를 실행해서, 손으로 작성한 파일과 생성된 파일 사이의 일관성을 확보해야 해요.

사용법 (Usage)

사용법: terraform fmt [options] [target...]

기본적으로 terraform fmt 명령은 현재 디렉터리에서 구성 파일을 검색해요. target 인자를 제공해 terraform fmt이 검색할 대상을 지정할 수도 있어요:

  • 디렉터리
  • 특정 파일
  • -

terraform fmt 명령은 다음 인자를 받아들여요.

Flag 설명 필수
-list=false 형식 불일치가 있는 파일을 명령이 나열하지 못하게 해요. 선택
-diff 포맷 변경의 diff를 표시해요. 선택
-write=false 파일을 덮어쓰지 못하게 해요. 이 동작은 -check 플래그가 있거나 입력이 STDIN에서 오면 암시돼요. 선택
-check 입력이 포맷되었는지 확인해요. 명령의 입력이 제대로 포맷되었으면 종료 상태는 0이에요. 그렇지 않으면 종료 상태가 0이 아니고, 명령은 제대로 포맷되지 않은 파일 이름 목록을 출력해요. 선택
-no-color 지정하면 출력에 색상이 포함되지 않아요. 선택
-recursive 현재 디렉터리뿐 아니라 하위 디렉터리의 파일도 처리해요. 기본적으로 명령은 지정되었거나 현재 디렉터리만 처리해요. 선택

더 알아보기 (Learn more)