pre-commit

pre-commit이란?

우리는 git이란 협업툴을 사용한다. 이때 우리는 우리가 지금까지 했던 수정사항이나 변동사항들을, commit이라는 행위를 통해 git에 저장하고 또다른 작업을 이어나간다.

주로 pre-commit은 commit을 진행하기 전에 간단하게 code 리뷰를 하기 위해서 쓰인다.

pre-commit의 사용예시 - code formating, test

A,B,C가 공동작업을 하는데 있어서, 각자 고유의 코딩스타일이 있을 것이다. 어디서 들여쓰기를 할것인지 변수명 규칙 등 다양한 곳에서 다를 부분이 있을것이다.

pre-commit은 이러한 것을 통일성있는 모양새를 만들어준다.

이때 정말 간단한 세미콜론 누락 등 간단한 error들을 잡아 줄 수도 있다.

이를 통해 개발자들이나 회사에서 code 품질을 일관되게 유지하고 문제상황에 대비할 수 있다.

pre-commit의 설치

$ pip install pre-commit

# 잘 설치가 되었는지 확인하기 위해서 version을 체크해보자.
$ pre-commit --version
pre-commit 3.3.3

pre-commit configuration의 사용

이제 pre-commit-config를 사용하기 위해서 우리는 .pre-commit-config.yaml 파일을만들어 사용해야한다.

$ touch .pre-commit-config.yaml

## example을 보고싶다면 아래와 같이 입력해서 example을 볼수 있다.
$ pre-commit sample-config

형식은 다음과 같다.

repos:
-   repo: <https://github.com/pre-commit/pre-commit-hooks>
    rev: v2.3.0
    hooks:
    -   id: check-yaml
    -   id: end-of-file-fixer
    -   id: trailing-whitespace
-   repo: <https://github.com/psf/black>
    rev: 22.10.0
    hooks:
    -   id: black