Print PRINT_CONFIG_ONLY in markdown so it can be used in github issues #507

Author: bakito

cmd/print-config.go

@@ -0,0 +1,50 @@
+package cmd
+
+import (
+	"bytes"
+	_ "embed"
+	"os"
+	"sort"
+	"strings"
+	"text/template"
+
+	"github.com/bakito/adguardhome-sync/pkg/types"
+	"gopkg.in/yaml.v3"
+)
+
+//go:embed print-config.md
+var printConfigTemplate string
+
+func printConfig(cfg *types.Config, usedCfgFile string, cfgContent string) error {
+	config, err := yaml.Marshal(cfg)
+	if err != nil {
+		logger.Error(err)
+		return err
+	}
+
+	t, err := template.New("printConfigTemplate").Parse(printConfigTemplate)
+	if err != nil {
+		return err
+	}
+
+	env := os.Environ()
+	sort.Strings(env)
+
+	var buf bytes.Buffer
+
+	if err = t.Execute(&buf, map[string]interface{}{
+		"AggregatedConfig":     string(config),
+		"ConfigFilePath":       usedCfgFile,
+		"ConfigFileContent":    cfgContent,
+		"EnvironmentVariables": strings.Join(env, "\n"),
+	}); err != nil {
+		return err
+	}
+
+	logger.Infof(
+		"Printing adguardhome-sync aggregated config (THE APPLICATION WILL NOT START IN THIS MODE):\n%s",
+		buf.String(),
+	)
+
+	return nil
+}

cmd/print-config.md

@@ -0,0 +1,24 @@
+<!-- PLEASE COPY THE FOLLOWING OUTPUT AS IS INTO THE GITHUB ISSUE (Don't forget to mask your usernames, passwords and IPs when using this in an issue ) -->
+
+### AdGuardHome sync aggregated config
+
+```yaml
+{{ .AggregatedConfig }}
+```
+{{- if .ConfigFilePath }}
+### AdGuardHome sync unmodified config file
+
+Config file path: {{ .ConfigFilePath }}
+
+```yaml
+{{ .ConfigFileContent }}
+```
+{{- end }}
+
+### Environment Variables
+
+```ini
+{{ .EnvironmentVariables }}
+```
+
+<!-- END OF GITHUB ISSUE CONTENT -->

cmd/run.go

@@ -1,15 +1,10 @@
 package cmd
 
 import (
-	"os"
-	"sort"
-	"strings"
-
 	"github.com/bakito/adguardhome-sync/pkg/config"
 	"github.com/bakito/adguardhome-sync/pkg/log"
 	"github.com/bakito/adguardhome-sync/pkg/sync"
 	"github.com/spf13/cobra"
-	"gopkg.in/yaml.v3"
 )
 
 // runCmd represents the run command
@@ -31,28 +26,11 @@ var doCmd = &cobra.Command{
 		}
 
 		if cfg.PrintConfigOnly {
-			config, err := yaml.Marshal(cfg)
-			if err != nil {
+			if err := printConfig(cfg, usedCfgFile, cfgContent); err != nil {
+
 				logger.Error(err)
 				return err
 			}
-			logger.Infof(
-				"Printing adguardhome-sync aggregated config (THE APPLICATION WILL NOT START IN THIS MODE):\n"+
-					"# adguardhome-sync aggregated config\n%s",
-				string(config),
-			)
-
-			if cfgContent != "" {
-				logger.Infof(
-					"Printing adguardhome-sync config file:\n# adguardhome-sync config file: %s\n%s",
-					usedCfgFile,
-					cfgContent,
-				)
-			}
-
-			env := os.Environ()
-			sort.Strings(env)
-			logger.Infof("Printing adguardhome-sync environment variables: \n%s", strings.Join(env, "\n"))
 
 			return nil
 		}