【Hugo】フロントマターで定義した値の入力をGitフックで強制する

Hugoのフロントマターの値の入力を強制させるためにGitフックを使ったのでそのメモです

Hugoのフロントマターとは

公式Docs:https://gohugo.io/content-management/front-matter/
フロントマター（front matter）はmdファイルの先頭に書くもので、これを使うことで、mdファイルのメタデータを設定することができます。
フロントマターの記述方法は、TOML, YAML, JSON, ORG形式の４つあり、そのうちどれかを選ぶことができます。（自分はYAML形式）
フロントマターの変数には、定義済みのもの（date, draft, imagesなど）と自分で自由に定義できるものがあります。
Hugoには、Archetypesというmdファイルを作る際のテンプレートのようなものがあり、このArchetypesにフロントマターも設定しておくことで、いちいち最初からフロントマターやその変数をちまちま書く必要がなくなります。

私は自分の日報とちょっとしたメモや記事置き場としてHugoを使った個人ブログをやっており、 Archetype内フロントマターは以下のように設定しています。
個人ブログ

• 日報のフロントマター

---
title: {{ .Name | time.Format .Site.Params.DateFormat }} # DataFormatで指定した形式の日時がタイトルになる
date: {{ .Date }} # hugo new でmdファイルを作成したときの日時が入る
categories: "日報"
draft: false

score: # 自分で定義した変数。1日の評価を0から10で指定する
---

フロントマターで定義した変数に値を設定することをGitフックを使って強制する

フロントマターにはさまざまな変数を設定することができます。
個人ブログの日報では、その日1日の評価を0から10の間で評価するためにscoreを独自の変数として定義しています。
scoreごとに日報一覧表示させたときに表示する色を変え、視覚的にその日どれくらい頑張ったかをわかりやすくする、ということをしています。
具体的には、0~4だと青、5~7だと緑、8~9だとピンク、10だと赤、という感じです。

そのため、scoreには0から10の範囲の数字を設定する必要があります。
しかし、Hugoでは変数の値の設定を強制することは機能として提供していないため（私調べ）、たびたびscoreを設定しないまま日報を公開してしまうことがありました。
そこで、Gitフックを使って、コミットする前にscoreに値が設定されているかどうかをチェックし、されていなかったらコミットを中止するような仕組みを作ることにしました。

書いたフックスクリプトは次のとおりです。

pre-commit

#!/bin/bash

score_regex='^score: (10|[0-9])'

# daily-reports以下のmdファイルにscoreを0-10で指定していることをチェックする
is_can_commit=true
for file in $(git diff --name-only --cached | grep 'content/daily-reports/.*\.md$'); do
    line=$(awk 'NR==7' "$file")
    if [[ !("$line" =~ $score_regex) ]]; then
	      is_can_commit=false
        echo "$file にscoreが0-10で指定されていないよ"
    fi
done

if ! $is_can_commit; then
  echo "日報のmdファイルにscoreを指定してからコミットしてください"
  exit 1
fi

• ステージングに追加された変更されたファイルのうち（git diff --name-only --cached）
• content/daily-reports/ディレクトリ以下のmdファイルの（grep 'content/daily-reports/.*\.md$'）
• ７行目が（line=$(awk 'NR==7' "$file")）
• scoreで始まり、0〜10のいずれかでおわる（"$line" =~ $score_regex）

ことをチェックし、もしそうなっていないファイルがあれば、scoreが0から10で指定されていない旨を出力し、コミットを中止します。
実際に、scoreに値を設定せずにステージングしコミットしようとした時の出力はこちらです。

シェルスクリプトはほとんど書いたことがないので良くない書き方をしてる部分が多いかもしれません。
お気づきの点がありましたらコメントなどでご指摘いただけると幸いです🙏

GitフックをGit管理する

デフォルトだと、Gitフックのフックスクリプトは.git/hooks以下に定義されており、Git管理することができません。
しかし、（個人ブログから必要ないかもしれないけど）GitフックもGit管理したかったので以下のことをしました。

• .githooksディレクトリを作る
• .githooksディレクトリのなかにpre-commitを作成し、上で紹介したフックスクリプトを記述する
• git config --local core.hooksPath .githooksでフックスクリプトの場所を.githooks以下であると設定する

これでGit管理できるようになりました。
参考にさせていただいた記事はこちらです：https://www.farend.co.jp/blog/2020/04/git-hook/

終わり

やったこととしては以上です。何かお気づきの点がありましたらぜひ教えてください。
最後までお読みいただきありがとうございました。