{ "componentChunkName": "component---src-templates-blog-post-js", "path": "/2022-07-04_deno-velociraptor-git-hooks/", "result": {"data":{"site":{"siteMetadata":{"title":"365"}},"markdownRemark":{"id":"f5c024a2-841b-5300-951a-530664d5e1be","excerpt":"最近 Deno + deno-cliffy を使った CLI プロジェクトの開発を行っている まだ勝手に慣れてなくてコードフォーマッタを適用していない状態でコミットをしてしまう失敗をしてしまったので Git Hooks を導入したくなった 調べると Velociraptor という Deno 用タスクランナーに Git…","html":"

最近 Deno + deno-cliffy を使った CLI プロジェクトの開発を行っている
\nまだ勝手に慣れてなくてコードフォーマッタを適用していない状態でコミットをしてしまう失敗をしてしまったので Git Hooks を導入したくなった
\n調べると Velociraptor という Deno 用タスクランナーに Git Hooks の機能があったため使ってみることにした

\n

インストールからバージョン確認まで

\n

https://velociraptor.run/docs/installation/

\n

インストール

\n
$ deno install -qAn vr https://deno.land/x/velociraptor@1.5.0/cli.ts
\n

パス設定

\n
export PATH="/home/vagrant/.deno/bin:$PATH"
\n

バージョン確認

\n
$ vr --version\n1.5.0
\n

書いてみる

\n

https://velociraptor.run/docs/configuration/
\nhttps://velociraptor.run/docs/git-hooks/

\n

Deno プロジェクトを用意して velociraptor.yml を追加する

\n
---\nscripts:\n  lint: deno lint\n  format: deno fmt\n  format-check: deno fmt --check\n  pre-commit:\n    cmd:\n      - vr lint\n      - vr format-check\n    gitHook: pre-commit
\n

Git Hooks の設定

\n

vr を実行すれば設定できる、便利

\n
$ vr\n...\n    • pre-commit\n    Runs at pre-commit\n    $ vr lint, vr format-check\n...
\n

pre-commit ファイルなどもある

\n
$ cat ./.git/hooks/pre-commit \n#!/bin/sh\n# Generated by Velociraptor 1.5.0\nvr run-hook pre-commit "$@"
\n

動作確認

\n

むやみに改行を入れて、フォーマットに引っかかるコードを用意した
\nまずは vr format-check が動くことを確認

\n
$ vr format-check                                  \n\nfrom /home/vagrant/workspace/tmp/helloworld-deno-velociraptor/command.ts:\n 8 | -  .option("--name <name:string>",\n 9 | -   "name",\n10 | -    { required: true }\n11 | -    )\n 8 | +  .option("--name <name:string>", "name", { required: true })\n\nerror: Found 1 not formatted file in 3 files\nerror: Failed at the format-check script
\n

この状態でコミットすると pre-commmit で設定した vr lint と vr format-check を実行してくれる

\n
$ git commit -m "[add] git hook using velociraptor."   \nChecked 2 files\n\nfrom /home/vagrant/workspace/tmp/helloworld-deno-velociraptor/command.ts:\n 8 | -  .option("--name <name:string>",\n 9 | -   "name",\n10 | -    { required: true }\n11 | -    )\n 8 | +  .option("--name <name:string>", "name", { required: true })\n\nerror: Found 1 not formatted file in 3 files\nerror: Failed at the format-check script\nerror: Failed at the pre-commit script
\n

Git Hooks 便利である

\n

動かしたリポジトリ

\n

Git Hooks を確認したかったので、別でリポジトリを作成した
\nhttps://github.com/honyanya/helloworld-deno-velociraptor

","frontmatter":{"title":"Deno プロジェクトで Velociraptor を使って Git Hooks を設定する","date":"2022/07/04","description":null}},"previous":{"fields":{"slug":"/2022-06-02_docker_compose_subcommand/"},"frontmatter":{"title":"docker compose サブコマンドを使う方法"}},"next":{"fields":{"slug":"/2022-07-05_deno-task-runner_velociraptor/"},"frontmatter":{"title":"Deno タスクランナーに Velociraptor を入れる"}}},"pageContext":{"id":"f5c024a2-841b-5300-951a-530664d5e1be","previousPostId":"5712d284-a047-53f2-aea4-f60dda713641","nextPostId":"8d6dcdb3-2f92-5f58-b519-1bec8f30e6cd"}}, "staticQueryHashes": ["2841359383","3257411868"]}