YAML은 인간이 쉽게 읽고 쓸 수 있는 데이터 직렬화 형식입니다. 프로젝트에서 YAML 파일을 사용할 때, 파일이 일관된 형식을 유지하는 것이 중요합니다. 이때 Prettier를 사용하여 YAML 파일의 형식을 일관되게 유지할 수 있습니다. 이 포스트에서는 TypeScript 백엔드 프로젝트에서 Prettier를 사용하여 YAML 파일을 형식 지정하는 방법에 대해 알아보겠습니다.

Prettier란?

Prettier는 코드를 자동으로 형식 지정해주는 도구입니다. 프로젝트에서 Prettier를 사용하면 코드를 일관된 형식으로 유지할 수 있으며, 코드 포맷팅에 드는 시간을 절약할 수 있습니다. TypeScript와 같은 다양한 언어를 지원하며, 설정이 간단하여 쉽게 프로젝트에 통합할 수 있습니다.

Prettier와 YAML

Prettier는 JavaScript, TypeScript를 비롯한 여러 언어의 코드를 형식 지정할 수 있지만, YAML 형식을 직접 지원하지는 않습니다. 그러나 prettier-plugin-yaml 플러그인을 사용하면 Prettier가 YAML 파일의 형식을 지정하는 데 사용될 수 있습니다.

Prettier와 TypeScript 프로젝트에 YAML 형식 지정하기

먼저, 프로젝트에 Prettier와 prettier-plugin-yaml을 설치합니다.

npm install --save-dev prettier prettier-plugin-yaml

그런 다음 프로젝트 루트에 .prettierrc 파일을 만들고 다음과 같이 설정합니다.

{
  "plugins": ["prettier-plugin-yaml"]
}

이제 YAML 파일을 작성하고 저장하면 Prettier가 해당 파일을 형식 지정할 것입니다. 추가적으로, Prettier를 통합하여 코드를 자동으로 형식 지정해주는 것이 좋습니다. 이렇게 하면 프로젝트에서 YAML 파일이 항상 일관된 형식을 유지할 수 있게 됩니다.

마무리

이제 TypeScript 프로젝트에서 Prettier를 사용하여 YAML 파일을 형식 지정하는 방법을 알아보았습니다. Prettier는 코드 형식 지정을 자동화하여 팀원 간의 협업을 더욱 효율적으로 만들어 줍니다.

더 많은 정보는 Prettier 공식 문서를 참고해주세요.