v0.23.2 bfd5eb4

xdg.go RawHistoryFolder

1// Package config provides configuration management for dumber with Viper integration.
2package config
3
4import (
5	"os"
6	"path/filepath"
7)
8
9// File permission constants
10const (
11	dirPerm  = 0755 // Standard directory permissions (rwxr-xr-x)
12	filePerm = 0644 // Standard file permissions (rw-r--r--)
13)
14
15const (
16	appName      = "dumber"
17	databaseName = "dumber.db"
18)
19
20// XDGDirs holds the XDG Base Directory paths for the application.
21type XDGDirs struct {
22	ConfigHome string
23	DataHome   string
24	StateHome  string
25	CacheHome  string
26}
27
28// GetXDGDirs returns the XDG Base Directory paths for dumber.
29// It follows the XDG Base Directory specification:
30// - $XDG_CONFIG_HOME/dumber (default: ~/.config/dumber)
31// - $XDG_DATA_HOME/dumber (default: ~/.local/share/dumber)
32// - $XDG_STATE_HOME/dumber (default: ~/.local/state/dumber)
33func GetXDGDirs() (*XDGDirs, error) {
34	// Development mode: use .dev directory in current working directory
35	if os.Getenv("ENV") == "dev" {
36		cwd, err := os.Getwd()
37		if err != nil {
38			return nil, err
39		}
40		devDir := filepath.Join(cwd, ".dev", appName)
41		return &XDGDirs{
42			ConfigHome: devDir,
43			DataHome:   devDir,
44			StateHome:  devDir,
45			CacheHome:  devDir,
46		}, nil
47	}
48
49	homeDir, err := os.UserHomeDir()
50	if err != nil {
51		return nil, err
52	}
53
54	// XDG_CONFIG_HOME
55	configHome := os.Getenv("XDG_CONFIG_HOME")
56	if configHome == "" {
57		configHome = filepath.Join(homeDir, ".config")
58	}
59	configHome = filepath.Join(configHome, appName)
60
61	// XDG_DATA_HOME
62	dataHome := os.Getenv("XDG_DATA_HOME")
63	if dataHome == "" {
64		dataHome = filepath.Join(homeDir, ".local", "share")
65	}
66	dataHome = filepath.Join(dataHome, appName)
67
68	// XDG_STATE_HOME
69	stateHome := os.Getenv("XDG_STATE_HOME")
70	if stateHome == "" {
71		stateHome = filepath.Join(homeDir, ".local", "state")
72	}
73	stateHome = filepath.Join(stateHome, appName)
74
75	// XDG_CACHE_HOME
76	cacheHome := os.Getenv("XDG_CACHE_HOME")
77	if cacheHome == "" {
78		cacheHome = filepath.Join(homeDir, ".cache")
79	}
80	cacheHome = filepath.Join(cacheHome, appName)
81
82	return &XDGDirs{
83		ConfigHome: configHome,
84		DataHome:   dataHome,
85		StateHome:  stateHome,
86		CacheHome:  cacheHome,
87	}, nil
88}
89
90// GetConfigDir returns the XDG config directory for dumber.
91func GetConfigDir() (string, error) {
92	dirs, err := GetXDGDirs()
93	if err != nil {
94		return "", err
95	}
96	return dirs.ConfigHome, nil
97}
98
99// GetDataDir returns the XDG data directory for dumber.
100func GetDataDir() (string, error) {
101	dirs, err := GetXDGDirs()
102	if err != nil {
103		return "", err
104	}
105	return dirs.DataHome, nil
106}
107
108// GetStateDir returns the XDG state directory for dumber.
109func GetStateDir() (string, error) {
110	dirs, err := GetXDGDirs()
111	if err != nil {
112		return "", err
113	}
114	return dirs.StateHome, nil
115}
116
117// GetLogDir returns the XDG-compliant log directory for dumber.
118// Logs are stored in XDG_STATE_HOME as per specification.
119func GetLogDir() (string, error) {
120	stateDir, err := GetStateDir()
121	if err != nil {
122		return "", err
123	}
124	return filepath.Join(stateDir, "logs"), nil
125}
126
127// GetConfigFile returns the path to the main configuration file.
128func GetConfigFile() (string, error) {
129	configDir, err := GetConfigDir()
130	if err != nil {
131		return "", err
132	}
133	return filepath.Join(configDir, "config.toml"), nil
134}
135
136// GetDatabaseFile returns the path to the database file in the data directory.
137// The database contains user data (history, favorites, preferences) that should
138// be backed up, so it belongs in XDG_DATA_HOME per the XDG specification.
139func GetDatabaseFile() (string, error) {
140	dataDir, err := GetDataDir()
141	if err != nil {
142		return "", err
143	}
144	return filepath.Join(dataDir, databaseName), nil
145}
146
147// GetFilterCacheDir returns the XDG-compliant filter cache directory for dumber.
148// Filter cache is stored in XDG_STATE_HOME as it's transient data that can be regenerated.
149func GetFilterCacheDir() (string, error) {
150	stateDir, err := GetStateDir()
151	if err != nil {
152		return "", err
153	}
154	return filepath.Join(stateDir, "filter-cache"), nil
155}
156
157// GetFilterCacheFile returns the path to the main filter cache file.
158func GetFilterCacheFile() (string, error) {
159	cacheDir, err := GetFilterCacheDir()
160	if err != nil {
161		return "", err
162	}
163	return filepath.Join(cacheDir, "filters.cache"), nil
164}
165
166// GetFaviconCacheDir returns the XDG-compliant favicon cache directory for dumber.
167// Favicon cache is stored in XDG_CACHE_HOME as it's transient data that can be refetched.
168func GetFaviconCacheDir() (string, error) {
169	dirs, err := GetXDGDirs()
170	if err != nil {
171		return "", err
172	}
173	return filepath.Join(dirs.CacheHome, "favicons"), nil
174}
175
176// EnsureDirectories creates the XDG directories if they don't exist.
177func EnsureDirectories() error {
178	dirs, err := GetXDGDirs()
179	if err != nil {
180		return err
181	}
182
183	// Create all directories with proper permissions
184	directories := []string{
185		dirs.ConfigHome,
186		dirs.DataHome,
187		dirs.StateHome,
188	}
189
190	for _, dir := range directories {
191		if err := os.MkdirAll(dir, dirPerm); err != nil {
192			return err
193		}
194	}
195
196	return nil
197}

Keyboard shortcuts

Single-key shortcuts are on. ctrl k and esc work whatever this says.

ctrl k :
go to a section, branch, tag, file or repository
?
this list
j k
move the row cursor down / up
enter
open the row under the cursor; on Files, a directory opens or closes in place
↑ ↓ ← → home end
in the file tree (focus on a row): previous / next row, close / open a directory or go to its parent / first entry, first / last row. They never open a file
l h
on Files: open a directory or a file / close a directory or go up to its parent, then to the parent page. Elsewhere: into the side panel (on a merge request, its files) / back to the content; there j k move between its controls
g g G
first / last row
/
filter the list; on Files, find a file anywhere in the repository (esc clears, enter opens the best match)
b
switch branch or tag
g s g f g c g b g m g i g r g a
tabs: summary, files, commits, branches & tags, merge requests, issues, releases, actions (when available)
g h
home
w
wide mode: use the whole width of the screen, or not (remembered)
y
copy a permalink pinned to the commit
d u x
diff: split / unified / collapse or expand all
e E
diff: the whole file in view / every file, with the lines the hunks hide
n
merge request: next note in the diff
esc
close a dialog, leave a field

Branches 8

Tags 42

↑↓ moveenter openesc close