Feat/file flag completion improvements #4028
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Ville Skyttä <[email protected]>
Be more consistent across with extensions accepted/filtered, add some. Also, mark and comment out cases where there are no known typical filename extensions for flags taking filename arguments, to make it obvious that they have not been inadvertently omitted. Marking a flag as filename without specifying extensions is a no-op, and actually considered a bug per commentary in cobra sources: https://github.com/spf13/cobra/blob/41b26ec8bb59dfba580f722201bf371c4f5703dd/completions.go#L387-L390 Closes sigstore/community#538 Signed-off-by: Ville Skyttä <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #4028 +/- ##
==========================================
- Coverage 40.10% 36.42% -3.68%
==========================================
Files 155 209 +54
Lines 10044 13377 +3333
==========================================
+ Hits 4028 4873 +845
- Misses 5530 7883 +2353
- Partials 486 621 +135 ☔ View full report in Codecov by Sentry. |
haydentherapper
approved these changes
Feb 3, 2025
| @@ -107,5 +108,5 @@ func (o *AttestBlobOptions) AddFlags(cmd *cobra.Command) { | |||
|
|
|||
| cmd.Flags().StringVar(&o.RFC3161TimestampPath, "rfc3161-timestamp-bundle", "", | |||
| "path to an RFC 3161 timestamp bundle FILE") | |||
| _ = cmd.Flags().SetAnnotation("rfc3161-timestamp-bundle", cobra.BashCompFilenameExt, []string{}) | |||
| // _ = cmd.MarkFlagFilename("rfc3161-timestamp-bundle") // no typical extensions | |||
There was a problem hiding this comment.
To confirm, is there any purpose to including this? As in, will shell completion still work with rfc3161-... for example?
| @@ -80,7 +80,7 @@ func (o *AttachSBOMOptions) AddFlags(cmd *cobra.Command) { | |||
|
|
|||
| cmd.Flags().StringVar(&o.SBOM, "sbom", "", | |||
| "path to the sbom, or {-} for stdin") | |||
| _ = cmd.Flags().SetAnnotation("sbom", cobra.BashCompFilenameExt, []string{}) | |||
| cmd.MarkFlagFilename("sbom", sbomExts...) | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
As described in sigstore/community#538
To test, generate and install shell completions and invoke completion for flags taking filenames as arguments, observe results.
Release Note
NONE
Documentation
NONE