NestJS 기본 설치 시 .prettierrc 옵션 알아보기

NestJS를 설치하면 프로젝트 루트에 .prettierrc 파일이 생성됩니다. 이 파일은 코드 포맷터인 Prettier의 설정을 정의하며, 코드의 일관된 스타일을 유지하는 데 중요한 역할을 합니다.

.prettierrc 파일이란?

Prettier는 코드 포맷팅을 자동화하여 일관된 코드 스타일을 유지해주는 도구입니다. .prettierrc 파일은 Prettier의 설정을 지정하는 파일로, 프로젝트 내에서 코드 포맷팅 규칙을 정의하고 적용할 수 있습니다.

기본 .prettierrc 내용

{
  "singleQuote": true,
  "trailingComma": "all"
}

각 옵션의 의미

1. singleQuote

• "singleQuote": true
  • 문자열을 나타낼 때 큰따옴표(") 대신 작은따옴표(')를 사용하도록 설정합니다.
  • 예시
    • 설정 적용 전: const message = "Hello, World!";
    • 설정 적용 후: const message = 'Hello, World!';

2. trailingComma

• "trailingComma": "all"
  • 객체, 배열, 함수 매개변수 등에서 마지막 요소 뒤에 쉼표를 추가합니다.
  • 가능한 값
    • "none": 쉼표를 추가하지 않습니다.
    • "es5": ES5에서 유효한 위치에만 쉼표를 추가합니다(객체, 배열).
    • "all": 가능한 모든 위치에 쉼표를 추가합니다(함수 매개변수 등).
  • 예시
    • 설정 적용 전:

      const obj = {
        item1: 'value1',
        item2: 'value2'
      };

    • 설정 적용 후:

      const obj = {
        item1: 'value1',
        item2: 'value2',
      };

추가로 알아두면 좋은 옵션들

1. tabWidth

• 설명: 들여쓰기 시 사용할 공백의 수를 지정합니다.
• 기본값: 2
• 예시:
  • "tabWidth": 4

2. useTabs

• 설명: 들여쓰기에 스페이스 대신 탭을 사용할지 여부를 설정합니다.
• 기본값: false
• 예시:
  • "useTabs": true

3. semi

• 설명: 명령문의 끝에 세미콜론(;)을 추가할지 여부를 설정합니다.
• 기본값: true
• 예시:
  • "semi": false

4. printWidth

• 설명: 한 줄의 최대 길이를 설정합니다.
• 기본값: 80
• 예시:
  • "printWidth": 100

5. bracketSpacing

• 설명: 객체 리터럴에서 중괄호 사이에 공백을 넣을지 여부를 설정합니다.
• 기본값: true
• 예시:
  • "bracketSpacing": false
  • 설정 적용 전: { name: 'John' }
  • 설정 적용 후: {name: 'John'}

6. arrowParens

• 설명: 화살표 함수의 매개변수가 하나일 때 괄호 사용 여부를 설정합니다.
• 가능한 값:
  • "avoid": 필요 없을 경우 괄호를 생략합니다.
  • "always": 항상 괄호를 사용합니다.
• 예시:
  • "arrowParens": "avoid"
    • 설정 적용 전: const greet = (name) => 'Hello ' + name;
    • 설정 적용 후: const greet = name => 'Hello ' + name;