💪

.gitignoreはgitignore.ioに任せよう

2024/01/08に公開

はじめに

ソースコードをgitで管理する際に、環境変数や公開すべきでないファイルは.gitignoreに記述してpushするかと思います。しかし、OSや言語・フレームワークなどによって.gitignoreに追加するファイルやディレクトリが変化するため自分で調べて記述するのは面倒ですよね。(僕は面倒だと感じています、、)

業務で.gitignoreを作成する機会があったのですが、
先輩にgitignore.ioというサイトを教えていただき、超簡単に.gitignoreを作成する方法を学びました。

gitignore.ioとは?

様々な言語・フレームワーク・OS・ツールに応じて.gitignoreに記述すべきものを生成してくれるサイトです。

使い方

使いたい言語やツールを入力

今回はGo言語をVSCodeで使用すると仮定して入力しています。

Createを押すとGo言語とVSCodeの.gitignoreが生成されます。
細かくコメントも記述されているのでわかりやすいですね✨

curlコマンドを使用して.gitignore生成

上記で生成されたコードをコピペしても良いのですが、エンジニアならcurlを使おうということで(?)、生成された画面のURLをコピペして以下のコマンドを実行することでカレントディレクトリに.gitignoreが生成されます。

curl https://www.toptal.com/developers/gitignore/api/go,visualstudiocode -o ./.gitignore

生成された.gitignore

.gitignore
# Created by https://www.toptal.com/developers/gitignore/api/go,visualstudiocode
# Edit at https://www.toptal.com/developers/gitignore?templates=go,visualstudiocode

### Go ###
# If you prefer the allow list template instead of the deny list, see community template:
# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.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/

# Go workspace file
go.work

### VisualStudioCode ###
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
!.vscode/*.code-snippets

# Local History for Visual Studio Code
.history/

# Built Visual Studio Code Extensions
*.vsix

### VisualStudioCode Patch ###
# Ignore all local history of files
.history
.ionide

# End of https://www.toptal.com/developers/gitignore/api/go,visualstudiocode

おわりに

gitignore.ioを使用することで考えることが減るので積極的に使っていきたいです!
ツールに任せられることはどんどん任せていきましょう💪

GitHubで編集を提案

Discussion