pre-commit

こんにちは、技術本部 Eight Engineering Unit でエンジニアをやっている茂木です。 普段はSansan株式会社で正社員としてフルコミットしつつ、情報系の大学に通っています。 今回は Reviewdog x RuboCop を使って、ローカル環境で Lint をかける機構を Eight に導入した話をしていきます。

要約 pre-commitのpoetry-export hookで警告が表示された poetry-plugin-exportをインストールする poetry self show pluginsでインストール内容を確認し、 poetry config warnings.export falseで警告表示を無効にする 要約 現象 実行環境 .pre-commit-config.yaml(poetry部分抜粋) 解決方法 動作確認 poetry run pre-commit run --all-filesによる確認 poetry exportによる確認 現象 pre-commitでpoetry-ex…

概要 注意事項 個人的な見解 pre-commitフックでmarkdownlint-cli/cli2を使用する意味 markdownlintについて markdownlint-cliについて markdownlint-cli2について 参考情報 pre-commitフック設定(.pre-commit-config.yaml) markdownlint-cli markdownlint-cli2 補足 構成ファイル(.markdownlint.jsonc) 実行結果例 markdownlint-cli markdownlint-cli2 実行結果(--fix指定) markdownlint-cl…

経緯 追加情報 20241009 20230906 課題 解決方法 作成したもの 詳細 update_pyproject_version.py run_git_tag_base_pyproject.py .pre-commit-config.yaml create_post-commit.sh post-commit 実行例 コミット前の情報 ローカルタグ情報 リモートタグ情報 pyproject.toml プロジェクトのインストール pre-commitスクリプトとpost-commitスクリプトの作成 pre-commit作成 post-commit作成 git commit例 失敗例 成…

はじめまして。株式会社iimonでバックエンドエンジニアを担当している玉山です。 では早速始めていきます。 前置き 今回はiimonで使っているリンターとフォーマッターをgitの機能でcommitをフックし、レビューのコストを下げてしまおうというお話です。 gitの機能でcommitをフックするには.git/hooks/pre-commitを言うファイルにシェルスクリプトで書けば機能します。 ですが、.git/hooks/pre-commitはgitでの管理対象外の為、履歴が残りません。 そこで今回はpre-commitというフレームワークを使います。 pre-commitのメリットとデメリッ…

解読 .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:…

CEOの@uen0yamaです。 MarkItDownを使って、Excelファイルのコミット時にはMarkdownもセットで登録するよう構成したら、Pull RequestのExcelレビューがとてもスムーズになりました。 背景 みなさんはGitHubに*.xlsxとか*.docxとか突っ込んでますか？ *.docxの方は、わりとMarkdown形式に置き換わっているケースが多いのですが、*.xlsxはまだまだ現役なんですよね。 何らかの規則に基づいた表などは、まだまだMarkdownのテーブルでは機能不足なので、Excelに頼るケースが多いです。 Excelの変更についてのPull Requ…

はじめに これはFolioアドベントカレンダー2024の14日目の記事です。 adventar.org 今回は、簡易的なConventional Commitsを実現するための zsh-select-commit-prefix というzshプラグインについて話します。 アブストラクト 本稿では、ソフトウェア開発におけるコミットメッセージ仕様「Conventional Commits」を簡素化し、日常的な利用での効率向上を図るzshプラグインの設計と実装について述べる。既存のConventional Commits関連ツールは、詳細な構文やリポジトリ単位の設定を求めるものが多く、個人利用や簡易な…

こちらは「コドモン Advent Calendar 2024」の 10日目の記事です。 qiita.com こんにちは。プロダクト開発部の河野です。 今回は、最近チームに導入した lefthook の使い勝手が良かったので、紹介したいと思います。 lefthook とは Git フックの管理ツールで、Git のコミットやプッシュ操作時に任意の処理を走らせることができるツールです。 Fast. It is written in Go. Can run commands in parallel. Powerful. It allows to control execution and files …

