소개
nginxfmt는 NGINX 설정 파일을 빠르고 간결하게 포맷팅하는 커맨드라인 도구입니다. 이 프로젝트는 Rust로 개발되었으며, 설정 파일의 들여쓰기 스타일이나 대괄호 위치 같은 서식을 지정하여 보다 일관되고 읽기 쉬운 구성을 만드는 데 도움을 줍니다.
상세정보
다양한 포맷팅 옵션 지원
다음과 같은 설정 파일 포맷팅을 제어할 수 있습니다.
- 들여쓰기 스타일 및 너비 설정 (spaces 또는 tabs)
- 대괄호 스타일 (same_line 또는 next_line)
- 빈 줄 수 제한 및 끝 줄(Trailing newline) 관리
- 인라인 주석 보존 여부 설정
유연한 입력 및 출력
표준 출력(stdout)으로 결과를 확인하거나, –write 옵션을 사용하여 원본 파일을 직접 수정할 수 있습니다. 또한 –check 옵션을 통해 CI/CD 파이프라인에서 설정 파일의 포맷 상태를 검증할 수 있습니다.
다운로드·설치 방법
GitHub 릴리스 페이지에서 각 플랫폼에 맞는 아카이브 파일을 다운로드하여 사용할 수 있습니다. Windows 환경에서는 다음의 패키지 관리자를 통해 간편하게 설치할 수 있습니다.
- Scoop: scoop bucket add nginxfmt https://github.com/nginxfmt/scoop-bucket 명령어로 저장소를 추가한 후, scoop install nginxfmt 명령어를 실행합니다.
- Winget: winget install nginxfmt.nginxfmt 명령어를 사용합니다.
- Chocolatey: choco install nginxfmt 명령어를 사용합니다.
- Cargo: Rust 사용자는 cargo install nginxfmt 명령어를 통해 소스에서 직접 빌드할 수 있습니다.
기본 사용법
설치 후 명령 프롬프트나 PowerShell에서 다음과 같은 명령어를 사용하여 설정 파일을 포맷팅할 수 있습니다.
- 포맷팅된 결과를 화면에 출력합니다: nginxfmt conf/nginx.conf
- 원본 파일을 직접 수정합니다: nginxfmt –write conf/nginx.conf
- 파일이 올바르게 포맷팅되었는지 확인합니다: nginxfmt –check conf/nginx.conf
프로젝트 루트에 .nginxfmt.toml 파일을 만들어 기본 포맷팅 규칙을 저장할 수도 있습니다.
이런 경우에 유용합니다
- NGINX 설정 파일의 스타일을 팀원 모두에게 일관되게 적용하고 싶을 때
- CI/CD 자동화 파이프라인에서 설정 파일의 문법 서식 검증이 필요할 때
- 대규모 설정 파일의 들여쓰기나 불필요한 빈 줄을 빠르게 정리하고 싶을 때
시스템 요구사항
별도의 시스템 요구사항이 등록되지 않았습니다.


