Add env variable to suppress completion descriptions on create #1938

scop · 2023-03-27T20:50:49Z

Closes #1937

marckhouzam · 2023-03-28T02:35:59Z

Thanks @scop !
This approach will only work for programs that use the default completion command. Also it would require regenerating the completion script to toggle the descriptions.

Instead we could have the go code itself check the new variable and not return descriptions with the list of completions.

This is what we do for activehelp and probably what I should have done for descriptions from the start.

This go logic would be here:

cobra/completions.go

Line 200 in 4dd4b25

noDescriptions := (cmd.CalledAs() == ShellCompNoDescRequestCmd)

Luap99 · 2023-03-28T10:35:03Z

I agree we should follow what active helps does , this includes support for two env vars, i.e. COBRA_COMPLETION_NO_DESCRIPTIONS and <PROGRAM>_COMPLETION_NO_DESCRIPTIONS, this allows users to still configure it on a per application basis without having to regenerate the completion script.

marckhouzam · 2023-03-28T11:18:45Z

Thanks for the input @Luap99 👍

COBRA_COMPLETION_NO_DESCRIPTIONS and _COMPLETION_NO_DESCRIPTIONS

Let's "go" 😆 with this flexible and"standard" approach if @scop is willing.

scop · 2023-03-28T18:20:40Z

Makes sense. I suggest we take a look at #1940 before reworking this though -- if/after that's in, the env var prefix handling could be generalized and shared between active help and this feature.

scop · 2023-10-24T21:10:14Z

I suppose this is starting to take shape, however it requires #1940, so keeping as a draft until that's in.

This will also cause conflicts with #1957, so either this or that will eventually need rebasing. This one's still blocked and #1957 is not, so perhaps that one could be applied first? Then again, I would not want to delay this one any more.

github-actions · 2023-10-29T20:02:55Z

This PR exceeds the recommended size of 200 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

Similar to the existing one for active help, but generalized.

scop · 2023-11-26T14:50:58Z

Resolved conflicts, rebased.

marckhouzam

Thanks for your patience @scop

completions.go

completions_test.go

github-actions · 2023-12-11T20:19:33Z

This PR exceeds the recommended size of 200 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size.

scop · 2023-12-11T20:21:50Z

Thanks for the review, @marckhouzam, feedback addressed.

This PR contains the following updates: Package Change Age Adoption Passing Confidence github.com/spf13/cobra v1.8.0 -> v1.8.1 WarningSome dependencies could not be looked up. Check the warning logs for more information. Release Notes spf13/cobra (github.com/spf13/cobra) v1.8.1 Compare Source ✨ Features Add env variable to suppress completion descriptions on create by @scop in spf13/cobra#1938 🐛 Bug fixes Micro-optimizations by @scop in spf13/cobra#1957 🔧 Maintenance build(deps): bump github.com/cpuguy83/go-md2man/v2 from 2.0.3 to 2.0.4 by @dependabot in spf13/cobra#2127 Consistent annotation names by @nirs in spf13/cobra#2140 Remove fully inactivated linters by @nirs in spf13/cobra#2148 Address golangci-lint deprecation warnings, enable some more linters by @scop in spf13/cobra#2152 🧪 Testing & CI/CD Add test for func in cobra.go by @korovindenis in spf13/cobra#2094 ci: test golang 1.22 by @cyrilico in spf13/cobra#2113 Optimized and added more linting by @scop in spf13/cobra#2099 build(deps): bump actions/setup-go from 4 to 5 by @dependabot in spf13/cobra#2087 build(deps): bump actions/labeler from 4 to 5 by @dependabot in spf13/cobra#2086 build(deps): bump golangci/golangci-lint-action from 3.7.0 to 4.0.0 by @dependabot in spf13/cobra#2108 build(deps): bump actions/cache from 3 to 4 by @dependabot in spf13/cobra#2102 ✏️ Documentation Fixes and docs for usage as plugin by @nirs in spf13/cobra#2070 flags: clarify documentation that LocalFlags related function do not modify the state by @niamster in spf13/cobra#2064 chore: remove repetitive words by @racerole in spf13/cobra#2122 Add LXC to the list of projects using Cobra @VaradBelwalkar in spf13/cobra#2071 Update projects_using_cobra.md by @marcuskohlberg in spf13/cobra#2089 [chore]: update projects using cobra by @cmwylie19 in spf13/cobra#2093 Add Taikun CLI to list of projects by @Smidra in spf13/cobra#2098 Add Incus to the list of projects using Cobra by @montag451 in spf13/cobra#2118 New Contributors @VaradBelwalkar made their first contribution in spf13/cobra#2071 @marcuskohlberg made their first contribution in spf13/cobra#2089 @cmwylie19 made their first contribution in spf13/cobra#2093 @korovindenis made their first contribution in spf13/cobra#2094 @niamster made their first contribution in spf13/cobra#2064 @Smidra made their first contribution in spf13/cobra#2098 @montag451 made their first contribution in spf13/cobra#2118 @cyrilico made their first contribution in spf13/cobra#2113 @racerole made their first contribution in spf13/cobra#2122 @pedromotita made their first contribution in spf13/cobra#2120 @cubxxw made their first contribution in spf13/cobra#2128 Thank you everyone who contributed to this release and all your hard work! Cobra and this community would never be possible without all of you!!!! 🐍 Full Changelog: spf13/[email protected] Configuration 📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied. ♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 Ignore: Close this PR and you won't be reminded about this update again. If you want to rebase/retry this PR, check this box This PR was generated by Mend Renovate. View the repository job log.

