🗜️

ビルド成果物をうっかり含めずにソースコードだけを ZIP 化する CLI ツールを作りました

に公開

プロジェクトを ZIP で固めたいとき、ありますよね

プロジェクトをちょっと同僚に共有したい、サポートチケットに添付したい、どこかにアップロードしたい。そんなときは、プロジェクトフォルダを ZIP 化したくなりますよね。しかしついうっかり、node_modules や bin/obj フォルダなど、ビルド成果物や依存関係ファイルまで丸ごと含めてしまって、やたら ZIP 化に時間がかかって気がつくとか、出来上がった ZIP ファイルが巨大になってしまう、なんて経験はありませんか?

こうなると、手動で不要なフォルダを除外するか、別のフォルダにソースだけコピーしてから圧縮するか、いずれにしても面倒な作業が発生します。

ということで dnx zipsrc を作りました

そこで、ソースコードだけを含む ZIP アーカイブを手軽に作成できる CLI ツール dnx zipsrc を作成しました。ビルド成果物や依存関係ファイルなど、共有したくないファイルを自動的に除外してくれます。

.NET 10 で導入された dnx コマンドを使うことで、事前のインストールなしで実行できます。(.NET SDK 10 が事前にインストールされている必要はありますが。)

dnx zipsrc

これだけです。コマンド一発で、ソースコードがきれいに ZIP ファイルにまとまります。.NET ツールなので、macOS でも Linux でも動作します。

仕組みについて

.gitignore をそのまま活用

除外ルールを一から定義し直すのではなく、プロジェクトにある .gitignore ファイルのパターンをそのまま利用するようにしました。すでに .gitignore があれば、そのルールが自動的に適用されます。

.gitignore がない場合でも大丈夫です。dotnet new gitignore で生成されるものと同等のデフォルトルールにフォールバックするようにしてあります。以下のような一般的なパターンが含まれています。

  • C#/.NET 系: bin/、obj/、*.user、*.suo、.vs/
  • Node.js 系: node_modules/、dist/、.cache/
  • その他: ビルド出力、IDE ファイル、ログなど

サブディレクトリの .gitignore も正しく処理されますし、否定パターン(!important-file.txt)にも対応しています。

この .gitignore パース処理には GitignoreParserNet を使用しています。エッジケースの処理などを自分で実装する必要がなく、助かりました。

出力ファイル名の自動決定

出力ファイル名を指定しなかった場合は、以下のルールで自動的に決まります。

  1. フォルダ内に .sln または .slnx ファイルがあれば、そのソリューション名を使用
  2. なければ、フォルダ名を使用

すでに MyProject.zip が存在する場合は、上書きせずに MyProject (2).zip として作成されます。何度も ZIP 化する場面で、前のファイルを失わずに済みます。

使い方

カレントディレクトリを ZIP 化

dnx zipsrc

特定のディレクトリを ZIP 化

dnx zipsrc -d ./src/MyAwesomeApp

出力ファイル名を指定

dnx zipsrc -d ./src/MyApp -n ./archives/MyAppSource
# 結果: ./archives/MyAppSource.zip

.zip 拡張子は省略しても自動で付加されます。

dnx コマンドについて

.NET 10 では dnx コマンドが導入されました。これは .NET グローバルツールを事前にインストールすることなく実行できる仕組みです。ダウンロード、キャッシュ、実行を一度に行ってくれます。

これにより、以下のようなメリットがあります。

  • グローバルツールの一覧が増えていかない
  • 常に最新バージョンが実行される
  • .NET 10 以降が入っていれば、どのマシンでもすぐに使える
  • 一度きりの作業に最適

もちろん、頻繁に使う場合は従来どおりインストールすることもできます。

dotnet tool install -g zipsrc
zipsrc -d ./MyProject

こんな場面で使えます

  • メール添付: 余計なファイルなしでソースコードを共有
  • サポートチケット: 再現用の最小構成プロジェクトを添付
  • 教育用途: 受講者へのスタータープロジェクト配布
  • 簡易バックアップ: 大きなリファクタリング前の作業アーカイブ
  • コードレビュー: リポジトリにアクセスできないチームメンバーへの共有

類似ツールがあるのに作った理由

ソースコードを ZIP 化するツールは、すでにいくつか存在しています。

それでも自分で作ることにしたのには、いくつか理由がありました。

1. ファイル名と出力先の制御

既存のツールは、ZIP ファイルの出力先や命名について決まった方式を持っていることが多いです。自分としては、ソリューションファイル名があればそれを使いたい、出力先は自分で指定したい、といった細かい制御がしたかったのです。

2. 連番による上書き防止

同じプロジェクトを何度も ZIP 化する場面(修正しながら何度かアーカイブを作る場合など)で、既存ファイルを上書きされたくないし、手動でリネームもしたくない。(2)、(3) のように自動で連番を振ってくれる機能が欲しかったのです。

3. デフォルト除外ルールの充実

.gitignore がないプロジェクトでも、dotnet new gitignore 相当の包括的なデフォルトルールでカバーしたかったのです。既存ツールだと、デフォルトの除外ルールが最小限だったり、なかったりすることがありました。

細かいことではあるのですが、日常的に何度も使うツールでは、こういった小さな便利さの積み重ねがけっこう効いてきます。

さいごに

この小さなツールが、ささやかながらも、皆さんの開発ワークフローの一助となれば幸いです。

質問やフィードバックがあれば、コメントや GitHub の Issue でお気軽にどうぞ。

謝辞

Guiorgy さんの GitignoreParserNet に感謝します。複雑な .gitignore のパース処理をこのライブラリに任せることができたおかげで、ツール開発がとても楽になりました。


この記事は 'Tired of Accidentally Zipping Build Artifacts? Try "dnx zipsrc"!' の日本語翻訳版です。翻訳には VSCode + GitHub Copilot (Claude Opus 4.5) を使用しました。

Discussion