위키득계정 ↗
기술

Yamllint

Yamllint기술
검사 대상
YAML 문서
주요 검사
구문과 형식 규칙
진단 유형
오류와 경고
연계 환경
편집기와 변경 사항 검사 과정
Yamllint는 YAML 문서의 구문과 작성 형식을 검사하는 도구다. 중복 키와 들여쓰기, 줄 길이와 줄 끝 공백 등을 규칙에 따라 확인해 설정 파일의 오류와 형식 불일치를 찾는다.

문법 외의 문제 찾기

YAML 문법에 맞는 파일에서도 키가 반복되거나 작성 형식이 들쭉날쭉할 수 있다. Yamllint는 구문 유효성뿐 아니라 이런 부분을 함께 검사한다. 같은 파일을 여러 사람이 수정할 때 표기 방식의 차이를 확인하는 용도로도 사용할 수 있다.

규칙으로 정하는 형식

들여쓰기와 빈 줄, 문서 시작과 끝의 표시 등 검사 항목이 나뉘어 있다. 따옴표와 줄 끝 공백, 키 중복 같은 규칙도 제공한다. 기본 설정을 확장하거나 별도 설정을 적용하고 특정 경로를 검사에서 제외하는 기능으로 프로젝트에 맞는 기준을 구성할 수 있다.

다른 검사와의 관계

편집기에 연결하거나 커밋 전 검사와 CI에서 사용할 수 있다. 다만 YAML 형식이 올바르다는 사실이 그 파일을 읽는 서비스의 모든 설정이 유효하다는 뜻은 아니다. 예를 들어 워크플로의 입력과 작업 관계는 해당 시스템을 이해하는 별도의 검사 대상이 될 수 있다.

관련 문서

Actionlint / Taplo / Hadolint / YAML / Markdownlint