update error/logging messages

make note of --force flag.

.github/workflows/golang-ci.yml

@@ -0,0 +1,29 @@
+name: CI
+
+on:
+  push:
+    branches: [ "main" ]
+    paths:
+      - '**.go'
+  pull_request:
+    branches: [ "main" ]
+    paths:
+      - '**.go'
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    if: github.event_name == 'pull_request'
+    timeout-minutes: 3
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      - name: Setup Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: '1.24'
+      - name: Install golangci-lint
+        run: go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
+      - name: Run golangci-lint
+        run: golangci-lint run ./...

.golangci.yml

@@ -0,0 +1,54 @@
+run:
+  # timeout for analysis, e.g. 30s, 3m, default is 1m
+  timeout: 3m
+  # exclude test files
+  tests: true
+
+linters:
+  # Set to true runs only fast linters.
+  # Good option for 'lint on save', pre-commit hook or CI.
+  fast: true
+
+  disable-all: true
+
+  enable:
+    - gosimple
+    - govet
+    - ineffassign
+    - staticcheck
+    - unused
+    - gofmt
+    - gofumpt
+    - misspell
+    - unparam
+    - gosec
+    - asciicheck
+    - errname
+    - gci
+    - godot
+    - goimports
+    - revive
+
+linters-settings:
+  gofmt:
+    rewrite-rules:
+      - pattern: 'interface{}'
+        replacement: 'any'
+      - pattern: 'a[b:len(a)]'
+        replacement: 'a[b:]'
+
+  misspell:
+    locale: UK
+
+  errcheck:
+    check-type-assertions: true
+
+issues:
+  max-same-issues: 0
+  max-issues-per-linter: 0
+  exclude-use-default: false
+  exclude:
+    # gosec: Duplicated errcheck checks
+    - G104
+    # gosec: integer overflow conversion int -> uint32
+    - G115

CHANGELOG.md

@@ -5,6 +5,22 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+# [0.3.0] - 2024-14-03
+
+### Added
+
+-   CLI may now accept multiple template names, example `gignore go python`. One will be appended after the other.
+
+### Changed
+
+-   Filewriter now opens file in append mode.
+
+# [0.2.0] - 2025-10-03
+
+### Fixed
+
+-   Template .gitignore are now written concurrently.
+
 # [0.1.0] - 2025-09-03
 
 ### Added

README.md

