refactor(config): cleaned up documentation

Rihoj · Rihoj · commit 3ea89f9acf56 · 2022-08-28T23:17:53.000-04:00
diff --git a/cmd/root.go b/cmd/root.go
@@ -37,7 +37,7 @@ func Execute() {
 
 func init() {
 	cobra.OnInitialize(initConfig)
-	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", fmt.Sprintf("config file (default is %v)", config.GetConfigDir()))
+	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", fmt.Sprintf("config file (default is [$HOME/%%USERPROFILE%%]/%v)", config.DefaultConfigDir()))
 	// Instead of profiles for now, I recommend just passing in different config files.
 
 }
diff --git a/docs/toolsium.md b/docs/toolsium.md
@@ -12,7 +12,7 @@ These tools can include default filters, easy access to start a session on an ec
 ### Options
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
   -h, --help            help for toolsium
 ```
 
@@ -24,4 +24,4 @@ These tools can include default filters, easy access to start a session on an ec
 * [toolsium manage](toolsium_manage.md)	 - A brief description of your command
 * [toolsium mfa](toolsium_mfa.md)	 - A brief description of your command
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_completion.md b/docs/toolsium_completion.md
@@ -17,7 +17,7 @@ See each sub-command's help for details on how to use the generated script.
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
@@ -28,4 +28,4 @@ See each sub-command's help for details on how to use the generated script.
 * [toolsium completion powershell](toolsium_completion_powershell.md)	 - Generate the autocompletion script for powershell
 * [toolsium completion zsh](toolsium_completion_zsh.md)	 - Generate the autocompletion script for zsh
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_completion_bash.md b/docs/toolsium_completion_bash.md
@@ -40,11 +40,11 @@ toolsium completion bash
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium completion](toolsium_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_completion_fish.md b/docs/toolsium_completion_fish.md
@@ -31,11 +31,11 @@ toolsium completion fish [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium completion](toolsium_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_completion_powershell.md b/docs/toolsium_completion_powershell.md
@@ -28,11 +28,11 @@ toolsium completion powershell [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium completion](toolsium_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_completion_zsh.md b/docs/toolsium_completion_zsh.md
@@ -42,11 +42,11 @@ toolsium completion zsh [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium completion](toolsium_completion.md)	 - Generate the autocompletion script for the specified shell
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_docs.md b/docs/toolsium_docs.md
@@ -15,11 +15,11 @@ toolsium docs [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium](toolsium.md)	 - A handy set of tools for developers
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_init.md b/docs/toolsium_init.md
@@ -17,11 +17,11 @@ toolsium init [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium](toolsium.md)	 - A handy set of tools for developers
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_manage.md b/docs/toolsium_manage.md
@@ -24,12 +24,12 @@ toolsium manage [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium](toolsium.md)	 - A handy set of tools for developers
 * [toolsium manage papi](toolsium_manage_papi.md)	 - A brief description of your command
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_manage_papi.md b/docs/toolsium_manage_papi.md
@@ -24,11 +24,11 @@ toolsium manage papi [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium manage](toolsium_manage.md)	 - A brief description of your command
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/docs/toolsium_mfa.md b/docs/toolsium_mfa.md
@@ -24,11 +24,11 @@ toolsium mfa [token] [flags]
 ### Options inherited from parent commands
 
 ```
-      --config string   config file (default is $HOME/.toolsium.json)
+      --config string   config file (default is [$HOME/%USERPROFILE%]/.toolsium)
 ```
 
 ### SEE ALSO
 
 * [toolsium](toolsium.md)	 - A handy set of tools for developers
 
-###### Auto generated by spf13/cobra on 27-Aug-2022
+###### Auto generated by spf13/cobra on 28-Aug-2022
diff --git a/lib/config/config.go b/lib/config/config.go
@@ -37,7 +37,7 @@ func (t *Toolsium) GetConfigDir() (path string) {
 	if t.ConfigDir != "" {
 		path = t.ConfigDir
 	} else {
-		path = t.DefaultConfigDir()
+		path = t.DefaultConfigDirPath()
 	}
 	return
 }
@@ -49,7 +49,7 @@ func SetConfigDir(confDir string) { t.SetConfigDir(confDir) }
 func (t *Toolsium) SetConfigDir(confDir string) {
 	if _, osErr := os.Stat(confDir); os.IsNotExist(osErr) {
 		log.Infof("Provided config directory didn't exist. %v", confDir)
-		t.ConfigDir = t.DefaultConfigDir()
+		t.ConfigDir = t.DefaultConfigDirPath()
 	}
 	t.ConfigDir = confDir
 }
diff --git a/lib/config/defaults.go b/lib/config/defaults.go
@@ -12,14 +12,19 @@ const (
 	cfgPrefix     = "TOOL"
 )
 
-// Returns the default Config Dir path
 func DefaultConfigDir() string { return t.DefaultConfigDir() }
-func (t *Toolsium) DefaultConfigDir() (path string) {
+func (t *Toolsium) DefaultConfigDir() string {
+	return cfgFolderName
+}
+
+// Returns the default Config Dir path
+func DefaultConfigDirPath() string { return t.DefaultConfigDirPath() }
+func (t *Toolsium) DefaultConfigDirPath() (path string) {
 	home, err := os.UserHomeDir()
 	if err != nil {
 		panic(err)
 	}
-	path = filepath.Join(home, cfgFolderName)
+	path = filepath.Join(home, t.DefaultConfigDir())
 	return
 }
 
@@ -32,5 +37,5 @@ func (t *Toolsium) DefaultConfigFileName() string {
 // Returns the full default config path
 func DefaultConfigPath() string { return t.DefaultConfigPath() }
 func (t *Toolsium) DefaultConfigPath() string {
-	return filepath.Join(t.DefaultConfigDir(), t.DefaultConfigFileName())
+	return filepath.Join(t.DefaultConfigDirPath(), t.DefaultConfigFileName())
 }
diff --git a/lib/config/toolsium.go b/lib/config/toolsium.go
@@ -25,7 +25,7 @@ func init() {
 func New() (t *Toolsium) {
 	t = new(Toolsium)
 	t.Config = viper.New()
-	t.ConfigDir = DefaultConfigDir()
+	t.ConfigDir = DefaultConfigDirPath()
 	t.ConfigFileName = DefaultConfigFileName()
 	return
 }

Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ func Execute() {`
`37`	`37`
`38`	`38`	`func init() {`
`39`	`39`	`cobra.OnInitialize(initConfig)`
`40`		`- rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", fmt.Sprintf("config file (default is %v)", config.GetConfigDir()))`
	`40`	`+ rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", fmt.Sprintf("config file (default is [$HOME/%%USERPROFILE%%]/%v)", config.DefaultConfigDir()))`
`41`	`41`	`// Instead of profiles for now, I recommend just passing in different config files.`
`42`	`42`
`43`	`43`	`}`