Skip to content
/ gig Public

generate (or output) .gitignore using github/gitignore

License

Notifications You must be signed in to change notification settings

toshi0607/gig

Repository files navigation

gig

Build Status Go Report Card MIT License Codecov

Description

generate (or output) .gitignore using github/gitignore

Demo

VS.

gibo

simonwhitaker/gibo is useful tool for .gitinore. It does git clone the templates from github/gitignore and it uses local files. So the gibo is fast, but you have to update local files to use tha latest template.

gig

toshi0607/gig is also a tool for .gitinore. The gig always use the latest template by accessing github each time. So you don't have to update something manually.

Requirement

if you build gig loccally, please exec this command first.

$ dep ensure

Usage

Usage:
  gig [OPTIONS] [Language]

Application Options:
  -l, --list      Show list of available language
  -f, --File      Output .gitignore file
  -q, --quiet     Hide stdout
  -v, --version   Show version

Help Options:
  -h, --help      Show this help message

Example

# show available languages
$ gig -l
Actionscript
Ada
Agda
Android
...


# search available languages like go
$ gig -l | grep -i go
Go
Godot
IGORPro


# output to the .gitignore file
$ gig Ruby -f
$ cat .gitignore
*.gem
*.rbc
/.config
/coverage/
...


# add to the existing .gitignore file
$ gig Go >> .gitignore
$ cat .gitignore
...
# Binaries for programs and plugins
*.exe
*.exe~
...

Tips

peco 's incremental search helps gig a lot.

$ gig $(gig -l | peco)

Setting alias like blow to your dotfile (.bashrc, .zshrc, etc) is also useful.

alias pgig='gig $(gig -l | peco)'

Install

for Homebrew (macOS, linux)

$ brew tap toshi0607/homebrew-gig
$ brew install gig

for Go environment

$ go get -u github.com/toshi0607/gig

for Scoop (Windows)

$ scoop install https://raw.githubusercontent.com/toshi0607/gig/master/gig.json

for others

You can download the binary directly from latest release

  • gig_darwin_386.zip
  • gig_darwin_amd64.zip
  • gig_linux_386.zip
  • gig_linux_amd64.zip
  • gig_windows_386.zip
  • gig_windows_amd64.zip

Contribution

  1. Fork (https://github.com/toshi0607/gig/fork)
  2. Create a feature branch
  3. Commit your changes
  4. Run test suite with the make test command and confirm that it passes
  5. Run gofmt -s
  6. Create new Pull Request

Licence

MIT file for details.

Author