<h3 id="%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB">
<a class="header-anchor-link" href="#%E3%81%AF%E3%81%98%E3%82%81%E3%81%AB" aria-hidden="true"></a> はじめに</h3>
<p>平下CTO@sweeepです。Go言語でGitHubなどへpushする前にmakeコマンドでprecommitをする方法をこちらをサンプルに解説します。→ <a href="https://zenn.dev/hirac/articles/dc537f0786cae9" target="_blank">GoでファイルのValidation方法など</a></p>
<p>本記事の内容です。</p>
<ul>
<li>precommitの内容</li>
<li>makeコマンドでprecommit一括実行</li>
<li>実行結果</li>
<li>PR時のprecommit checkリスト</li>
</ul>
<h3 id="precommit%E3%81%AE%E5%86%85%E5%AE%B9">
<a class="header-anchor-link" href="#precommit%E3%81%AE%E5%86%85%E5%AE%B9" aria-hidden="true"></a> precommitの内容</h3>
<p>precommit時のそれぞれの整形/linter/チェックについて以下記します。</p>
<ul>
<li>goimports: Go言語の標準パッケージでパッケージのインポートを整形し、また、gofmtのルールでコードを整形します。</li>
</ul>
<div class="code-block-container"><pre><code>$ find . -print | grep --regex '.*\.go' | xargs goimports -w -local "github.com/hirac1220/go-file/utils"
</code></pre></div><ul>
<li>fmt: Go言語の標準パッケージでコードを整形します。</li>
</ul>
<div class="code-block-container"><pre><code>$ go fmt ./...
</code></pre></div><ul>
<li>vet: Go言語標準パッケージで静的解析します。</li>
</ul>
<div class="code-block-container"><pre><code>$ go vet ./...
</code></pre></div><ul>
<li>errcheck: エラーハンドリングされていないエラーをチェックします。</li>
</ul>
<div class="code-block-container"><pre><code>$ errcheck
</code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__4e47014e204a2" src="https://embed.zenn.studio/card#zenn-embedded__4e47014e204a2" data-content="https%3A%2F%2Fgithub.com%2Fkisielk%2Ferrcheck" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/kisielk/errcheck" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/kisielk/errcheck</a></p>
<ul>
<li>staticcheck: こちらもGo言語を静的解析します。</li>
</ul>
<div class="code-block-container"><pre><code>$ staticcheck ./...
</code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__4a0998c8bd8a5" src="https://embed.zenn.studio/card#zenn-embedded__4a0998c8bd8a5" data-content="https%3A%2F%2Fstaticcheck.io%2Fdocs%2Fgetting-started%2F" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://staticcheck.io/docs/getting-started/" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://staticcheck.io/docs/getting-started/</a></p>
<ul>
<li>gosec: ソースコードをスキャンして、セキュリティの問題についてチェックします。</li>
</ul>
<div class="code-block-container"><pre><code>$ gosec ./...
</code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__24a22441d97fe" src="https://embed.zenn.studio/card#zenn-embedded__24a22441d97fe" data-content="https%3A%2F%2Fgithub.com%2Fsecurego%2Fgosec" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/securego/gosec" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/securego/gosec</a></p>
<ul>
<li>golangci-lint: Go言語の多くのlinterを搭載しています。こちらで他のlinterまかなうことも。</li>
</ul>
<div class="code-block-container"><pre><code>$ golangci-lint run ./...
</code></pre></div><p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__1cef40e489966" src="https://embed.zenn.studio/card#zenn-embedded__1cef40e489966" data-content="https%3A%2F%2Fgithub.com%2Fgolangci%2Fgolangci-lint" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/golangci/golangci-lint" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/golangci/golangci-lint</a></p>
<ul>
<li>それぞれインストール<br>
それぞれのパッケージのインストールコマンドです。必要に応じてインストール実施してください。</li>
</ul>
<div class="code-block-container"><pre><code>$ go install golang.org/x/tools/cmd/goimports@latest
$ go install github.com/kisielk/errcheck@latest
$ go install honnef.co/go/tools/cmd/staticcheck@latest
$ brew install golangci-lint
$ brew upgrade golangci-lint
$ curl -sfL https://raw.githubusercontent.com/securego/gosec/master/install.sh | sh -s -- -b $(GOPATH)/bin latest
</code></pre></div><p>makeコマンドにしてあるので、一括インストールも可能です。</p>
<div class="code-block-container"><pre><code>$ cd utils/file
$ make install
</code></pre></div><h3 id="make%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%81%A7precommit%E4%B8%80%E6%8B%AC%E5%AE%9F%E8%A1%8C">
<a class="header-anchor-link" href="#make%E3%82%B3%E3%83%9E%E3%83%B3%E3%83%89%E3%81%A7precommit%E4%B8%80%E6%8B%AC%E5%AE%9F%E8%A1%8C" aria-hidden="true"></a> makeコマンドでprecommit一括実行</h3>
<p>GitHubへpushする前にmakeコマンドで下記precommitを一括実施します。hookして自動でprecommitをかけることも可能ですが、Draft PRなどでとりあえずのpushしたいこともあり、マニュアル運用としています（自動化はGitHub側のreviewdogなど導入予定）。</p>
<p>以下がMakefileの定義となります。</p>
<div class="code-block-container">
<div class="code-block-filename-container"><span class="code-block-filename">utils/file/Makefile</span></div>
<pre class="language-makefile"><code class="language-makefile"><span class="token comment"># precommit check</span>
<span class="token target symbol">precommit</span><span class="token punctuation">:</span> goimports fmt errcheck staticcheck gosec

