Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

feat(influx): improve long flags for config commands 

this deprecates the old flags, but they are still accessible if using them
explictly. They are hidden from the -h message. When used the CLI prints out
a message indicating the flag is deprecated and to use the new flag instead.
pull/18714/head
Johnny Steenbergen 2020-06-24 11:58:21 -07:00 committed by Johnny Steenbergen
parent 6694c7e393
commit 6bac4373ca
1 changed files with 23 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
cmd/influx/config.go
View File

@ -127,15 +127,7 @@ func (b *cmdConfigBuilder) cmdCreate() *cobra.Command {
https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/create`
b.registerPrintFlags(cmd)
cmd.Flags().StringVarP(&b.name, "name", "n", "", "The config name (required)")
cmd.MarkFlagRequired("name")
cmd.Flags().StringVarP(&b.token, "token", "t", "", "The config token (required)")
cmd.MarkFlagRequired("token")
cmd.Flags().StringVarP(&b.url, "url", "u", "", "The config url (required)")
cmd.MarkFlagRequired("url")
cmd.Flags().BoolVarP(&b.active, "active", "a", false, "Set it to be the active config")
cmd.Flags().StringVarP(&b.org, "org", "o", "", "The optional organization name")
b.registerConfigSettingFlags(cmd)
return cmd
}
@ -228,13 +220,7 @@ func (b *cmdConfigBuilder) cmdUpdate() *cobra.Command {
https://v2.docs.influxdata.com/v2.0/reference/cli/influx/config/set`
b.registerPrintFlags(cmd)
cmd.Flags().StringVarP(&b.name, "name", "n", "", "The config name (required)")
cmd.MarkFlagRequired("name")
cmd.Flags().StringVarP(&b.token, "token", "t", "", "The config token (required)")
cmd.Flags().StringVarP(&b.url, "url", "u", "", "The config url (required)")
cmd.Flags().BoolVarP(&b.active, "active", "a", false, "Set it to be the active config")
cmd.Flags().StringVarP(&b.org, "org", "o", "", "The optional organization name")
b.registerConfigSettingFlags(cmd)
return cmd
}
@ -289,6 +275,27 @@ func (b *cmdConfigBuilder) cmdListRunEFn(*cobra.Command, []string) error {
return b.printConfigs(configPrintOpts{configs: cfgs})
}
func (b *cmdConfigBuilder) registerConfigSettingFlags(cmd *cobra.Command) {
cmd.Flags().BoolVarP(&b.active, "active", "a", false, "Set as active config")
cmd.Flags().StringVarP(&b.org, "org", "o", "", "The optional organization name")
cmd.Flags().StringVarP(&b.name, "config-name", "n", "", "The config name (required)")
cmd.MarkFlagRequired("config-name")
cmd.Flags().StringVarP(&b.token, "token", "t", "", "The token for host (required)")
cmd.MarkFlagRequired("token")
cmd.Flags().StringVarP(&b.url, "host-url", "u", "", "The host url (required)")
cmd.MarkFlagRequired("host-url")
// deprecated moving forward, not explicit enough based on feedback
// the short flags will still be respected but their long form is different.
cmd.Flags().StringVar(&b.name, "name", "", "The config name (required)")
cmd.Flags().MarkDeprecated("name", "use the --config-name flag")
cmd.Flags().StringVar(&b.url, "url", "", "The host url (required)")
cmd.Flags().MarkDeprecated("url", "use the --host-url flag")
}
func (b *cmdConfigBuilder) registerPrintFlags(cmd *cobra.Command) {
registerPrintOptions(cmd, &b.hideHeaders, &b.json)
}