Ruby용 사전 커밋 후크 가이드

Note: This guide assumes you are using rubocop for linting and RSpec for testing

Git 후크 스크립트는 코드 검토에 제출하기 전에 간단한 문제를 식별하는 데 유용합니다. 모든 커밋에서 후크를 실행하여 세미콜론 누락, 후행 공백 및 디버그 문과 같은 코드의 문제를 자동으로 지적합니다. 코드 검토 전에 이러한 문제를 지적함으로써 코드 검토자는 사소한 스타일의 nitpick으로 시간을 낭비하지 않고 변경 아키텍처에 집중할 수 있습니다.

설치

홈브류 사용:

brew install pre-commit

구성

프로젝트 루트에 .pre-commit-config.yaml라는 파일을 만듭니다.

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.3.0
    hooks:
      - id: trailing-whitespace
      - id: end-of-file-fixer
  - repo: https://github.com/mattlqx/pre-commit-ruby
    rev: v1.3.5
    hooks:
      - id: rubocop
      - id: rspec

업데이트된 구성 및 토론 스레드는 GitHub.에서 유지됩니다.

git hook 설치

pre-commit install

now pre-commit will run automatically on git commit

모든 파일에 대해 실행

사전 커밋은 git 커밋 중에 변경된 파일에서만 실행됩니다.

모든 파일에서 실행하려는 경우:

pre-commit run --all-files

요구 사항에 따라 사전 커밋을 자유롭게 구성하십시오.

Supported hooks

Official Website

Official Demo


라이센스: AGPL-3.0-or-later