Rename Config to Cli

I was thrown when I wanted to output attributes, since the flag was
`--output-attributes`, when I assumed it would just be `--atributes`.

Upon further investigation it seems that `Configs` really is not a good
name for what it's doing, because it only really contains CLI stuff, so
I have renamed it accordingly.

config.go → cli.go

@@ -6,27 +6,27 @@ import (
 	flag "github.com/spf13/pflag"
 )
 
-// Configs sets different settings when running something with viaduct
-type Configs struct {
-	DryRun           bool
-	DumpManifest     bool
-	OutputAttributes bool
-	Quiet            bool
-	Silent           bool
+// CliFlags configures the command-line toolset
+type CliFlags struct {
+	Attributes   bool
+	DryRun       bool
+	DumpManifest bool
+	Quiet        bool
+	Silent       bool
 }
 
-// initConfigs loads configuration
-func initConfigs(c *Configs) {
+// initCli loads command-line options
+func initCli(c *CliFlags) {
 	var (
-		dryRun           bool
-		dumpManifest     bool
-		outputAttributes bool
-		quiet            bool
-		silent           bool
+		attributes   bool
+		dryRun       bool
+		dumpManifest bool
+		quiet        bool
+		silent       bool
 	)
 
 	flag.BoolVar(&dryRun, "dry-run", false, "Test changes with dry-run mode")
-	flag.BoolVar(&outputAttributes, "output-attributes", false, "Output attributes only")
+	flag.BoolVar(&attributes, "attributes", false, "Display known attributes")
 	flag.BoolVar(&dumpManifest, "dump-manifest", false, "Dump the full manifest after the run")
 	flag.BoolVar(&quiet, "quiet", false, "Quiet mode will only display errors during a run")
 	flag.BoolVar(&silent, "silent", false, "Silent mode will suppress all output")
@@ -36,29 +36,29 @@ func initConfigs(c *Configs) {
 		log.Fatal("Cannot use --silent and --quiet together")
 	}
 
+	c.Attributes = attributes
 	c.DryRun = dryRun
 	c.DumpManifest = dumpManifest
-	c.OutputAttributes = outputAttributes
 	c.Quiet = quiet
 	c.Silent = silent
 }
 
 // SetDryRun enables dry run mode.
-func (c *Configs) SetDryRun() {
+func (c *CliFlags) SetDryRun() {
 	c.DryRun = true
 }
 
 // SetDumpManifest enables dumping the manifest.
-func (c *Configs) SetDumpManifest() {
+func (c *CliFlags) SetDumpManifest() {
 	c.DumpManifest = true
 }
 
 // SetQuiet enables quiet mode.
-func (c *Configs) SetQuiet() {
+func (c *CliFlags) SetQuiet() {
 	c.Quiet = true
 }
 
 // SetSilent enables silent mode.
-func (c *Configs) SetSilent() {
+func (c *CliFlags) SetSilent() {
 	c.Silent = true
 }

helpers.go

@@ -176,9 +176,9 @@ func CommandTrue(command string) bool {
 
 	// nolint:gosec
 	cmd := exec.Command("bash", "-c", strings.Join(c, " "))
-	if Config.Quiet {
+	if Cli.Quiet {
 		cmd.Stderr = os.Stderr
-	} else if !Config.Silent {
+	} else if !Cli.Silent {
 		cmd.Stdout = os.Stdout
 		cmd.Stderr = os.Stderr
 	}

log.go

@@ -34,11 +34,11 @@ func Log(v ...interface{}) {
 }
 
 func NewLogger(resource, action string) *Logger {
-	if Config.Silent {
+	if Cli.Silent {
 		return NewSilentLogger()
 	}
 
-	if Config.Quiet {
+	if Cli.Quiet {
 		return NewQuietLogger(resource, action)
 	}
 

main.go

@@ -8,21 +8,21 @@ import (
 
 var (
 	Attribute SystemAttributes
-	Config    Configs
+	Cli       CliFlags
 
 	tmpDirPath string
 )
 
 func init() {
 	initAttributes(&Attribute)
-	initConfigs(&Config)
+	initCli(&Cli)
 
-	if Config.OutputAttributes {
+	if Cli.Attributes {
 		fmt.Println(Attribute.JSON())
 		os.Exit(0)
 	}
 
-	if Config.DryRun {
+	if Cli.DryRun {
 		log.Println("WARNING: dry run mode enabled")
 	}
 }

manifest.go

@@ -190,7 +190,7 @@ func (m *Manifest) Run() {
 		}
 	}
 
-	if Config.DumpManifest {
+	if Cli.DumpManifest {
 		tmpName := fmt.Sprintf("/tmp/viaduct-%d.json", time.Now().Unix())
 
 		out, err := json.MarshalIndent(m.resources, "", "    ")
@@ -207,7 +207,7 @@ func (m *Manifest) Run() {
 	}
 
 	if withErrors {
-		if !Config.DumpManifest {
+		if !Cli.DumpManifest {
 			log.Info("To see all resources, run with --dump-manifest")
 		}
 		os.Exit(1)

resources/apt.go

@@ -119,7 +119,7 @@ func (a *Apt) Run(log *viaduct.Logger) error {
 // AptUpdate is a helper function to perform "apt-get update"
 // Should be converted to a proper resource
 func (a *Apt) updateApt(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info()
 		return nil
 	}
@@ -144,7 +144,7 @@ func (a *Apt) updateApt(log *viaduct.Logger) error {
 
 // Create adds a new apt repository
 func (a *Apt) createApt(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(a.Name)
 		return nil
 	}
@@ -265,7 +265,7 @@ func (a *Apt) signingKeyPath() string {
 
 // Delete removes an apt repository
 func (a *Apt) deleteApt(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(a.Name)
 		return nil
 	}

resources/directory.go

@@ -58,7 +58,7 @@ func (d *Directory) Run(log *viaduct.Logger) error {
 func (d *Directory) createDirectory(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(d.Path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(d.Path)
 		return nil
 	}
@@ -82,7 +82,7 @@ func (d *Directory) createDirectory(log *viaduct.Logger) error {
 
 // Delete deletes a directory.
 func (d *Directory) deleteDirectory(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(d.Path)
 		return nil
 	}

resources/download.go

@@ -59,7 +59,7 @@ func (a *Download) get(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(a.Path)
 	logmsg := fmt.Sprintf("%s -> %s", a.URL, path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(logmsg)
 		return nil
 	}

resources/execute.go

@@ -73,7 +73,7 @@ func (e *Execute) runExecute(log *viaduct.Logger) error {
 	}
 
 	log.Info(e.Command, " -> started")
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		return nil
 	}
 
@@ -93,13 +93,13 @@ func (e *Execute) runExecute(log *viaduct.Logger) error {
 }
 
 func setCommandOutput(cmd *exec.Cmd) {
-	if viaduct.Config.Silent {
+	if viaduct.Cli.Silent {
 		cmd.Stdout = nil
 		cmd.Stderr = nil
 		return
 	}
 
-	if viaduct.Config.Quiet {
+	if viaduct.Cli.Quiet {
 		cmd.Stdout = nil
 		cmd.Stderr = os.Stderr
 		return

resources/file.go

@@ -105,7 +105,7 @@ func (f *File) Run(log *viaduct.Logger) error {
 
 // Create creates or updates a file
 func (f *File) createFile(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(f.Path)
 		return nil
 	}
@@ -142,7 +142,7 @@ func (f *File) createFile(log *viaduct.Logger) error {
 
 // Delete deletes a file
 func (f *File) deleteFile(log *viaduct.Logger) error {
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(f.Path)
 		return nil
 	}

resources/git.go

@@ -82,7 +82,7 @@ func (g *Git) createGit(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(g.Path)
 	logmsg := fmt.Sprintf("%s -> %s", g.URL, path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(logmsg)
 		return nil
 	}
@@ -125,7 +125,7 @@ func (g *Git) createGit(log *viaduct.Logger) error {
 	if !viaduct.FileExists(path) {
 		progress := os.Stdout
 
-		if viaduct.Config.Quiet || viaduct.Config.Silent {
+		if viaduct.Cli.Quiet || viaduct.Cli.Silent {
 			devnull, err := os.OpenFile(os.DevNull, os.O_WRONLY, 0755)
 			if err != nil {
 				return err
@@ -158,7 +158,7 @@ func (g *Git) createGit(log *viaduct.Logger) error {
 func (g *Git) deleteGit(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(g.Path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(path)
 		return nil
 	}

resources/link.go

@@ -79,7 +79,7 @@ func (l *Link) createLink(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(l.Path)
 	logmsg := fmt.Sprintf("%s -> %s", source, path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(logmsg)
 		return nil
 	}
@@ -120,7 +120,7 @@ func (l *Link) createLink(log *viaduct.Logger) error {
 func (l *Link) deleteLink(log *viaduct.Logger) error {
 	path := viaduct.ExpandPath(l.Path)
 
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		log.Info(path)
 		return nil
 	}

resources/package.go

@@ -73,7 +73,7 @@ func (p *Package) Run(log *viaduct.Logger) error {
 
 func (p *Package) install(log *viaduct.Logger) error {
 	log.Info("Packages:\n\t", strings.Join(p.Names, "\n\t"))
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		return nil
 	}
 
@@ -82,7 +82,7 @@ func (p *Package) install(log *viaduct.Logger) error {
 
 func (p *Package) uninstall(log *viaduct.Logger) error {
 	log.Info("Packages:\n\t", strings.Join(p.Names, "\n\t"))
-	if viaduct.Config.DryRun {
+	if viaduct.Cli.DryRun {
 		return nil
 	}
 

resources/resources_test.go

@@ -5,6 +5,6 @@ import "github.com/surminus/viaduct"
 var testLogger *viaduct.Logger
 
 func init() {
-	viaduct.Config.SetSilent()
+	viaduct.Cli.SetSilent()
 	testLogger = viaduct.NewLogger("Test", "Testing")
 }