티스토리 뷰

PyCharm(IntelliJ라도 상관없음)에서 YAML(yet another markup language or YAML ain't markup language) 파일을 열어보면 다음과 같이 syntax highlighting이 잘 적용되어 있습니다.

nginx-deployment.yaml (https://kubernetes.io/docs/concepts/workloads/controllers/deployment/)

 

아마도 대부분의 사람들은 "IDE에서 syntax highlighting은 당연한 기능 아냐?"라고 하실 수도 있는데요. 맞습니다. 확장자에 따라서 기본 설정이 적용되어 있기 때문입니다. 최근에 테라폼(Terraform)으로 코드를 개발하면서 YAML 파일을 템플릿 형식으로 작성할 일이 꽤 많았는데요. 확장자는 tftpl 였습니다. 테라폼에서 templatefile 함수를 통해 읽는 파일의 확장자는 tftpl로 권장됩니다.

*.tftpl is the recommended naming pattern to use for your template files.

 

그냥 무작정 확장자를 tftpl로 생성하게 되면 아래와 같이 syntax highlighting 없이 일반 텍스트로 노출됩니다. 데이터가 눈에 제대로 들어오지 않기 때문에 마음이 아주 불편해집니다. 

nginx-deployment.tftpl

 

이럴 때는 IDE의 기본 설정을 변경해서 tftpl인 경우 YAML로 인식되도록 해주면 됩니다. 먼저 Preferences를 열고 Editor > File Types에서 YAML을 찾아주세요. 거기에 더하기(+) 기호를 눌러서 *.tftpl 을 추가해 주시면 됩니다.

더하기(+) 기호를 눌러서 *.tftpl을 추가합니다

 

이렇게 설정을 마치고 나면 tftpl 확장자도 yaml로 인식되어 편안하게 개발하실 수 있습니다.

편-안

 

이런 기본적인걸 몰라서 테라폼의 권장 사항 확장자명을 무시하고 그냥 yaml로 쓸까를 고민했었는데 부끄러워지네요. 뭐 이런 거 하나씩 배워나가는 게 개발의 부수적인 재미요소겠지요. 다른 확장자로 응용도 가능하니 필요한 곳에 적절히 사용해 보시길 바랍니다. :-) 

댓글
최근에 올라온 글
최근에 달린 댓글
글 보관함
Total
Today
Yesterday