isgit

README

isgit

I created this simple package to find out if a directory is part of a git repo, the only other way I could find to do this was by calling git rev-parse --show-top-level this is a lot simpler and faster, but doesn't actually check the state of git, instead it just looks for a .git directory present in any parent directory.

Benchmark

BenchmarkGetRootDirWD-12                   30321             38386 ns/op
BenchmarkGetRootDirWithBinary-12             184           6591809 ns/op

Documentation

Index

• func GetRootDir(path string) (string, error)
• func GetRootDirWD() (string, error)
• func IsCurrentDirInGitRepo() (bool, error)
• func IsGitRepo(dir string) (bool, error)

Functions

func GetRootDir

func GetRootDir(path string) (string, error)

GetRootDir returns the root directory of the Git repository containing the given path. Returns an empty string if no Git repository is found.

func GetRootDirWD

func GetRootDirWD() (string, error)

GetRootDirWD returns the root directory of the Git repository containing the current working directory. Returns an empty string if no Git repository is found.

func IsCurrentDirInGitRepo

func IsCurrentDirInGitRepo() (bool, error)

IsCurrentDirInGitRepo checks if the current working directory is within a Git repository.

func IsGitRepo

func IsGitRepo(dir string) (bool, error)

IsGitRepo checks if the given directory is within a Git repository.