코드 포맷팅은 프로젝트를 유지보수하는 동안 큰 이점을 제공합니다. 코드베이스를 일관되게 유지하고 가독성을 높일 수 있기 때문에 팀원 간의 협업이나 새로운 프로젝트에 참여하는 사람들에게 매우 유용합니다. JavaScript 및 TypeScript 프로젝트에서 Prettier와 함께 작업하는 것이 일반적이지만 Kotlin 프로젝트에서도 Prettier를 통합할 수 있습니다.

Prettier란?

Prettier는 코드 포맷팅 도구로서, 공식적으로 JavaScript, TypeScript, CSS, JSON, GraphQL 및 Markdown를 지원합니다. Kotlin 코드의 경우 Prettier가 직접 지원하지는 않지만, Kotlin 코드를 지원하는 플러그인과 함께 사용할 수 있습니다.

이번 포스트에서는 Kotlin 프로젝트에서 Prettier를 설정하고 코드 포맷팅을 자동화하는 방법에 대해 알아보겠습니다.

Prettier 플러그인 설치

먼저, Kotlin 코드에서 Prettier를 사용하기 위해 플러그인을 설치해야 합니다. Kotlin 코드에서 Prettier를 사용하는 방법은 아래와 같습니다.

npm install --save-dev prettier
npm install --save-dev --save-exact prettier-plugin-kotlin

위 명령어를 사용하여 prettier 및 prettier-plugin-kotlin 플러그인을 프로젝트에 추가합니다.

Prettier 설정 파일 만들기

프로젝트 루트 디렉토리에 .prettierrc라는 파일을 생성하고, Kotlin 코드에 맞는 Prettier 설정을 추가합니다.

{
  "overrides": [
    {
      "files": "*.kt",
      "options": {
        "parser": "kotlin"
      }
    }
  ]
}

이 설정에서는 .kt 확장자를 가진 파일이 Kotlin 코드로 간주되도록 하고, kotlin 파서를 사용하도록 지시하고 있습니다.

자동 코드 포맷팅 설정

프로젝트에 Prettier를 사용하여 코드를 자동으로 포맷하는 것이 중요합니다. 따라서 package.json 파일에 다음과 같은 스크립트를 추가하여 코드를 포맷팅할 수 있도록 설정합니다.

{
  "scripts": {
    "format": "prettier --write ."
  }
}

이제 npm run format 명령어를 사용하여 프로젝트의 모든 파일을 Prettier로 자동 포맷팅할 수 있습니다.

결론

이제 Kotlin 프로젝트에서도 Prettier를 사용하여 코드를 일관되게 유지할 수 있습니다. Prettier 플러그인을 설치하고 설정 파일을 만들고, 자동 코드 포맷팅 스크립트를 추가함으로써 프로젝트의 코드 품질을 향상시킬 수 있습니다. 코드베이스가 커지고 여러 명의 개발자가 참여하는 프로젝트에서는 특히 Prettier의 이점을 눈에 띄게 느낄 수 있습니다.