scop mentioned this pull request Mar 27, 2023

RFE: env var for disabling descriptions #1937

Closed

scop marked this pull request as draft March 28, 2023 18:20

scop mentioned this pull request Jun 19, 2023

Replace all non-alphanumerics in active help env var program prefix #1940

Merged

scop force-pushed the feat/disable-descriptions-envvar branch 3 times, most recently from 4474cf6 to 2c46d19 Compare October 24, 2023 21:06

scop force-pushed the feat/disable-descriptions-envvar branch from 2c46d19 to 5c206d1 Compare October 29, 2023 20:02

scop marked this pull request as ready for review October 29, 2023 20:02

scop added 2 commits November 26, 2023 16:49

Add general purpose config env var getter

957f4eb

Similar to the existing one for active help, but generalized.

Make use of the general purpose config env var getter in active help

97b7001

scop force-pushed the feat/disable-descriptions-envvar branch from 5c206d1 to 97b7001 Compare November 26, 2023 14:50

marckhouzam reviewed Dec 9, 2023

View reviewed changes

completions.go Outdated Show resolved Hide resolved

completions.go Outdated Show resolved Hide resolved

completions.go Show resolved Hide resolved

completions.go Outdated Show resolved Hide resolved

marckhouzam reviewed Dec 9, 2023

View reviewed changes

completions_test.go Outdated Show resolved Hide resolved

marckhouzam reviewed Dec 9, 2023

View reviewed changes

completions_test.go Outdated Show resolved Hide resolved

scop added 3 commits December 11, 2023 17:37

Make getEnvConfig private

7aa559d

Use strconv.ParseBool to parse descriptions state from env

138b0ab

Defer unsetting test env vars properly

c96f1a6

scop force-pushed the feat/disable-descriptions-envvar branch from 00019d5 to c96f1a6 Compare December 11, 2023 16:11

scop added 2 commits December 11, 2023 22:18

Distinguish env var getter test cases better

9740ece

Add description disabling test cases

1107319

scop force-pushed the feat/disable-descriptions-envvar branch from 977823c to 1107319 Compare December 11, 2023 20:19

cupsadarius mentioned this pull request Jun 17, 2024

Bump the gomod group with 3 updates ventive/go-mono-template#10

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add env variable to suppress completion descriptions on create #1938

Add env variable to suppress completion descriptions on create #1938

scop commented Mar 27, 2023

marckhouzam commented Mar 28, 2023

Luap99 commented Mar 28, 2023

marckhouzam commented Mar 28, 2023

scop commented Mar 28, 2023

scop commented Oct 24, 2023

github-actions bot commented Oct 29, 2023

scop commented Nov 26, 2023

marckhouzam left a comment

github-actions bot commented Dec 11, 2023

scop commented Dec 11, 2023

Add env variable to suppress completion descriptions on create #1938

Add env variable to suppress completion descriptions on create #1938

Conversation

scop commented Mar 27, 2023

marckhouzam commented Mar 28, 2023

Luap99 commented Mar 28, 2023

marckhouzam commented Mar 28, 2023

scop commented Mar 28, 2023

scop commented Oct 24, 2023

github-actions bot commented Oct 29, 2023

scop commented Nov 26, 2023

marckhouzam left a comment

Choose a reason for hiding this comment

github-actions bot commented Dec 11, 2023

scop commented Dec 11, 2023