Merge pull request #463 from Unpackerr/dn2_rename

davidnewhall · web-flow · commit 05da8b0ca05a · 2024-07-16T23:29:26.000-07:00
rename some files
diff --git a/init/config/README.md b/init/config/README.md
@@ -1,6 +1,6 @@
 # Unpackerr Configuration Generator
 
-This folder contains a [yaml](conf-builder.yml) file that describes the entire Unpackerr configuration.
+This folder contains a [yaml](definitions.yml) file that describes the entire Unpackerr configuration.
 This description includes all variables, their defaults, their recommendations, comments and documentation.
 
 ## Builders
diff --git a/init/config/compose.go b/init/config/compose.go
@@ -8,6 +8,8 @@ import (
 	"strings"
 )
 
+/* This file creates an example compose file: docker-compose.yml */
+
 //nolint:lll
 const (
 	space         = "   "
diff --git a/init/config/config.go b/init/config/config.go
diff --git a/init/config/definitions.yml b/init/config/definitions.yml
diff --git a/init/config/docusaurus.go b/init/config/docusaurus.go
@@ -13,6 +13,8 @@ import (
 	"github.com/BurntSushi/toml"
 )
 
+/* This file creates a folder full of docusaurus markdown files for https://unpackerr.zip */
+
 func printDocusaurus(config *Config, output string) {
 	// Generate index file first.
 	if err := makeGenerated(config, output); err != nil {
diff --git a/init/config/main.go b/init/config/main.go
@@ -1,4 +1,4 @@
-//go:generate go run . --config ../../examples/unpackerr.conf.example --compose ../../examples/docker-compose.yml --type config,compose --file conf-builder.yml
+//go:generate go run . --config ../../examples/unpackerr.conf.example --compose ../../examples/docker-compose.yml --type config,compose --file definitions.yml
 
 package main
 
@@ -27,7 +27,7 @@ const (
 	opTimeout      = 6 * time.Second
 )
 
-//go:embed conf-builder.yml
+//go:embed definitions.yml
 var confBuilder []byte
 
 type section string
@@ -88,7 +88,7 @@ func main() {
 	defer file.Close()
 
 	config := &Config{}
-	// Decode conf-builder file into Go data structure.
+	// Decode definitions file into Go data structure.
 	if err = yaml.NewDecoder(file).Decode(config); err != nil {
 		log.Fatalln(err) //nolint:gocritic
 	}
@@ -127,9 +127,9 @@ func parseFlags() *flags {
 	flag.StringVar(&flags.Compose, "compose", exampleCompose,
 		"Choose a filename for the generated docker compose service.")
 	flag.StringVar(&flags.Docs, "docs", outputDir,
-		"Choose folder for generated documentation. ")
+		"Choose folder for generated documentation.")
 	flag.StringVarP(&flags.File, "file", "f", "internal",
-		"URL or filepath for conf-builder.yml, internal uses the compiled-in file")
+		"URL or filepath for definitions.yml, 'internal' uses the compiled-in file.")
 	flag.Parse()
 
 	return &flags

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,8 @@ import (`
`8`	`8`	`"strings"`
`9`	`9`	`)`
`10`	`10`
	`11`	`+/* This file creates an example compose file: docker-compose.yml */`
	`12`	`+`
`11`	`13`	`//nolint:lll`
`12`	`14`	`const (`
`13`	`15`	`space = " "`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,8 @@ import (`
`13`	`13`	`"github.com/BurntSushi/toml"`
`14`	`14`	`)`
`15`	`15`
	`16`	`+/* This file creates a folder full of docusaurus markdown files for https://unpackerr.zip */`
	`17`	`+`
`16`	`18`	`func printDocusaurus(config *Config, output string) {`
`17`	`19`	`// Generate index file first.`
`18`	`20`	`if err := makeGenerated(config, output); err != nil {`