本エントリは「エーピーコミュニケーションズ Advent Calendar 2024」の2日目のエントリです。 TerraformのコードのREADME作成時に何かいいのが無いか調べてみたらterraform-docsというプロダクトを見つけたので、使い方について簡単にまとめました。 github.com 始め方 インストール コンテナ版 使い方 実行結果 オプション 書式 再帰実行(モジュール) 設定ファイル指定 GitHub Actions その他 始め方 インストールして使うか、または、コンテナ版も公開されてるのでDockerあるいはPodmanのrunでも実行できます。 本エントリでは…

近年プライベートで遊んでいる技術はNixです。「ふつうのソフトウェアエンジニア」の ひむら (id:eiel)です。こんにちは。 kubell Advent Calendar 2024 シリーズ2になにか書こうと思って、この記事を書き始めました。 ということで(?)、最近関心のある技術であるNixについて、業務上でどのように さりげなく 使っているかを書き残しておこうとおもいます。 本記事はゆるふわな気分で、エッセイ感覚でかいています。読み手に何かを学んでもらおうという意図はないです。TextLintも設定せずに書いています。誰かがなにか思うことがあれば嬉しい、というモチベーションで書いていま…

先日の告知 の通り、Djangoオンラインミートアップ#4を2024/11/22(金) に開催しました。 django.connpass.com 参加者や約20名程度で、会話が盛り上がっていました。 発表１: Djangoの開発環境で工夫したこと - pre-commit / DevContainer @Hiroki_Yoda さん #djangoja のオンラインミートアップで拙いながらに話してきました！皆さんの開発や運用のお話を聞けて、とても勉強になりました。想像以上の Ruff ユーザー比率でした。https://t.co/7TwybLew99— 余田大輝 (@Hiroki_Yoda) …

SREのクラシマです。 皆さんのREADME.mdには何が書いてありますでしょうか？ トラーナでは、以下を書くようにしています。 開発を始めるために必要なツールのinstallについて ローカル開発環境について (Option)外部のツールのcredentials周り (Option)アーキテクチャ図 基本的にはMacで開発しているのですが、ある人はローカル開発環境を起動できるのに別の人はできない、みたいなことが起きると困ります。 (WindowsやLinuxで開発したい、という方ももちろん歓迎しますが、ドキュメントは用意できていないので開拓いただく必要があります...) 開発ドキュメントがた…

この大会は2024/11/9 2:00(JST)～2024/11/10 14:00(JST)に開催されました。 今回もチームで参戦。結果は2470点で498チーム中61位でした。 自分で解けた問題をWriteupとして書いておきます。 Welcome Letter (MISC) 問題にフラグが書いてあった。 UDCTF{guessy_is_sometimes_deduction_sometimes_awful} Training Problem: Intro to PWN (PWN) Ghidraでデコンパイルする。 undefined8 main(void) { setvbuf(stdin,…

lint-stagedとhuskyをインストールする 以下のコマンドを実行します。 npm install --save-dev lint-staged husky huskyをセットアップする 「Get started | Husky」に倣って、以下の通り実行しました。 npx husky init このとき、package.jsonのscriptsに以下の行が追加されます。 "prepare": "husky" また、.husky/pre-commit ファイルが、以下の記述内容で作成されます。 npm test npmのプロジェクトがgitリポジトリのrootに無い場合 package.…

環境 OS: macOS Ventura 13.6.4 husky: 9.1.6 node: 20.15.0 ( nodenvを使用してインストール ) 起こっている問題 huskyをインストールして設定してみたところ、pre-commit hookで以下のエラーが表示されました。 nodenv: npm: command not found The `npm' command exists in these Node versions: 18.17.1 20.15.0 20.5.1 husky - pre-commit script failed (code 127) husky - com…

個人アプリでも作ってみようと思い立ち、フロントエンドをReactで作ることにした。 とりあえず、以下の記事を参考に作ることにする。 zenn.dev メモ npm create vite@latest frontend -- --template react-swc-ts cd frontend npm install で、動かす。 npm run dev Lint Biomeを使ってみようと思います。 npm install --save-dev --save-exact @biomejs/biome npx @biomejs/biome init 上記を実行すると、biome.jsonが生…