Skip to content

fix: [Docs] 12-Factor App tutorial has formatting issues and uses deprecated patterns #2343

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
majiayu000 wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −14
Open

fix: [Docs] 12-Factor App tutorial has formatting issues and uses deprecated patterns #2343

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 17 additions & 14 deletions site/content/user_guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,9 +79,9 @@ import (
)

var (
// Used for flags.
cfgFile string
userLicense string
v *viper.Viper

rootCmd = &cobra.Command{
Use: "cobra-cli",
Expand All @@ -98,16 +98,17 @@ func Execute() error {
}

func init() {
v = viper.New()
cobra.OnInitialize(initConfig)

rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.cobra.yaml)")
rootCmd.PersistentFlags().StringP("author", "a", "YOUR NAME", "author name for copyright attribution")
rootCmd.PersistentFlags().StringVarP(&userLicense, "license", "l", "", "name of license for the project")
rootCmd.PersistentFlags().Bool("viper", true, "use Viper for configuration")
viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
viper.BindPFlag("useViper", rootCmd.PersistentFlags().Lookup("viper"))
viper.SetDefault("author", "NAME HERE <EMAIL ADDRESS>")
viper.SetDefault("license", "apache")
v.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
v.BindPFlag("useViper", rootCmd.PersistentFlags().Lookup("viper"))
v.SetDefault("author", "NAME HERE <EMAIL ADDRESS>")
v.SetDefault("license", "apache")

rootCmd.AddCommand(addCmd)
rootCmd.AddCommand(initCmd)
Expand All @@ -116,22 +117,22 @@ func init() {
func initConfig() {
if cfgFile != "" {
// Use config file from the flag.
viper.SetConfigFile(cfgFile)
v.SetConfigFile(cfgFile)
} else {
// Find home directory.
home, err := os.UserHomeDir()
cobra.CheckErr(err)

// Search config in home directory with name ".cobra" (without extension).
viper.AddConfigPath(home)
viper.SetConfigType("yaml")
viper.SetConfigName(".cobra")
v.AddConfigPath(home)
v.SetConfigType("yaml")
v.SetConfigName(".cobra")
}

viper.AutomaticEnv()
v.AutomaticEnv()

if err := viper.ReadInConfig(); err == nil {
fmt.Println("Using config file:", viper.ConfigFileUsed())
if err := v.ReadInConfig(); err == nil {
fmt.Println("Using config file:", v.ConfigFileUsed())
}
}
```
Expand Down Expand Up @@ -300,14 +301,16 @@ You can also bind your flags with [viper](https://github.com/spf13/viper):

```go
var author string
var v *viper.Viper

func init() {
v = viper.New()
rootCmd.PersistentFlags().StringVar(&author, "author", "YOUR NAME", "Author name for copyright attribution")
viper.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
v.BindPFlag("author", rootCmd.PersistentFlags().Lookup("author"))
}
```

In this example, the persistent flag `author` is bound with `viper`.
In this example, the persistent flag `author` is bound with the viper instance `v`.
**Note**: the variable `author` will not be set to the value from config,
when the `--author` flag is provided by user.

Expand Down