gibo による .gitignore 生成

公開:2020/09/21
更新:2020/09/21
5 min読了の目安(約3500字IDEAアイデア記事

この記事は Qiita から移行・再構成したものです。

Git のリポジトリを作る際に .gitignore の内容をどうするかは悩みどころだが(大抵は他所からコピってくるのだが), gibo というツールを使えば .gitignore のひな型をいい感じに生成してくれる。

インストールと準備

導入方法は README.md に書かれているのでそちらを参考にすればいいのだが,最低限必要なのは gibo または gibo.bat スクリプトのみなので,どうにでもなるだろう。

とりあえず件のスクリプトを PATH が通るディレクトリに放り込んで gibo help を起動してみる(-h オプションでも可)。

$ gibo help
gibo 2.2.4 by Simon Whitaker <sw@netcetera.org>
https://github.com/simonwhitaker/gibo

Fetches gitignore boilerplates from https://github.com/github/gitignore

Usage:
    gibo [command]

Example:
    gibo dump Swift Xcode >> .gitignore

Commands:
    dump BOILERPLATE...   Write boilerplate(s) to STDOUT
    help                  Display this help text
    list                  List available boilerplates
    root                  Show the directory where gibo stores its boilerplates
    search STR            Search for boilerplates with STR in the name
    update                Update list of available boilerplates
    version               Display current script version

準備として .gitignore 情報のアップデートから。

$ gibo update
Cloning https://github.com/github/gitignore.git to /home/username/.gitignore-boilerplates
Cloning into '/home/username/.gitignore-boilerplates'...
...

これで $HOME/.gitignore-boilerplates ディレクトリに情報がセットされた。ちなみに Windows では %APPDATA%\.gitignore-boilerplates フォルダにセットされる。また GIBO_BOILERPLATES 環境変数が指定されていれば,この環境変数が指すディレクトリにセットされる。

.gitignore 情報の取得

.gitignore 情報を取得するには gibo dump コマンドを使う。たとえば Go 言語なら

$ gibo dump go
### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Go.gitignore

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/

となる。

プログラミング言語以外にもプラットフォームでの指定もできる。たとえば govim を両方指定して

$ gibo dump go vim
### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Go.gitignore

# Binaries for programs and plugins
*.exe
*.exe~
*.dll
*.so
*.dylib

# Test binary, built with `go test -c`
*.test

# Output of the go coverage tool, specifically when used with LiteIDE
*.out

# Dependency directories (remove the comment below to include it)
# vendor/


### https://raw.github.com/github/gitignore/218a941be92679ce67d0484547e3e142b2f5f6f0/Global/Vim.gitignore

# Swap
[._]*.s[a-v][a-z]
!*.svg  # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~

などとできる。まぁ,それぞれの情報を単純に連結してるだけなんだけどね(笑)

.gitignore ファイルへはリダイレクトで保存すればよい。

$ gibo dump go vim > .gitignore

gibo dump コマンドで指定できる名前の一覧は gibo list コマンドで取得できる(めちゃめちゃ多いので動作例はパス)。

gibo コマンドラインの補完

simonwhitaker/gibo リポジトリの shell-completions ディレクトリ内のスクリプトファイルを使って bash, zsh, fish 上で gibo コマンドラインの補完機能を追加できる。

たとえば bash であれば gibo-completion.bash ファイルを /etc/bash_completion.d ディレクトリに放り込んでおけば OK。

参考