feat: configurable ignored files and directories

luissimas · Jun 4, 2024 · b34935f · b34935f
1 parent bc0443a
commit b34935f
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 - [X] Read config
 - [X] Find all files recursivelly
 - [X] Parse markdown links
-- [ ] Configurable ignore file patterns
+- [X] Configurable ignore file patterns
 - [ ] Get zettelkasten from git url
 - [ ] Support private repositories (Maybe with Github's PAT?)
 - [ ] Exclude links to non existing files

diff --git a/cmd/zettelkasten-exporter/main.go b/cmd/zettelkasten-exporter/main.go
@@ -33,7 +33,7 @@ func main() {
 	}
 
 	fs := os.DirFS(absolute_path)
-	collector := collector.NewCollector(fs)
+	collector := collector.NewCollector(fs, cfg.IgnoreFiles)
 
 	promHandler := promhttp.Handler()
 	http.Handle("/metrics", http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {

diff --git a/internal/collector/collector.go b/internal/collector/collector.go
@@ -26,11 +26,11 @@ type Collector struct {
 	config CollectorConfig
 }
 
-func NewCollector(fileSystem fs.FS) Collector {
+func NewCollector(fileSystem fs.FS, ignorePatterns []string) Collector {
 	return Collector{
 		config: CollectorConfig{
 			FileSystem:     fileSystem,
-			IgnorePatterns: []string{".obsidian"},
+			IgnorePatterns: ignorePatterns,
 		},
 	}
 }
@@ -61,9 +61,12 @@ func (c *Collector) collectMetrics() (Metrics, error) {
 	notes := make(map[string]NoteMetrics)
 
 	err := fs.WalkDir(c.config.FileSystem, ".", func(path string, dir fs.DirEntry, err error) error {
-		// Skip all files in ignored directories
+		// Skip ignored files or directories
 		if slices.Contains(c.config.IgnorePatterns, filepath.Base(path)) {
-			return filepath.SkipDir
+			if dir.IsDir() {
+				return filepath.SkipDir
+			}
+			return nil
 		}
 		// Skip other directories and non markdown files
 		if dir.IsDir() || filepath.Ext(path) != ".md" {

diff --git a/internal/collector/collector_test.go b/internal/collector/collector_test.go
@@ -42,8 +42,12 @@ created-at: "2024-05-29"
 ---
 Link to [one](./one.md) and also a full link [[./dir1/dir2/three]] and a [[./dir1/two.md|full link with .md]]
 		`)},
+		"ignoredir/foo":         {Data: []byte("Foo contents")},
+		"ignoredir/bar":         {Data: []byte("Bar contents")},
+		"ignoredir/test.md":     {Data: []byte("Test.md contents")},
+		"zettel/dir1/ignore.md": {Data: []byte("Ignore.md contents")},
 	}
-	c := NewCollector(fs)
+	c := NewCollector(fs, []string{"ignore.md", "ignoredir"})
 	expected := Metrics{
 		NoteCount: 4,
 		LinkCount: 7,

diff --git a/internal/config/config.go b/internal/config/config.go
@@ -13,18 +13,20 @@ import (
 type Config struct {
 	IP                    string     `koanf:"ip" validate:"required|ip"`
 	Port                  int        `koanf:"port" validate:"required|uint"`
-	LogLevel              slog.Level `koanf:"log_level"`
 	ZettelkastenDirectory string     `koanf:"zettelkasten_directory" validate:"required"`
+	LogLevel              slog.Level `koanf:"log_level"`
+	IgnoreFiles           []string   `koanf:"ignore_files"`
 }
 
 func LoadConfig() (Config, error) {
 	k := koanf.New(".")
 
 	// Set default values
 	k.Load(structs.Provider(Config{
-		IP:       "0.0.0.0",
-		Port:     6969,
-		LogLevel: slog.LevelInfo,
+		IP:          "0.0.0.0",
+		Port:        6969,
+		LogLevel:    slog.LevelInfo,
+		IgnoreFiles: []string{".git", ".obsidian", ".trash"},
 	}, "koanf"), nil)
 
 	// Load env variables

diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -19,6 +19,7 @@ func TestLoadConfig_DefaultValues(t *testing.T) {
 		Port:                  6969,
 		LogLevel:              slog.LevelInfo,
 		ZettelkastenDirectory: "/any/dir",
+		IgnoreFiles:           []string{".git", ".obsidian", ".trash"},
 	}
 	assert.Equal(t, expected, c)
 }
@@ -34,6 +35,7 @@ func TestLoadConfig_PartialEnv(t *testing.T) {
 			Port:                  4444,
 			LogLevel:              slog.LevelDebug,
 			ZettelkastenDirectory: "/any/dir",
+			IgnoreFiles:           []string{".git", ".obsidian", ".trash"},
 		}
 		assert.Equal(t, expected, c)
 	}
@@ -44,13 +46,15 @@ func TestLoadConfig_FullEnv(t *testing.T) {
 	t.Setenv("PORT", "4444")
 	t.Setenv("LOG_LEVEL", "DEBUG")
 	t.Setenv("ZETTELKASTEN_DIRECTORY", "/any/dir")
+	t.Setenv("IGNORE_FILES", ".obsidian,test,/something/another,dir/file.md")
 	c, err := LoadConfig()
 	if assert.NoError(t, err) {
 		expected := Config{
 			IP:                    "127.0.0.1",
 			Port:                  4444,
 			LogLevel:              slog.LevelDebug,
 			ZettelkastenDirectory: "/any/dir",
+			IgnoreFiles:           []string{".obsidian", "test", "/something/another", "dir/file.md"},
 		}
 		assert.Equal(t, expected, c)
 	}