Add getters for flagCompletionFunctions map to support interactive flag completion suggestions in cobra-prompt

[avirtopeanu-ionos]

The flagCompletionFunctions map (https://github.com/spf13/cobra/blame/main/completions.go#L36) is used to store flag completion functions for a given command

I am working on extending the cobra-prompt library (https://github.com/stromland/cobra-prompt/) to add support for interactive flag completion suggestions. To achieve this, I need to access the flagCompletionFunctions map and retrieve the flag completion functions for a given command.

[avirtopeanu-ionos]

I made a PR #1943 PTAL at the proposal and tell me if you're okay with it

[marckhouzam]

Thanks @avirtopeanu-ionos. Could you give an example of where you would need to access the existing registered flag completions?

I believe you should already be able to add new flag completions to another program. And I guess if you want to know if your flag completion already exists, you could try to register a new one and check for an error being returned?

[avirtopeanu-ionos]

I believe you should already be able to add new flag completions to another program. And I guess if you want to know if your flag completion already exists, you could try to register a new one and check for an error being returned?

I may be misunderstanding something here. I don't want to add suggestions to the cobra command itself, I want to add the existing cobra suggestions from flagCompletionFunctions to the embedded go-prompt Document object, which the cobra-prompt library is building here https://github.com/stromland/cobra-prompt/blob/main/cobra-prompt.go#L131

Could you give an example of where you would need to access the existing registered flag completions?

If PR #1943 were to be merged, then this would add flag value completions to a go-prompt document object:

flagName := d.GetWordBeforeCursorWithSpace()
if compFunc, exists := command.GetFlagCompletionByName(flagName); exists { // Here I call the func in PR #1943 
	completions, _ := compFunc(command, args, flagName)

	for _, completion := range completions {
		suggestions = append(suggestions, prompt.Suggest{Text: completion}) // Here is where I'm building the go-prompt suggestions
	}
}

Here is my fork of cobra-prompt which uses PR #1943 for the getters https://github.com/avirtopeanu-ionos/cobra-prompt/tree/feat/add-flag-completions

[avirtopeanu-ionos]

@marckhouzam I have edited my previous messages to hopefully provide more clarity to the described use case. By adding getters for the flagCompletionFunctions map, we can easily extend cobra and integrate it with completion/QOL packages like cobra-prompt.

I hope this clears up any confusion. If you have any questions or concerns about this issue or PR #1943 please let me know

[avirtopeanu-ionos]

Any update on this? We were considering making a fork of cobra if this PR #1943 shouldn't be merged

[avirtopeanu-ionos]

#1943 was merged. Thank you!