@@ -1,7 +1,19 @@
+![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)
+![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)
+![macOS](https://img.shields.io/badge/mac%20os-000000?style=for-the-badge&logo=macos&logoColor=F0F0F0)
+
+
 # Gignore - Generate .gitinore files
 
 ## Install
 
+With Go tools:
+
+```bash
+go generate ./...
+go install ./cmd/gignore
+```
+
 With [Task][task]:
 
 ```bash
@@ -32,7 +44,7 @@ Example:
 
 ## Custom Templates
 
-It's possible to add your own custom templates, simply create a directory in `internal/registry/templates`. You'll need to rebuild the project before you can load the new templates.
+It's possible to add your own custom templates, simply create a directory in `internal/registry/templates`. You'll need to [reinstall](https://github.com/onyx-and-iris/gignore?tab=readme-ov-file#install) the project before you can load the new templates.
 
 Then pass the dir name as a flag, for example:
 
@@ -48,11 +60,11 @@ If a template is requested but not found in the custom directory then the gitign
 
 [gitignore.io][gitignoreio] For providing such a useful .gitignore service
 
-[mh-cbon][mh-cbon] For writing the [gigo][gigo] client library for gitignore.io
+[cuonglm][cuonglm] For writing the [gogi][gogi] client library for gitignore.io
 
 
 [task]: https://taskfile.dev/
 [gitignoreio]: https://www.toptal.com/developers/gitignore
-[mh-cbon]: https://github.com/mh-cbon
+[cuonglm]: https://github.com/cuonglm
-[gigo]: https://github.com/mh-cbon/gigo
+[gogi]: https://github.com/cuonglm/gogi
 [ignore]: https://github.com/neptship/ignore

Taskfile.yaml

@@ -23,13 +23,6 @@ tasks:
       - task: build-windows
       - task: build-linux
 
-  release:
-    desc: Generate the gitignore.io templates and then build the gignore project for Windows and Linux
-    deps: [generate]
-    cmds:
-      - task: build-windows
-      - task: build-linux
-
   vet:
     desc: Vet the code
     deps: [fmt]
@@ -42,19 +35,26 @@ tasks:
       - go fmt ./...
 
   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:
-      - go generate .
+      - go generate ./...
+    status:
+      - ls internal/registry/templates/gitignoreio/*.gitignore >/dev/null || exit 1
 
   build-windows:
     desc: Build the gignore project for Windows
     cmds:
       - GOOS=windows GOARCH=amd64 go build -o {{.WINDOWS}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
+    internal: true
 
   build-linux:
     desc: Build the gignore project for Linux
     cmds:
       - GOOS=linux GOARCH=amd64 go build -o {{.LINUX}} -ldflags="-X main.Version={{.GIT_COMMIT}}" ./cmd/{{.PROGRAM}}
+    internal: true
 
   test:
     desc: Run tests
@@ -71,3 +71,8 @@ tasks:
     desc: Clean the build artifacts
     cmds:
       - '{{.SHELL}} rm -r {{.BIN_DIR}}'
+
+  prune:
+    desc: Empty the gitignoreio template registry
+    cmds:
+      - '{{.SHELL}} rm internal/registry/templates/gitignoreio/*.gitignore'

cmd/gen/main.go

@@ -1,3 +1,4 @@
+// Package main generates gitignore.io templates using the gogi library.
 package main
 
 import (
@@ -19,10 +20,22 @@ func main() {
 		log.Fatal(err)
 	}
 
+	errChan := make(chan error)
+
 	for _, template := range templates {
-		err := createTemplate(template)
+		go func() {
-		if err != nil {
+			err := createTemplate(template)
-			fmt.Fprintf(os.Stderr, "Failed to create template %s: %v\n", template.Name, err)
+			if err != nil {
+				errChan <- fmt.Errorf("Failed to create template %s: %v", template.Name, err)
+				return
+			}
+			errChan <- nil
+		}()
+	}
+
+	for range templates {
+		if err := <-errChan; err != nil {
+			log.Error(err)
 		}
 	}
 }

cmd/gignore/main.go

@@ -1,3 +1,5 @@
+// Package main provides the entry point for the gignore command-line tool,
+// which generates .gitignore files based on specified templates.
 package main
 
 import (
@@ -14,14 +16,14 @@ func main() {
 		w := flag.CommandLine.Output()
 
 		fmt.Fprint(w, "Usage of gignore:\n")
-		fmt.Fprintf(w, "  gignore [flags] <template>\n")
+		fmt.Fprint(w, "  gignore [flags] <template>\n")
 		fmt.Fprint(w, "\n")
 
 		fmt.Fprint(w, "Flags:\n")
 		flag.PrintDefaults()
 
 		fmt.Fprint(w, "\n")
-		fmt.Fprintf(w, "Example:\n")
+		fmt.Fprint(w, "Example:\n")
 		fmt.Fprint(w, "  gignore go\n")
 	}
 
@@ -57,20 +59,21 @@ func main() {
 	}
 
 	args := flag.Args()
-	if len(args) != 1 {
+	if len(args) == 0 {
 		flag.Usage()
 		return
 	}
 
-	err := client.Create(args[0])
+	for _, arg := range args {
-	if err != nil {
+		err := client.Create(arg)
-		log.Fatalf("failed to create .gitignore file: %v", err)
+		if err != nil {
+			log.Fatalf("failed to create .gitignore file: %v", err)
+		}
+		fmt.Printf("√ created %s .gitignore file\n", arg)
 	}
-
-	fmt.Printf("√ created %s .gitignore file\n", args[0])
 }
 
-func listTemplates(client *gignore.GignoreClient) error {
+func listTemplates(client *gignore.Client) error {
 	templates, err := client.List()
 	if err != nil {
 		return err

cmd/gignore/util.go

@@ -4,7 +4,7 @@ import "os"
 
 func getEnv(key, defaultValue string) string {
 	value := os.Getenv(key)
-	if len(value) == 0 {
+	if value == "" {
 		return defaultValue
 	}
 	return value

error.go

@@ -1,16 +1,16 @@
+// Package gignore provides a way to manage .gitignore files and templates.
 package gignore
 
 import (
 	"fmt"
-
+	"strings"
-	"github.com/onyx-and-iris/gignore/internal/registry"
 )
 
 type templateNotFoundError struct {
-	template string
+	template          string
-	registry *registry.TemplateRegistry
+	templatesSearched []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, ", "))
 }

gignore.go

@@ -3,65 +3,70 @@ package gignore
 import (
 	"io"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/onyx-and-iris/gignore/internal/filewriter"
 	"github.com/onyx-and-iris/gignore/internal/registry"
+	log "github.com/sirupsen/logrus"
 )
 
-//go:generate go run cmd/gen/gen.go
+//go:generate go run cmd/gen/main.go
 
-type GignoreClient struct {
+// Client is a client for managing .gitignore templates.
+type Client struct {
 	registry *registry.TemplateRegistry
 	writer   io.Writer
 }
 
-func New(options ...Option) *GignoreClient {
+// New creates a new Client with the provided options.
-	gc := &GignoreClient{
+func New(options ...Option) *Client {
+	c := &Client{
 		registry.New(),
-		filewriter.New()}
+		filewriter.New(),
-
-	for _, option := range options {
-		option(gc)
 	}
 
-	return gc
+	for _, option := range options {
+		option(c)
+	}
+
+	return c
 }
 
-func (g *GignoreClient) List() ([]string, error) {
+// List returns a list of available .gitignore templates.
-	return g.registry.ListTemplates()
+func (c *Client) List() ([]string, error) {
+	return c.registry.List()
 }
 
-func (g *GignoreClient) Create(template string) error {
+// Create generates a .gitignore file from the specified template.
-	ok, err := g.registry.Contains(template)
+func (c *Client) Create(template string) error {
+	ok, err := c.registry.Contains(template)
 	if err != nil {
 		return err
 	}
 	if !ok {
-		templateNotFoundErr := &templateNotFoundError{template, g.registry}
+		templateNotFoundErr := &templateNotFoundError{template, []string{c.registry.Directory}}
-		if g.registry.Directory == "gitignoreio" {
+		if c.registry.Directory == "gitignoreio" {
 			return templateNotFoundErr
 		}
 
-		log.Errorf("%s. Checking default registry...", templateNotFoundErr)
+		c.registry.Directory = "gitignoreio"
-
+		ok, err = c.registry.Contains(template)
-		g.registry.Directory = "gitignoreio"
-		ok, err = g.registry.Contains(template)
 		if err != nil {
 			return err
 		}
 		if !ok {
+			templateNotFoundErr.templatesSearched = append(templateNotFoundErr.templatesSearched, c.registry.Directory)
 			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 := g.registry.GetTemplate(template)
+	content, err := c.registry.Get(template)
 	if err != nil {
 		return err
 	}
 
-	_, err = g.writer.Write(content)
+	_, err = c.writer.Write(content)
 	if err != nil {
 		return err
 	}

go.mod

@@ -7,4 +7,4 @@ require (
 	github.com/sirupsen/logrus v1.9.3
 )
 
-require golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8 // indirect
+require golang.org/x/sys v0.31.0 // indirect

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/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY=
 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.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
+golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 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/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=

internal/filewriter/filewriter.go

@@ -1,3 +1,4 @@
+// Package filewriter provides functionality to write content to a .gitignore file.
 package filewriter
 
 import (
@@ -6,11 +7,14 @@ import (
 	"os"
 )
 
+// FileWriter provides functionality to write content to a .gitignore file.
 type FileWriter struct {
+	targetFileName string
 }
 
+// New creates a new FileWriter with the default target file name.
 func New() *FileWriter {
-	return &FileWriter{}
+	return &FileWriter{".gitignore"}
 }
 
 func (fw *FileWriter) writeContent(content []byte, dst io.Writer) (int64, error) {
@@ -25,14 +29,14 @@ func (fw *FileWriter) writeContent(content []byte, dst io.Writer) (int64, error)
 }
 
 func (fw *FileWriter) Write(content []byte) (int, error) {
-	f, err := os.Create(".gitignore")
+	f, err := os.OpenFile(fw.targetFileName, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0o600)
 	if err != nil {
 		return 0, err
 	}
 	defer f.Close()
 
-	const header = `# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore`
+	const header = "# Auto-generated .gitignore by gignore: github.com/onyx-and-iris/gignore\n"
-	const footer = `# End of gignore: github.com/onyx-and-iris/gignore`
+	const footer = "\n# End of gignore: github.com/onyx-and-iris/gignore\n"
 
 	var sz int64
 	n, err := fw.writeContent([]byte(header), f)

internal/registry/registry.go

@@ -1,3 +1,4 @@
+// Package registry provides functionality to manage and retrieve gitignore templates.
 package registry
 
 import (
@@ -10,11 +11,13 @@ import (
 //go:embed templates
 var templates embed.FS
 
+// TemplateRegistry provides methods to manage and retrieve gitignore templates.
 type TemplateRegistry struct {
 	templates fs.FS
 	Directory string
 }
 
+// New creates a new instance of TemplateRegistry.
 func New() *TemplateRegistry {
 	return &TemplateRegistry{
 		templates: templates,
@@ -25,6 +28,7 @@ func (t *TemplateRegistry) filePath(name string) string {
 	return fmt.Sprintf("templates/%s/%s.gitignore", t.Directory, name)
 }
 
+// Contains checks if a template with the given name exists in the registry.
 func (t *TemplateRegistry) Contains(name string) (bool, error) {
 	_, err := fs.Stat(t.templates, t.filePath(name))
 	if err != nil {
@@ -37,7 +41,8 @@ func (t *TemplateRegistry) Contains(name string) (bool, error) {
 	return true, nil
 }
 
-func (t *TemplateRegistry) GetTemplate(name string) ([]byte, error) {
+// Get retrieves the content of the gitignore template with the given name.
+func (t *TemplateRegistry) Get(name string) ([]byte, error) {
 	data, err := fs.ReadFile(t.templates, t.filePath(name))
 	if err != nil {
 		return nil, err
@@ -45,7 +50,8 @@ func (t *TemplateRegistry) GetTemplate(name string) ([]byte, error) {
 	return data, nil
 }
 
-func (t *TemplateRegistry) ListTemplates() ([]string, error) {
+// List lists all the gitignore templates in the registry.
+func (t *TemplateRegistry) List() ([]string, error) {
 	var paths []string
 
 	err := fs.WalkDir(

option.go

@@ -1,9 +1,11 @@
 package gignore
 
-type Option func(*GignoreClient)
+// Option is a function that configures a GignoreClient.
+type Option func(*Client)
 
+// WithTemplateDirectory sets the template directory for the GignoreClient.
 func WithTemplateDirectory(directory string) Option {
-	return func(g *GignoreClient) {
+	return func(c *Client) {
-		g.registry.Directory = directory
+		c.registry.Directory = directory
 	}
 }