wip

completions.go

@@ -217,7 +217,9 @@ func (c *Command) initCompleteCmd(args []string) {
 				// 2- Even without completions, we need to print the directive
 			}
 
-			noDescriptions := (cmd.CalledAs() == ShellCompNoDescRequestCmd)
+			noDescriptions := cmd.CalledAs() == ShellCompNoDescRequestCmd || GetEnvConfig(cmd, configEnvVarSuffixDescriptions) == configEnvVarDescriptionsOff
+			noActiveHelp := GetActiveHelpConfig(finalCmd) == activeHelpGlobalDisable
+			out := finalCmd.OutOrStdout()
 			for _, comp := range completions {
 				if GetActiveHelpConfig(finalCmd) == activeHelpGlobalDisable {
 					// Remove all activeHelp entries in this case
@@ -825,7 +827,6 @@ to your powershell profile.
 				return cmd.Root().GenPowerShellCompletion(out)
 			}
 			return cmd.Root().GenPowerShellCompletionWithDesc(out)
-
 		},
 	}
 	if haveNoDescFlag {
@@ -897,8 +898,12 @@ func CompErrorln(msg string) {
 	CompError(fmt.Sprintf("%s\n", msg))
 }
 
-// configEnvVarGlobalPrefix should not be changed: users will be using it explicitly.
-const configEnvVarGlobalPrefix = "COBRA"
+// These values should not be changed: users will be using them explicitly.
+const (
+	configEnvVarGlobalPrefix       = "COBRA"
+	configEnvVarSuffixDescriptions = "COMPLETION_DESCRIPTIONS"
+	configEnvVarDescriptionsOff    = "off"
+)
 
 var configEnvVarPrefixSubstRegexp = regexp.MustCompile(`[^A-Z0-9_]`)
 

site/content/completions/_index.md

@@ -104,7 +104,7 @@ To tell Cobra to mark the default `completion` command as *hidden*:
 rootCmd.CompletionOptions.HiddenDefaultCmd = true
 ```
 
-To tell Cobra *not* to provide the user with the `--no-descriptions` flag to the completion sub-commands:
+To tell Cobra *not* to provide the user with the `--no-descriptions` flag or the same functionality using `*_COMPLETION_DESCRIPTIONS` environment variables to the completion sub-commands:
 ```
 rootCmd.CompletionOptions.DisableNoDescFlag = true
 ```
@@ -393,6 +393,9 @@ $ source <(helm completion bash --no-descriptions)
 $ helm completion [tab][tab]
 bash        fish        powershell  zsh
 ```
+
+Setting the `<PROGRAM>_COMPLETION_DESCRIPTIONS` environment variable (falling back to `COBRA_COMPLETION_DESCRIPTIONS` if empty or not set) to `off` achieves the same. `<PROGRAM>` is the name of your program with all non-ASCII-alphanumeric characters replaced by `_`.
+
 ## Bash completions
 
 ### Dependencies