[Django] Pycharm code formatter 적용

코딩은 돈이 된다·2024년 7월 2일

이전에 Spring boot로 협업을 진행할 때 google_checks.xml을 받아서 사용했었다.
코드 스타일을 통일하는데 굉장히 편했어서 Django에도 있지 않을까 해서 찾아보게 되었다.

Black

바로 설치부터 적용까지 해보겠다.

1. 설치

pip install black

이건 가상환경 내에서 실행해야한다.(django 프로젝트에서 사용하기 때문)

# mac
which black

# window
where black

black이 설치된 위치를 찾아둔다.
-> 이후에 사용해야하니까 복사해두는 것을 추천한다.
mac의 경우에는 black으로 끝나고 window의 경우에는 black.exe로 끝날 것이다.

2. 적용

  1. 우선 file watcher라는 플러그인을 설치해준다.
  1. setting → tools → file watcher + 버튼 클릭후 custom으로 생성해준다.

$ 붙은 것들은 매크로라서 그대로 두면 된다.
name은 상관없으나 알아보기 편하게 나는 Black으로 작성했다.
Advanced Options에서 맨 위 두 항목이 체크되어 있을텐데 체크를 해제해야한다.

  1. enabled 체크하고 apply

이렇게까지 하면, 앞으로 코드를 저장할 때에 지정된 포맷대로 수정된다.

코드 스타일 통일 툴을 이용하여 협업에 드는 시간을 줄이자

0개의 댓글