File: documentation.go

package info (click to toggle)
immich-go 0.31.0-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 94,260 kB
  • sloc: sh: 770; makefile: 21
file content (264 lines) | stat: -rw-r--r-- 7,273 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
package main

import (
	"bytes"
	"context"
	"encoding/json"
	"fmt"
	"log"
	"os"
	"path"
	"sort"
	"strings"

	"github.com/pelletier/go-toml/v2"
	"github.com/simulot/immich-go/app/root"
	"github.com/simulot/immich-go/internal/config"
	"github.com/spf13/cobra"
	"github.com/spf13/pflag"
	"gopkg.in/yaml.v3"
)

const (
	exampleTimeout = "20m"
)

type EnvVarInfo struct {
	Path    string
	Flag    string
	Usage   string
	Default pflag.Value
}

// collectEnvVars recursively collects environment variable information from cobra commands
func collectEnvVars(cmd *cobra.Command, envVars map[string]EnvVarInfo) {
	config.TraverseCommands(cmd, []string{}, func(cmd *cobra.Command, path []string) map[string]any {
		visitor := func(f *pflag.Flag) {
			if f.Name != "config" && f.Name != "help" {
				varName := "IMMICH_GO_"
				if len(path) > 0 {
					varName += strings.ToUpper(strings.ReplaceAll(strings.Join(path, "_"), "-", "_")) + "_"
				}
				varName += strings.ToUpper(strings.ReplaceAll(f.Name, "-", "_"))
				current, ok := envVars[varName]
				if !ok || len(current.Path) > len(strings.Join(path, " ")) {
					envVars[varName] = EnvVarInfo{
						Path:    strings.Join(path, " "),
						Flag:    f.Name,
						Usage:   f.Usage,
						Default: f.Value,
					}
				}
			}
		}
		// Process local flags for this command
		cmd.Flags().VisitAll(visitor)

		if cmd.HasPersistentFlags() {
			cmd.PersistentFlags().VisitAll(visitor)
		}
		return map[string]any{}
	})
}

// NewConfigFrom creates a configuration map from cobra command flags
func NewConfigFrom(cmd *cobra.Command) any {
	m := config.ToMap(cmd)
	return m
}

// generateEnvVarsDoc generates markdown documentation for environment variables
func generateEnvVarsDoc(rootCmd *cobra.Command, p string) {
	envVars := map[string]EnvVarInfo{}
	collectEnvVars(rootCmd, envVars)

	f, err := os.Create(path.Join(p, "environment.md"))
	if err != nil {
		panic(err)
	}
	defer f.Close()

	fmt.Fprintln(f, "# Environment Variables")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "The following environment variables can be used to configure `immich-go`.")
	fmt.Fprintln(f, "")

	// Group by path
	varsByPath := map[string][]struct {
		Name string
		Info EnvVarInfo
	}{}

	keys := make([]string, 0, len(envVars))
	for k := range envVars {
		keys = append(keys, k)
	}
	sort.Strings(keys)

	for _, k := range keys {
		info := envVars[k]
		path := info.Path
		if path == "" {
			path = "Global"
		}
		varsByPath[path] = append(varsByPath[path], struct {
			Name string
			Info EnvVarInfo
		}{k, info})
	}

	// Get sorted paths
	paths := make([]string, 0, len(varsByPath))
	for p := range varsByPath {
		paths = append(paths, p)
	}
	sort.Strings(paths)

	for _, p := range paths {
		fmt.Fprintf(f, "## %s\n\n", p)
		fmt.Fprintln(f, "| Variable | Flag | Default | Description |")
		fmt.Fprintln(f, "|----------|------|---------|-------------|")
		for _, v := range varsByPath[p] {
			defaultValue := v.Info.Default.String()
			if defaultValue != "" {
				defaultValue = "`" + defaultValue + "`"
			}

			fmt.Fprintf(f, "| `%s` | `--%s` | %s | %s |\n", v.Name, v.Info.Flag, defaultValue, v.Info.Usage)
		}
		fmt.Fprintln(f, "")
	}
}

