Framework flag shell completion #80
Conversation
…e all instances that are passed are a valid state
| rootCmd.AddCommand(createCmd) | ||
|
|
||
| createCmd.Flags().StringP("name", "n", "", "Name of project to create") | ||
| createCmd.Flags().StringP("framework", "f", "", fmt.Sprintf("Framework to use. Allowed values: %s", strings.Join(allowedProjectTypes, ", "))) | ||
| createCmd.Flags().VarP(&frameworkFlag, "framework", "f", fmt.Sprintf("Framework to use. Allowed values: %s", strings.Join(frameworks.AllowedProjectTypes, ", "))) |
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
cmd/create.go
Outdated
| @@ -62,16 +68,16 @@ var createCmd = &cobra.Command{ | |||
| flagFramework := cmd.Flag("framework").Value.String() | |||
|
|
|||
| if flagFramework != "" { | |||
| isValid := isValidProjectType(flagFramework, allowedProjectTypes) | |||
| isValid := isValidProjectType(flagFramework, frameworks.AllowedProjectTypes) | |||
There was a problem hiding this comment.
This can be removed I believe, a Var flag will automatically error if it's not in the enum!
| @@ -38,7 +38,7 @@ func InitSteps(options *Options) *Steps { | |||
| StepName: "Go Project Framework", | |||
| Options: []Item{ | |||
| { | |||
| Title: "Standard library", | |||
| Title: "Standard-library", | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
Yes, you need to register the flag for the completion generation with a function that gets called for the option but that's a simple one line function. cc @basokant |
This is awesome! I thought you would have to add the shell completion script that's generated from 'go-blueprint completion', but this is way better! |
MitchellBerend
changed the title
There was a problem hiding this comment.
i think this could be out of scope for Go-blueprint because modifying dot files seems to be a little much for this CLI tool.
Personally, I wouldnt want something I installed just for spinning up Go boiler plate to touch my dot files.
I think certain users can have a poor experience with that.
Resolves #61
This pr adds shell completion for the --framework flag. This feature should
help users with discovering framework options, prevent typos and last but not
leas, typing less.
Besides the tab completion it also replaces the
stringtypes for theFrameworkTypewith a type aliasFramework. TheVarPfunction registersa flag that always returns a valid string which then gets turned into a specific
type to make it type safe.
cc @basokant