ゼロから始めるDjangoソースコード解読 part4

解読

.pre-commit-config.yaml

概要

Gitには、pre-commitフックというコミット時に特定のスクリプトを実行する機能があります。 既にGitHubリポジトリにいくつかのチェック用コードが存在しており、それらを指定することで チェックが通らない場合は自動でコードを修正したり、Commitを実行しないようにすることができます。 .pre-commit-config.yamlには、どのチェック項目を適用するかなどを設定します。

詳細

repos:
  - repo: https://github.com/PyCQA/isort
    rev: 5.6.4
    hooks:
      - id: isort
  - repo: https://gitlab.com/pycqa/flake8
    rev: 3.8.4
    hooks:
      - id: flake8
  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v7.16.0
    hooks:
      - id: eslint

.pre-commit-config.yamlのオプション

項目	内容
repos	リポジトリごとの設定を格納するためのリスト
repo	使用したいフックスクリプトのリポジトリを指定。
rev	repoで指定したリポジトリのバージョンもしくはタグを指定
hooks	使用するフックを格納するためのリスト
id	使用するフックを指定

フックの説明

項目	内容
isort	pythonのimportの順番をチェックする。自動で整形してくれる。
flake8	pep8のチェック、pyflakesのチェック、及び循環的複雑度をチェックできるラッパー。様々な拡張機能が存在する
eslint	JavaScript のための静的検証ツール

AUTHORS

概要

Django開発に携わった人の一覧。

CONTRIBUTING.rst

概要

Djangoをよりよくするために、バグ修正やコードパッチ、ドキュメントの改善を手伝ってくれる方のために、案内を記載してある。

終わりに

pre-commitは普通に業務に使える内容だったので、早速取り入れようと思う。

AUTHORSとCONTRIBUTING.rstはほとんど見る機会はないだろうから、頭の片隅に覚えておければいいかな。

それではまた次回。