// generateConfigurationFileExamples generates markdown documentation with configuration file examples
func generateConfigurationFileExamples(rootCmd *cobra.Command, p string) {
	cfg := NewConfigFrom(rootCmd)

	// Set example values for documentation
	if configMap, ok := cfg.(map[string]interface{}); ok {
		// Set server and API key in upload section
		if upload, ok := configMap["upload"].(map[string]interface{}); ok {
			upload["server"] = "https://immich.app"
			upload["api-key"] = "YOUR-API-KEY"
			upload["client-timeout"] = exampleTimeout
			upload["device-uuid"] = "HOSTNAME"
		}
		// Set server and API key in stack section
		if stack, ok := configMap["stack"].(map[string]interface{}); ok {
			stack["server"] = "https://immich.app"
			stack["api-key"] = "YOUR-API-KEY"
			stack["client-timeout"] = exampleTimeout
			stack["device-uuid"] = "HOSTNAME"
		}
		// Set server and API key in archive.from-immich section
		if archive, ok := configMap["archive"].(map[string]interface{}); ok {
			if fromImmich, ok := archive["from-immich"].(map[string]interface{}); ok {
				fromImmich["from-server"] = "https://old.immich.app"
				fromImmich["from-api-key"] = "OLD-API-KEY"
				fromImmich["from-client-timeout"] = exampleTimeout
			}
		}
		// Set timeout in upload.from-immich section
		if upload, ok := configMap["upload"].(map[string]interface{}); ok {
			if fromImmich, ok := upload["from-immich"].(map[string]interface{}); ok {
				fromImmich["from-client-timeout"] = exampleTimeout
				fromImmich["from-server"] = "https://old.immich.app"
				fromImmich["from-api-key"] = "OLD-API-KEY"
			}
		}

		// Set date ranges to example value
		setDateRanges(configMap, "2024-01-15,2024-03-31")
	}

	f, err := os.Create(path.Join(p, "configuration.md"))
	if err != nil {
		panic(err)
	}
	defer f.Close()

	fmt.Fprintln(f, "# Configuration File")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "The configuration file can be a `TOML`, `YAML` or `JSON` file. By default, `immich-go` looks for a file named `immich-go.toml` in the current directory.")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "## Configuration file structure")
	fmt.Fprintln(f, "")

	fmt.Fprintln(f, "<details>")
	fmt.Fprintln(f, "<summary>TOML</summary>")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "```toml")
	b, err := toml.Marshal(cfg)
	if err != nil {
		panic(err)
	}
	fmt.Fprint(f, string(b))
	fmt.Fprintln(f, "```")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "</details>")

	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "<details>")
	fmt.Fprintln(f, "<summary>YAML</summary>")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "```yaml")
	out := bytes.NewBuffer(nil)
	encoder := yaml.NewEncoder(out)
	encoder.SetIndent(2)
	err = encoder.Encode(cfg)
	if err != nil {
		panic(err)
	}
	fmt.Fprint(f, out.String())
	fmt.Fprintln(f, "```")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "</details>")

	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "<details>")
	fmt.Fprintln(f, "<summary>JSON</summary>")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "```json")
	out.Reset()
	encoderJ := json.NewEncoder(out)
	encoderJ.SetIndent("", "  ")
	err = encoderJ.Encode(cfg)
	if err != nil {
		panic(err)
	}
	fmt.Fprint(f, out.String())
	fmt.Fprintln(f, "```")
	fmt.Fprintln(f, "")
	fmt.Fprintln(f, "</details>")
}

// setDateRanges recursively sets all date-range fields in the configuration map
func setDateRanges(m map[string]interface{}, value string) {
	for k, v := range m {
		if k == "date-range" || k == "from-date-range" {
			// Try to set the DateRange value by calling Set on it
			if dr, ok := v.(interface{ Set(string) error }); ok {
				if err := dr.Set(value); err != nil {
					log.Printf("Error setting date range value: %v", err)
				}
			}
		} else if subMap, ok := v.(map[string]interface{}); ok {
			setDateRanges(subMap, value)
		}
	}
}

// main generates documentation for environment variables and configuration files
func main() {
	p := path.Base(path.Dir(os.Args[0]))
	rootCmd, _ := root.RootImmichGoCommand(context.Background())

	if p == "docs" {
		p = "."
	} else {
		p = "docs/"
	}
	// Generate documentation
	generateEnvVarsDoc(rootCmd, p)
	generateConfigurationFileExamples(rootCmd, p)
}