1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# go-gitignore [](https://travis-ci.org/monochromegane/go-gitignore)
A fast gitignore matching library for Go.
This library use simple tree index for matching, so keep fast if gitignore file has many pattern.
## Usage
```go
gitignore, _ := gitignore.NewGitIgnore("/path/to/gitignore")
path := "/path/to/file"
isDir := false
gitignore.Match(path, isDir)
```
### Specify base directory
go-gitignore treat `path` as a base directory.
If you want to specify other base (e.g. current directory and Global gitignore), you can like the following.
```go
gitignore, _ := gitignore.NewGitIgnore("/home/you/.gitignore", ".")
```
### From io.Reader
go-gitignore can initialize from io.Reader.
```go
gitignore, _ := gitignore.NewGitIgnoreFromReader(base, reader)
```
## Simple tree index
go-gitignore parse gitignore file, and generate a simple tree index for matching like the following.
```
.
├── accept
│ ├── absolute
│ │ └── depth
│ │ ├── initial
│ │ └── other
│ └── relative
│ └── depth
│ ├── initial
│ └── other
└── ignore
├── absolute
│ └── depth
│ ├── initial
│ └── other
└── relative
└── depth
├── initial
└── other
```
## Features
- Support absolute path (/path/to/ignore)
- Support relative path (path/to/ignore)
- Support accept pattern (!path/to/accept)
- Support directory pattern (path/to/directory/)
- Support glob pattern (path/to/\*.txt)
*note: glob pattern*
go-gitignore use [filepath.Match](https://golang.org/pkg/path/filepath/#Match) for matching meta char pattern, so not support recursive pattern (path/`**`/file).
## Installation
```sh
$ go get github.com/monochromegane/go-gitignore
```
## Contribution
1. Fork it
2. Create a feature branch
3. Commit your changes
4. Rebase your local changes against the master branch
5. Run test suite with the `go test ./...` command and confirm that it passes
6. Run `gofmt -s`
7. Create new Pull Request
## License
[MIT](https://github.com/monochromegane/go-gitignore/blob/master/LICENSE)
## Author
[monochromegane](https://github.com/monochromegane)
|