<span class="token target symbol">goimports</span><span class="token punctuation">:</span>
	find . -print <span class="token operator">|</span> grep --regex <span class="token string">'.*\.go'</span> <span class="token operator">|</span> xargs goimports -w -local <span class="token string">"github.com/hirac1220/go-file/utils"</span>

<span class="token target symbol">fmt</span><span class="token punctuation">:</span>
	go fmt ./...

<span class="token target symbol">vet</span><span class="token punctuation">:</span>
	go vet ./...

<span class="token target symbol">errcheck</span><span class="token punctuation">:</span>
	errcheck

<span class="token target symbol">staticcheck</span><span class="token punctuation">:</span>
	staticcheck ./...

<span class="token target symbol">golangci</span><span class="token punctuation">:</span>
	golangci-lint run ./...

<span class="token target symbol">gosec</span><span class="token punctuation">:</span>
	gosec ./...
</code></pre>
</div><h3 id="precommit%E5%AE%9F%E8%A1%8C%E7%B5%90%E6%9E%9C">
<a class="header-anchor-link" href="#precommit%E5%AE%9F%E8%A1%8C%E7%B5%90%E6%9E%9C" aria-hidden="true"></a> precommit実行結果</h3>
<p>以下makeコマンドで実行します。</p>
<div class="code-block-container"><pre><code>$ cd utils/file
$ make precommit
</code></pre></div><p>precommit実行結果は以下のようになります。</p>
<div class="code-block-container"><pre><code>$ make precommit
find . -print | grep --regex '.*\.go' | xargs goimports -w -local "github.com/hirac1220/go-file/utils"
go fmt ./...
errcheck
staticcheck ./...
gosec ./...
[gosec] 2022/03/21 18:32:15 Including rules: default
[gosec] 2022/03/21 18:32:15 Excluding rules: default
[gosec] 2022/03/21 18:32:15 Import directory: /Users/kimi/go/src/github.com/hirac1220/go/go-file-validate/utils/file
[gosec] 2022/03/21 18:32:16 Checking package: file
[gosec] 2022/03/21 18:32:16 Checking file: /Users/kimi/go/src/github.com/hirac1220/go/go-file-validate/utils/file/file.go
Results:


Summary:
  Gosec  : 2.9.3
  Files  : 1
  Lines  : 66
  Nosec  : 0
  Issues : 0

</code></pre></div><h3 id="pr%E6%99%82%E3%81%AEprecommit-check%E3%83%AA%E3%82%B9%E3%83%88">
<a class="header-anchor-link" href="#pr%E6%99%82%E3%81%AEprecommit-check%E3%83%AA%E3%82%B9%E3%83%88" aria-hidden="true"></a> PR時のprecommit checkリスト</h3>
<p>プルリクエストテンプレートをリポジトリのルートディレクトリで作成し、PR時にprecommit実施したかチェックするようにします。<br>
添付のように、リポジトリのcreate new fileで.github/pull_request_template.mdを作成し、以下を記入します。</p>
<div class="code-block-container"><pre><code>### レビュー前チェック
- [ ] make precommit

</code></pre></div><p><img src="https://res.cloudinary.com/zenn/image/fetch/s--jxU7Ze4P--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/b34d94f19a46cf017e557fca.png%3Fsha%3D3f82af64690c2582dbecafdd7af0010e95429c90" alt loading="lazy" class="md-img"></p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__8f44856e13fbd" src="https://embed.zenn.studio/card#zenn-embedded__8f44856e13fbd" data-content="https%3A%2F%2Fdocs.github.com%2Fja%2Fcommunities%2Fusing-templates-to-encourage-useful-issues-and-pull-requests%2Fcreating-a-pull-request-template-for-your-repository" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://docs.github.com/ja/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository</a></p>
<p>PR実施すると添付のようにprecommitチェックリストが表示されます。<br>
<img src="https://res.cloudinary.com/zenn/image/fetch/s--55fmK8Od--/c_limit%2Cf_auto%2Cfl_progressive%2Cq_auto%2Cw_1200/https://storage.googleapis.com/zenn-user-upload/deployed-images/9b38a28fe16c43eac39bd6f0.png%3Fsha%3D03e418064309fdfe9b8b75f8857dfdac4c63e5ce" alt loading="lazy" class="md-img"></p>
<h3 id="%E3%81%BE%E3%81%A8%E3%82%81">
<a class="header-anchor-link" href="#%E3%81%BE%E3%81%A8%E3%82%81" aria-hidden="true"></a> まとめ</h3>
<p>今回はGo言語でのGitHubなどへpushする前にmakeコマンドでprecommitをする方法を解説しました。今後はprecommitと同等の設定をしたreviewdogなど導入し、precommitせずにPRすると自動でコメントしてもらうようにしていきたいです。</p>
<p><span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__07403529d772a" src="https://embed.zenn.studio/card#zenn-embedded__07403529d772a" data-content="https%3A%2F%2Fgithub.com%2Freviewdog%2Freviewdog" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/reviewdog/reviewdog" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/reviewdog/reviewdog</a></p>
<p>今回使用したサンプルはこちらのGitHubレポジトリにあります。<br style="display:none">
<span class="embed-block zenn-embedded zenn-embedded-card"><iframe id="zenn-embedded__2ab567456326" src="https://embed.zenn.studio/card#zenn-embedded__2ab567456326" data-content="https%3A%2F%2Fgithub.com%2Fhirac1220%2Fgo-file-validate" frameborder="0" scrolling="no" loading="lazy"></iframe></span><a href="https://github.com/hirac1220/go-file-validate" style="display:none" target="_blank" rel="nofollow noopener noreferrer">https://github.com/hirac1220/go-file-validate</a></p>


GoでGitHubへpushする前にmakeコマンドでprecommitする方法

Discussion