[typescript] Prettier와 데이터베이스 스키마 포맷팅하기

Prettier는 코드를 작성한 후 일관된 형식으로 자동으로 정리해주는 도구입니다. 이는 코드의 가독성을 향상시키고, 협업 시 일관된 코딩 스타일을 유지하는 데 도움이 됩니다. Prettier는 다양한 언어를 지원하며, TypeScript에도 적용할 수 있습니다.

TypeScript에 Prettier 적용하기

먼저 프로젝트에 Prettier를 설치합니다.

npm install --save-dev prettier

그리고 프로젝트 루트 디렉토리에 .prettierrc 파일을 생성하여 Prettier의 설정을 지정합니다.

{
  "semi": true,
  "singleQuote": true,
  "tabWidth": 2,
  "printWidth": 80,
  "arrowParens": "always"
}

이제 TypeScript 파일에 Prettier를 적용하려면, 다음 명령어를 사용합니다.

npx prettier --write 'src/**/*.ts'

이제 코드를 수정하면 Prettier가 설정에 따라 자동으로 형식을 맞춰줄 것입니다.

데이터베이스 스키마 포맷팅

데이터베이스의 스키마도 가독성이 중요합니다. 스키마가 복잡해지면, 테이블 간의 관계나 컬럼들을 파악하기가 어려워집니다. 이때도 Prettier의 도움을 받아 테이블 정의를 일관된 형식으로 표현할 수 있습니다.

예를 들어, PostgreSQL의 스키마를 Prettier로 정리하는 방법은 pgFormatter를 사용하는 것입니다. 이 도구는 PostgreSQL의 스키마를 일관된 형식으로 재정렬해주는데, stdin에서 데이터를 읽고 stdout으로 정리된 데이터를 출력할 수 있습니다.

pg_dump mydb | pg_format > mydb.sql

이렇게 하면 mydb.sql 파일에 정리된 스키마가 출력됩니다.

Prettier는 코드뿐만 아니라 다양한 형식의 파일에 대해서도 적용할 수 있어, 소스 코드 외에도 데이터베이스 스키마 등의 정리에 유용하게 활용될 수 있습니다.