이 문서에서는 TypeScript 프로젝트에서 사용되는 Prettier와 Ruby on Rails 프로젝트의 코드 스타일을 통합하는 방법에 대해 설명합니다.
1. Prettier란 무엇인가?
Prettier는 코드를 자동으로 포맷팅하여 일관된 스타일을 유지하는 데 도움을 주는 도구입니다. JavaScript, TypeScript, CSS, JSON, GraphQL 등 다양한 언어를 지원하며, 프로젝트에 적합한 스타일 구성을 제공합니다.
2. TypeScript 프로젝트에 Prettier 통합하기
TypeScript 프로젝트에서 Prettier를 사용하려면, 먼저 아래 명령을 사용하여 Prettier를 설치합니다.
npm install --save-dev --save-exact prettier
그런 다음, 프로젝트 루트 디렉토리에 .prettierrc 파일을 만들고 원하는 포맷 설정을 추가합니다. 예를 들어:
{
"singleQuote": true,
"semi": false
}
이제, package.json 파일에 스크립트를 추가하여 Prettier를 실행하고, 코드를 자동으로 포맷할 수 있습니다.
{
"scripts": {
"format": "prettier --write 'src/**/*.ts'"
}
}
3. Ruby on Rails 프로젝트에 Prettier 통합하기
Ruby on Rails에서는 Prettier만으로는 코드 스타일을 유지할 수 없지만, rubocop-prettier 젬을 사용하여 Prettier 플러그인을 통합할 수 있습니다.
Gemfile에 아래와 같이 추가합니다:
group :development, :test do
gem 'rubocop'
gem 'rubocop-prettier'
end
그런 다음, 터미널에서 bundle install 명령을 실행하여 젬을 설치합니다.
이제 프로젝트 루트 디렉토리에 .rubocop.yml 파일을 만들고 아래 내용을 추가합니다:
require: rubocop-prettier
AllCops:
TargetRubyVersion: # your_ruby_version
이렇게 하면 Ruby on Rails 프로젝트에서 Prettier를 사용하여 코드를 포맷할 수 있게 됩니다.
4. TypeScript 및 Ruby on Rails 프로젝트 통합하기
TypeScript 및 Ruby on Rails 프로젝트에서 사용되는 Prettier 설정이 상이한 경우, 프로젝트 루트 디렉토리에 각각 .prettierrc 및 .rubocop.yml 파일을 만들어 각 프로젝트에 맞는 포맷 설정을 추가하면 됩니다.
이제 TypeScript와 Ruby on Rails 프로젝트에서 Prettier를 함께 사용할 수 있게 되었습니다. 코드 스타일이 일관되게 유지되므로 개발자들은 스타일에 대해 걱정할 필요가 없어지고 코드 리뷰 과정이 보다 효율적으로 진행될 수 있습니다.
참고 문헌: