feat: .leafwikiignore (#1263)

IgnoreFile struct wrapping github.com/sabhiram/go-gitignore with
LoadFromDir(), Matches(path, isDir), and PatternCount() methods.

Author: designermonkey

.golangci-lint

@@ -0,0 +1,23 @@
+version: "2"
+linters:
+  enable:
+    - govet
+    - unused
+    - gocritic
+    - staticcheck
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.golangci.yml

@@ -545,6 +545,63 @@ For most setups, prefer `--public-access` for read-only public access and the vi
 
 ---
 
+## .leafwikiignore — Ignore Files
+
+LeafWiki indexes every `.md` file it finds on disk. If you have files or directories you want to keep on disk but exclude from the wiki (draft pages, archive sections, private notes, imported markdown being organized), create a `.leafwikiignore` file at the root of your wiki's data directory.
+
+**Location:** Anywhere under `root/`. A `.leafwikiignore` at the wiki root applies to the entire wiki; per-directory files apply to their directory and its children.
+
+**Syntax:** Standard gitignore-style patterns:
+
+| Pattern | Meaning |
+|---------|---------|
+| `#` | Comment |
+| `*` | Matches anything except `/` |
+| `?` | Matches any single char except `/` |
+| `**` | Matches zero or more directories |
+| Trailing `/` | Directory-only match |
+| Leading `/` | Anchored to wiki root |
+| `!` prefix | Negation (un-ignore) |
+
+**Examples:**
+
+```gitignore
+# Exclude all log files
+*.log
+
+# Exclude entire directory
+drafts/
+
+# Exclude everything except important.md
+*.md
+!important.md
+```
+
+**Notes:**
+- Changes to any `.leafwikiignore` require a restart to take effect.
+- Ignored files are hidden completely — remove the ignore pattern to see them again.
+- Per-directory ignore files are supported: any directory under `root/` may contain its own `.leafwikiignore`. Patterns accumulate from root to leaf, and child patterns can negate parent patterns with `!`.
+
+**Multi-level example:**
+
+```gitignore
+# root/.leafwikiignore — applies everywhere
+*.md
+
+# root/docs/.leafwikiignore — un-ignore specific files under docs/
+!important.md
+
+# root/docs/archive/.leafwikiignore — re-ignore files under archive/
+*.md
+```
+
+In this example:
+- All `.md` files are ignored by default (root rule).
+- `docs/important.md` is un-ignored (child negation).
+- `docs/archive/` is re-ignored (grandchild re-applies the restriction).
+
+---
+
 ## Sorting Pages
 
 Page order in LeafWiki is **explicit and manual** — it does not follow filename or alphabetical order automatically. By default, pages appear in the order they were created.

README.md

@@ -23,6 +23,7 @@ import (
 	"github.com/dustin/go-humanize"
 	"github.com/gin-gonic/gin"
 	"github.com/perber/wiki/internal/backup"
+	"github.com/perber/wiki/internal/core/ignore"
 	"github.com/perber/wiki/internal/core/tools"
 	httpinternal "github.com/perber/wiki/internal/http"
 	httpmetrics "github.com/perber/wiki/internal/http/metrics"
@@ -149,11 +150,12 @@ func printUsage() {
 
 func setupLogger() {
 	level := slog.LevelInfo
-	if os.Getenv("LEAFWIKI_LOG_LEVEL") == "debug" {
+	switch os.Getenv("LEAFWIKI_LOG_LEVEL") {
+	case "debug":
 		level = slog.LevelDebug
-	} else if (os.Getenv("LEAFWIKI_LOG_LEVEL")) == "error" {
+	case "error":
 		level = slog.LevelError
-	} else if (os.Getenv("LEAFWIKI_LOG_LEVEL")) == "warn" {
+	case "warn":
 		level = slog.LevelWarn
 	}
 
@@ -447,6 +449,15 @@ func main() {
 	if err != nil {
 		fail("Failed to initialize Wiki", "error", err)
 	}
+
+	// Log .leafwikiignore status
+	rootDir := filepath.Join(dataDir, "root")
+	if ignoreFile, err := ignore.LoadFromDir(rootDir); err != nil {
+		slog.Default().Warn("invalid .leafwikiignore", "error", err)
+	} else if ignoreFile != nil {
+		slog.Default().Info("loaded .leafwikiignore", "patterns", ignoreFile.PatternCount())
+	}
+
 	defer func() {
 		if err := w.Close(); err != nil {
 			slog.Default().Error("Failed to close Wiki", "error", err)

cmd/leafwiki/main.go

@@ -347,7 +347,9 @@ func TestRemoveStaleUnixSocket_RemovesExistingSocket(t *testing.T) {
 	}
 	dir := t.TempDir()
 	socketPath := filepath.Join(dir, "leafwiki.sock")
-
+	if len(socketPath) >= 100 {
+		t.Skipf("socket path too long (%d chars) for this platform", len(socketPath))
+	}
 	listener, err := net.Listen("unix", socketPath)
 	if err != nil {
 		t.Fatalf("listen unix: %v", err)
@@ -387,7 +389,9 @@ func TestListenOnUnixSocket_CreatesSocketWithExpectedPermissions(t *testing.T) {
 	}
 	dir := t.TempDir()
 	socketPath := filepath.Join(dir, "leafwiki.sock")
-
+	if len(socketPath) >= 100 {
+		t.Skipf("socket path too long (%d chars) for this platform", len(socketPath))
+	}
 	listener, err := listenOnUnixSocket(socketPath)
 	if err != nil {
 		t.Fatalf("listenOnUnixSocket() error = %v", err)

cmd/leafwiki/main_test.go

@@ -62,6 +62,7 @@ require (
 	github.com/quic-go/qpack v0.6.0 // indirect
 	github.com/quic-go/quic-go v0.59.1 // indirect
 	github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect
+	github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 // indirect
 	github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 // indirect
 	github.com/skeema/knownhosts v1.3.1 // indirect
 	github.com/twitchyliquid64/golang-asm v0.15.1 // indirect

go.mod

@@ -143,6 +143,8 @@ github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec h1:W09IVJc94
 github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=
 github.com/rogpeppe/go-internal v1.14.1 h1:UQB4HGPB6osV0SQTLymcB4TgvyWu6ZyliaW0tI/otEQ=
 github.com/rogpeppe/go-internal v1.14.1/go.mod h1:MaRKkUm5W0goXpeCfT7UZI6fk/L7L7so1lCWt35ZSgc=
+github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06 h1:OkMGxebDjyw0ULyrTYWeN0UNCCkmCWfjPnIA2W6oviI=
+github.com/sabhiram/go-gitignore v0.0.0-20210923224102-525f6e181f06/go.mod h1:+ePHsJ1keEjQtpvf9HHw0f4ZeJ0TLRsxhunSI2hYJSs=
 github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3 h1:n661drycOFuPLCN3Uc8sB6B/s6Z4t2xvBgU1htSHuq8=
 github.com/sergi/go-diff v1.3.2-0.20230802210424-5b0b94c5c0d3/go.mod h1:A0bzQcvG0E7Rwjx0REVgAGH58e96+X0MeOfepqsbeW4=
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
@@ -155,6 +157,7 @@ github.com/stretchr/objx v0.5.2/go.mod h1:FRsXN1f5AsAjCGJKqEizvkpNtU+EGNCLh3NxZ/
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/stretchr/testify v1.6.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
 github.com/stretchr/testify v1.8.4/go.mod h1:sz/lmYIOXD/1dqDmKjjqLyZ2RngseejIcXlSw2iwfAo=

go.sum

@@ -26,4 +26,4 @@ func EnsureGitignore(repoDir string) error {
 	}
 	// os.WriteFile already respects the process umask — no manual umask needed
 	return os.WriteFile(gitignorePath, []byte(gitignoreContent), 0644)
-}
+}

internal/backup/gitignore.go

@@ -46,4 +46,4 @@ func TestEnsureGitignore_DoesNotOverwrite(t *testing.T) {
 	if string(content) != existingContent {
 		t.Errorf("expected content %q, got %q", existingContent, string(content))
 	}
-}
+}

internal/backup/gitignore_test.go

@@ -43,13 +43,13 @@ var errRemoteBranchNotFound = errors.New("remote branch not found")
 
 // Repository wraps a git repository with backup-specific state.
 type Repository struct {
-	mu               sync.Mutex     // serialises RunBackup and ForcePush so the HTTP handler can't race the scheduler goroutine
+	mu               sync.Mutex // serialises RunBackup and ForcePush so the HTTP handler can't race the scheduler goroutine
 	cfg              Config
 	repoDir          string
 	repo             *gogit.Repository
 	status           *Status
 	looseObjsSinceGC int
-	lastPushedHash   plumbing.Hash  // hash of the last commit successfully pushed; zero = never pushed
+	lastPushedHash   plumbing.Hash // hash of the last commit successfully pushed; zero = never pushed
 }
 
 // Init opens an existing repo at repoDir or initialises a new one.
@@ -855,18 +855,19 @@ func (r *Repository) buildSSHAuth() (ssh.AuthMethod, error) {
 	var err error
 
 	// Try SSHKey string first
-	if r.cfg.SSHKey != "" {
+	switch {
+	case r.cfg.SSHKey != "":
 		slog.Debug("buildSSHAuth: using inline SSH key")
 		privateKey = []byte(r.cfg.SSHKey)
-	} else if r.cfg.SSHKeyPath != "" {
+	case r.cfg.SSHKeyPath != "":
 		slog.Debug("buildSSHAuth: reading SSH key from file", "path", r.cfg.SSHKeyPath)
 		privateKey, err = os.ReadFile(r.cfg.SSHKeyPath)
 		if err != nil {
 			slog.Debug("buildSSHAuth: failed to read SSH key file", "path", r.cfg.SSHKeyPath, "error", err)
 			return nil, fmt.Errorf("failed to read SSH key: %w", err)
 		}
 		slog.Debug("buildSSHAuth: SSH key file read successfully", "path", r.cfg.SSHKeyPath, "size", len(privateKey))
-	} else {
+	default:
 		slog.Debug("buildSSHAuth: no SSH key configured (neither inline nor path)")
 		return nil, fmt.Errorf("no SSH key provided")
 	}