Python/Utils

[Utils] Custom Pre-commit hook 구현

yubi5050 2023. 6. 24. 17:45

Custom Pre-commit Hook 구현하기

👉 사용 사례

- API 문서 배포시 자동으로 error 코드가 적힌 html 문서가 같이 만들어 지도록 hook 에 추가 

- hook은  (.py) 파일 구현

 

👉 구현 방법

- repo : local 값

- id와 name 설정 및 entry 로 .py 실행 

- language : python 설정

# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
repos:
    # make error code html
-   repo: local
    hooks:
    -   id: make-error-enum-html
        name: make-error-enum-html
        entry: python3 /common/enums/errors/enum_to_html.py
        language: python
        always_run: true
        
    # pre-commit 기본 제공 hook
-   repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.4.0
    hooks:
    -   id: trailing-whitespace
    -   id: end-of-file-fixer
    -   id: check-yaml
    -   id: check-added-large-files

    # Code Formatter
-   repo: https://github.com/psf/black
    rev: 23.1.0
    hooks:
    -   id: black