git pre-commit

date: 2023-12-23 excerpt: pre-commitの使い方

pre-commitの使い方

概要

git commit時に、コミット前に何か処理を実行することができる
- 例えば、コードのフォーマットを自動で行う

インストール

macOS

$ brew install pre-commit

ubuntu, debian

$ pipx install pre-commit

レポジトリに設定

リポジトリのルートに.pre-commit-config.yamlを作成
.pre-commit-config.yamlに、実行したいコマンドや設定を記述
pre-commit installを実行して設定を有効化

手動で実行

$ pre-commit run --all-files

設定例

ruffでリントを実行

repos:
  - repo: https://github.com/astral-sh/ruff-pre-commit
    # Ruff version.
    rev: v0.1.9
    hooks:
      # Run the linter.
      - id: ruff
        types_or: [ python, pyi, jupyter ]
        args: [ --fix ]
      # Run the formatter.
      - id: ruff-format
        types_or: [ python, pyi, jupyter ]