mirror of
https://github.com/spf13/cobra
synced 2024-11-17 19:27:09 +00:00
145 lines
3.9 KiB
Go
145 lines
3.9 KiB
Go
package tpl
|
|
|
|
func MainTemplate() []byte {
|
|
return []byte(`/*
|
|
{{ .Copyright }}
|
|
{{ if .Legal.Header }}{{ .Legal.Header }}{{ end }}
|
|
*/
|
|
package main
|
|
|
|
import "{{ .PkgName }}/cmd"
|
|
|
|
func main() {
|
|
cmd.Execute()
|
|
}
|
|
`)
|
|
}
|
|
|
|
func RootTemplate() []byte {
|
|
return []byte(`/*
|
|
{{ .Copyright }}
|
|
{{ if .Legal.Header }}{{ .Legal.Header }}{{ end }}
|
|
*/
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"github.com/spf13/cobra"
|
|
{{ if .Viper }}
|
|
homedir "github.com/mitchellh/go-homedir"
|
|
"github.com/spf13/viper"{{ end }}
|
|
)
|
|
|
|
{{ if .Viper -}}
|
|
var cfgFile string
|
|
{{- end }}
|
|
|
|
// rootCmd represents the base command when called without any subcommands
|
|
var rootCmd = &cobra.Command{
|
|
Use: "{{ .AppName }}",
|
|
Short: "A brief description of your application",
|
|
Long: ` + "`" + `A longer description that spans multiple lines and likely contains
|
|
examples and usage of using your application. For example:
|
|
|
|
Cobra is a CLI library for Go that empowers applications.
|
|
This application is a tool to generate the needed files
|
|
to quickly create a Cobra application.` + "`" + `,
|
|
// Uncomment the following line if your bare application
|
|
// has an action associated with it:
|
|
// Run: func(cmd *cobra.Command, args []string) { },
|
|
}
|
|
|
|
// Execute adds all child commands to the root command and sets flags appropriately.
|
|
// This is called by main.main(). It only needs to happen once to the rootCmd.
|
|
func Execute() {
|
|
cobra.CheckErr(rootCmd.Execute())
|
|
}
|
|
|
|
func init() {
|
|
{{- if .Viper }}
|
|
cobra.OnInitialize(initConfig)
|
|
{{ end }}
|
|
// Here you will define your flags and configuration settings.
|
|
// Cobra supports persistent flags, which, if defined here,
|
|
// will be global for your application.
|
|
{{ if .Viper }}
|
|
rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.{{ .AppName }}.yaml)")
|
|
{{ else }}
|
|
// rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is $HOME/.{{ .AppName }}.yaml)")
|
|
{{ end }}
|
|
// Cobra also supports local flags, which will only run
|
|
// when this action is called directly.
|
|
rootCmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
|
|
}
|
|
|
|
{{ if .Viper -}}
|
|
// initConfig reads in config file and ENV variables if set.
|
|
func initConfig() {
|
|
if cfgFile != "" {
|
|
// Use config file from the flag.
|
|
viper.SetConfigFile(cfgFile)
|
|
} else {
|
|
// Find home directory.
|
|
home, err := homedir.Dir()
|
|
cobra.CheckErr(err)
|
|
|
|
// Search config in home directory with name ".{{ .AppName }}" (without extension).
|
|
viper.AddConfigPath(home)
|
|
viper.SetConfigName(".{{ .AppName }}")
|
|
}
|
|
|
|
viper.AutomaticEnv() // read in environment variables that match
|
|
|
|
// If a config file is found, read it in.
|
|
if err := viper.ReadInConfig(); err == nil {
|
|
fmt.Fprintln(os.Stderr, "Using config file:", viper.ConfigFileUsed())
|
|
}
|
|
}
|
|
{{- end }}
|
|
`)
|
|
}
|
|
|
|
func AddCommandTemplate() []byte {
|
|
return []byte(`/*
|
|
{{ .Project.Copyright }}
|
|
{{ if .Legal.Header }}{{ .Legal.Header }}{{ end }}
|
|
*/
|
|
package cmd
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
// {{ .CmdName }}Cmd represents the {{ .CmdName }} command
|
|
var {{ .CmdName }}Cmd = &cobra.Command{
|
|
Use: "{{ .CmdName }}",
|
|
Short: "A brief description of your command",
|
|
Long: ` + "`" + `A longer description that spans multiple lines and likely contains examples
|
|
and usage of using your command. For example:
|
|
|
|
Cobra is a CLI library for Go that empowers applications.
|
|
This application is a tool to generate the needed files
|
|
to quickly create a Cobra application.` + "`" + `,
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
fmt.Println("{{ .CmdName }} called")
|
|
},
|
|
}
|
|
|
|
func init() {
|
|
{{ .CmdParent }}.AddCommand({{ .CmdName }}Cmd)
|
|
|
|
// Here you will define your flags and configuration settings.
|
|
|
|
// Cobra supports Persistent Flags which will work for this command
|
|
// and all subcommands, e.g.:
|
|
// {{ .CmdName }}Cmd.PersistentFlags().String("foo", "", "A help for foo")
|
|
|
|
// Cobra supports local flags which will only run when this command
|
|
// is called directly, e.g.:
|
|
// {{ .CmdName }}Cmd.Flags().BoolP("toggle", "t", false, "Help message for toggle")
|
|
}
|
|
`)
|
|
}
|