gitcha

README

gitcha

Go helpers to work with git repositories

Examples

import "github.com/muesli/gitcha"

// returns the directory of the git repository path is a member of:
repo, err := gitcha.GitRepoForPath(path)

// finds files from list in path. It respects all .gitignores it finds while
// traversing paths:
ch, err := gitcha.FindFiles(path, []string{"*.md"})
for v := range ch {
    fmt.Println(v.Path)
}

// finds files, excluding any matches in a given set of ignore patterns:
ch, err := gitcha.FindFilesExcept(path, []string{"*.md"}, []string{".*"})
...

// if you are only interested in the first match:
result, err := gitcha.FindFirstFile(path, []string{"*.md"})
...

// just for convenience:
ok := gitcha.IsPathInGit(path)

Documentation

Index

• func FindAllFiles(path string, list []string) (chan SearchResult, error)
• func FindAllFilesExcept(path string, list, ignorePatterns []string) (chan SearchResult, error)
• func FindFiles(path string, list []string) (chan SearchResult, error)
• func FindFilesExcept(path string, list, ignorePatterns []string) (chan SearchResult, error)
• func GitRepoForPath(path string) (string, error)
• func IsPathInGit(path string) bool
• type SearchResult
  • func FindFirstFile(path string, list []string) (SearchResult, error)

Functions

func FindAllFiles

func FindAllFiles(path string, list []string) (chan SearchResult, error)

FindAllFiles finds all files from list in path. It does not respect any gitignore files.

func FindAllFilesExcept

func FindAllFilesExcept(path string, list, ignorePatterns []string) (chan SearchResult, error)

FindAllFilesExcept finds all files from list in path. It does not respect any gitignore files.

func FindFiles

func FindFiles(path string, list []string) (chan SearchResult, error)

FindFiles finds files from list in path. It respects all .gitignores it finds while traversing paths.

func FindFilesExcept

func FindFilesExcept(path string, list, ignorePatterns []string) (chan SearchResult, error)

FindFilesExcept finds files from a list in a path, excluding any matches in a given set of ignore patterns. It also respects all .gitignores it finds while traversing paths.

func GitRepoForPath

func GitRepoForPath(path string) (string, error)

GitRepoForPath returns the directory of the git repository path is a member of, or an error.

func IsPathInGit

func IsPathInGit(path string) bool

IsPathInGit returns true when a path is part of a git repository.

Types

type SearchResult

type SearchResult struct {
	Path string
	Info os.FileInfo
}

SearchResult combines the absolute path of a file with a FileInfo struct.

func FindFirstFile

func FindFirstFile(path string, list []string) (SearchResult, error)

FindFirstFile looks for files from a list in a path, returning the first match it finds. It respects all .gitignores it finds along the way.