mirror of
https://github.com/onyx-and-iris/gignore.git
synced 2025-04-11 08:03:53 +01:00
Compare commits
8 Commits
Author | SHA1 | Date | |
---|---|---|---|
|
2c1d2ed99c | ||
29270a2c14 | |||
ee86db76a2 | |||
6aac14b9ed | |||
38b0611e4e | |||
6b41418c00 | |||
|
4800b29707 | ||
8a9539ea60 |
@ -5,7 +5,14 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
# [0.3.0] - 2024-14-03
|
# [0.4.0] - 2025-04-05
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- `-loglevel` flag is now of type string. It accepts any one of trace, debug, info, warn, error, fatal or panic.
|
||||||
|
- It defaults to warn.
|
||||||
|
|
||||||
|
# [0.3.0] - 2025-14-03
|
||||||
|
|
||||||
### Added
|
### Added
|
||||||
|
|
||||||
|
22
README.md
22
README.md
@ -56,6 +56,28 @@ You may set an environment variable `GIGNORE_TEMPLATE_DIR` to avoid passing the
|
|||||||
|
|
||||||
If a template is requested but not found in the custom directory then the gitignoreio registry will act as a fallback.
|
If a template is requested but not found in the custom directory then the gitignoreio registry will act as a fallback.
|
||||||
|
|
||||||
|
## Logging
|
||||||
|
|
||||||
|
The `-loglevel` flag allows you to control the verbosity of the application's logging output.
|
||||||
|
|
||||||
|
Acceptable values for this flag are:
|
||||||
|
|
||||||
|
- `trace`
|
||||||
|
- `debug`
|
||||||
|
- `info`
|
||||||
|
- `warn`
|
||||||
|
- `error`
|
||||||
|
- `fatal`
|
||||||
|
- `panic`
|
||||||
|
|
||||||
|
For example, to set the log level to `debug`, you can use:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gignore -loglevel=debug -dir=custom go
|
||||||
|
```
|
||||||
|
|
||||||
|
The default log level is `warn` if the flag is not specified.
|
||||||
|
|
||||||
## Special Thanks
|
## Special Thanks
|
||||||
|
|
||||||
[gitignore.io][gitignoreio] For providing such a useful .gitignore service
|
[gitignore.io][gitignoreio] For providing such a useful .gitignore service
|
||||||
|
@ -35,19 +35,26 @@ tasks:
|
|||||||
- go fmt ./...
|
- go fmt ./...
|
||||||
|
|
||||||
generate:
|
generate:
|
||||||
desc: Generate the gitignore.io templates
|
desc: |
|
||||||
|
Generate the gitignore.io templates.
|
||||||
|
This task will be skipped if the templates already exist.
|
||||||
|
You may use the `--force` flag to regenerate the templates.
|
||||||
cmds:
|
cmds:
|
||||||
- go generate ./...
|
- go generate ./...
|
||||||
|
status:
|
||||||
|
- ls internal/registry/templates/gitignoreio/*.gitignore >/dev/null || exit 1
|
||||||
|
|
||||||
build-windows:
|
build-windows:
|
||||||
desc: Build the gignore project for Windows
|
desc: Build the gignore project for Windows
|
||||||
cmds:
|
cmds:
|
||||||
- GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
|
- GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
|
||||||
|
internal: true
|
||||||
|
|
||||||
build-linux:
|
build-linux:
|
||||||
desc: Build the gignore project for Linux
|
desc: Build the gignore project for Linux
|
||||||
cmds:
|
cmds:
|
||||||
- GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
|
- GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
|
||||||
|
internal: true
|
||||||
|
|
||||||
test:
|
test:
|
||||||
desc: Run tests
|
desc: Run tests
|
||||||
|
@ -5,12 +5,17 @@ package main
|
|||||||
import (
|
import (
|
||||||
"flag"
|
"flag"
|
||||||
"fmt"
|
"fmt"
|
||||||
"slices"
|
"os"
|
||||||
|
|
||||||
"github.com/onyx-and-iris/gignore"
|
"github.com/onyx-and-iris/gignore"
|
||||||
log "github.com/sirupsen/logrus"
|
log "github.com/sirupsen/logrus"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
func exit(err error) {
|
||||||
|
_, _ = fmt.Fprintf(os.Stderr, "Error: %s\n", err)
|
||||||
|
os.Exit(1)
|
||||||
|
}
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
flag.Usage = func() {
|
flag.Usage = func() {
|
||||||
w := flag.CommandLine.Output()
|
w := flag.CommandLine.Output()
|
||||||
@ -30,7 +35,7 @@ func main() {
|
|||||||
var (
|
var (
|
||||||
list bool
|
list bool
|
||||||
templateDir string
|
templateDir string
|
||||||
loglevel int
|
loglevel string
|
||||||
)
|
)
|
||||||
|
|
||||||
flag.BoolVar(&list, "list", false, "list available templates")
|
flag.BoolVar(&list, "list", false, "list available templates")
|
||||||
@ -41,19 +46,22 @@ func main() {
|
|||||||
getEnv("GIGNORE_TEMPLATE_DIR", "gitignoreio"),
|
getEnv("GIGNORE_TEMPLATE_DIR", "gitignoreio"),
|
||||||
"directory containing .gitignore templates",
|
"directory containing .gitignore templates",
|
||||||
)
|
)
|
||||||
flag.IntVar(&loglevel, "loglevel", int(log.WarnLevel), "log level")
|
flag.StringVar(&loglevel, "loglevel", "warn", "log level")
|
||||||
flag.IntVar(&loglevel, "l", int(log.WarnLevel), "log level (shorthand)")
|
flag.StringVar(&loglevel, "l", "warn", "log level (shorthand)")
|
||||||
|
|
||||||
flag.Parse()
|
flag.Parse()
|
||||||
|
|
||||||
if slices.Contains(log.AllLevels, log.Level(loglevel)) {
|
level, err := log.ParseLevel(loglevel)
|
||||||
log.SetLevel(log.Level(loglevel))
|
if err != nil {
|
||||||
|
exit(fmt.Errorf("invalid log level: %s", loglevel))
|
||||||
}
|
}
|
||||||
|
log.SetLevel(level)
|
||||||
|
|
||||||
client := gignore.New(gignore.WithTemplateDirectory(templateDir))
|
client := gignore.New(gignore.WithTemplateDirectory(templateDir))
|
||||||
|
|
||||||
if list {
|
if list {
|
||||||
if err := listTemplates(client); err != nil {
|
if err := listTemplates(client); err != nil {
|
||||||
log.Fatalf("failed to list templates: %v", err)
|
exit(fmt.Errorf("failed to list templates: %v", err))
|
||||||
}
|
}
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
@ -67,7 +75,7 @@ func main() {
|
|||||||
for _, arg := range args {
|
for _, arg := range args {
|
||||||
err := client.Create(arg)
|
err := client.Create(arg)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("failed to create .gitignore file: %v", err)
|
exit(fmt.Errorf("failed to create .gitignore file: %v", err))
|
||||||
}
|
}
|
||||||
fmt.Printf("√ created %s .gitignore file\n", arg)
|
fmt.Printf("√ created %s .gitignore file\n", arg)
|
||||||
}
|
}
|
||||||
|
11
error.go
11
error.go
@ -1,17 +1,16 @@
|
|||||||
// Package gignore provides functionality for handling template errors and registry operations.
|
// Package gignore provides a way to manage .gitignore files and templates.
|
||||||
package gignore
|
package gignore
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"strings"
|
||||||
"github.com/onyx-and-iris/gignore/internal/registry"
|
|
||||||
)
|
)
|
||||||
|
|
||||||
type templateNotFoundError struct {
|
type templateNotFoundError struct {
|
||||||
template string
|
template string
|
||||||
registry *registry.TemplateRegistry
|
templatesSearched []string
|
||||||
}
|
}
|
||||||
|
|
||||||
func (e *templateNotFoundError) Error() string {
|
func (e *templateNotFoundError) Error() string {
|
||||||
return fmt.Sprintf("template '%s' not found in %s registry", e.template, e.registry.Directory)
|
return fmt.Sprintf("template '%s' not found in %s registry", e.template, strings.Join(e.templatesSearched, ", "))
|
||||||
}
|
}
|
||||||
|
@ -42,22 +42,23 @@ func (c *Client) Create(template string) error {
|
|||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if !ok {
|
if !ok {
|
||||||
templateNotFoundErr := &templateNotFoundError{template, c.registry}
|
templateNotFoundErr := &templateNotFoundError{template, []string{c.registry.Directory}}
|
||||||
if c.registry.Directory == "gitignoreio" {
|
if c.registry.Directory == "gitignoreio" {
|
||||||
return templateNotFoundErr
|
return templateNotFoundErr
|
||||||
}
|
}
|
||||||
|
|
||||||
log.Errorf("%s. Checking default registry...", templateNotFoundErr)
|
|
||||||
|
|
||||||
c.registry.Directory = "gitignoreio"
|
c.registry.Directory = "gitignoreio"
|
||||||
ok, err = c.registry.Contains(template)
|
ok, err = c.registry.Contains(template)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
if !ok {
|
if !ok {
|
||||||
|
templateNotFoundErr.templatesSearched = append(templateNotFoundErr.templatesSearched, c.registry.Directory)
|
||||||
return templateNotFoundErr
|
return templateNotFoundErr
|
||||||
}
|
}
|
||||||
log.Infof("template '%s' found in default gitignoreio registry", template)
|
log.Debugf("template '%s' found in gitignoreio registry", template)
|
||||||
|
} else {
|
||||||
|
log.Debugf("template '%s' found in %s registry", template, c.registry.Directory)
|
||||||
}
|
}
|
||||||
|
|
||||||
content, err := c.registry.Get(template)
|
content, err := c.registry.Get(template)
|
||||||
|
2
go.mod
2
go.mod
@ -7,4 +7,4 @@ require (
|
|||||||
github.com/sirupsen/logrus v1.9.3
|
github.com/sirupsen/logrus v1.9.3
|
||||||
)
|
)
|
||||||
|
|
||||||
require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
|
require golang.org/x/sys v0.32.0 // indirect
|
||||||
|
3
go.sum
3
go.sum
@ -10,8 +10,9 @@ github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVs
|
|||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
|
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
||||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 h1:0A+M6Uqn+Eje4kHMK80dtF3JCXC4ykBgQG4Fe06QRhQ=
|
|
||||||
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
|
||||||
|
golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
|
||||||
|
golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c h1:dUUwHk2QECo/6vqA44rthZ8ie2QXMNeKRTHCNY2nXvo=
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
||||||
|
Loading…
x
Reference in New Issue
Block a user