zig fmt: 코드 형식 지정하기

Zig에는 모든 프로젝트가 같은 모습으로 보이도록 기본 제공 포매터가 포함되어 있습니다. zig fmt 명령은 코드를 표준 Zig 스타일로 다시 작성합니다.

zig fmt를 파일에 지정하면 디스크의 해당 파일을 직접 다시 포맷하여 들여쓰기, 공백, 줄바꿈을 자동으로 바로잡습니다.

directory를 지정하면 zig fmt가 디렉터리를 재귀적으로 순회하며 발견하는 모든 .zig 파일을 정리합니다. 한 번의 명령으로 전체 프로젝트를 포맷할 수 있습니다.

논쟁할 스타일 옵션이 없습니다. Zig fmt에는 고정된 스타일 하나만 있으므로 모든 팀과 코드베이스에서 포맷팅에 관한 논쟁이 사라집니다.

--check 플래그는 포맷되지 않은 파일을 보고하고 error와 함께 종료하지만, 아무것도 수정하지 않습니다. 확인 작업에 안성맞춤입니다.

--check는 실패를 나타내는 종료 코드를 반환하므로, 지속적 통합에 연결하여 포맷되지 않은 코드를 자동으로 거부할 수 있습니다.

--stdin을 전달하면 zig fmt가 파이프로 들어온 텍스트를 포맷하고 결과를 출력합니다. 편집기는 저장할 때 포맷하기 위해 이를 사용합니다.

대부분의 편집기는 저장할 때 zig fmt를 자동으로 실행합니다. 코드가 즉시 정돈되므로 레이아웃을 다시 신경 쓸 필요가 없습니다.

범위를 기억하세요. zig fmt는 레이아웃만 수정합니다. 이름을 바꾸거나 논리 버그를 찾아내지는 않습니다. 그 일은 컴파일러의 몫입니다.

zig fmt는 리터럴과 주석의 줄바꿈은 대부분 그대로 둡니다. 따라서 의도적인 레이아웃을 지우지 않고 구조만 정리합니다.

모든 커밋 전에 포매터를 실행하세요. 깔끔하고 일관된 변경 내용은 검토를 빠르게 하고 전체 기록을 누구나 읽기 쉽게 만듭니다.

CI에서는 어떤 파일도 수정하지 않고 코드가 포맷되지 않았을 때 빌드를 실패시키고 싶습니다. 어떤 명령이 적합할까요?

zig fmt를 살펴보았습니다. 하나의 표준 스타일, 파일이나 폴더 포맷팅, CI용 --check, 그리고 코드를 손쉽게 깔끔하게 유지하는 편집기 저장 시 포맷팅을 배웠습니다. 🧹