cmd/action: make env command public (#613)

* cmd/action: extract env cmd * move init() func * remove var * global var and fix tests * gen
ariga · Mar 2, 2022 · 2860b39 · 2860b39
1 parent 9a09b9e
commit 2860b39
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 21 deletions.
diff --git a/cmd/action/env.go b/cmd/action/env.go
@@ -13,29 +13,28 @@ import (
 	"github.com/spf13/cobra"
 )
 
-func newEnvCmd() *cobra.Command {
-	return &cobra.Command{
-		Use:   "env",
-		Short: "Print atlas environment variables.",
-		Long: "`atlas env`" + `prints atlas environment information.
+// EnvCmd is the "atlas env" command.
+var EnvCmd = &cobra.Command{
+	Use:   "env",
+	Short: "Print atlas environment variables.",
+	Long: `'atlas env' prints atlas environment information.
 
 Every set environment param will be printed in the form of NAME=VALUE.
 
 List of supported environment parameters:
-* *ATLAS_NO_UPDATE_NOTIFIER*: On any command, the CLI will check for new releases using the GitHub API.
+* ATLAS_NO_UPDATE_NOTIFIER: On any command, the CLI will check for new releases using the GitHub API.
   This check will happen at most once every 24 hours. To cancel this behavior, set the environment 
   variable "ATLAS_NO_UPDATE_NOTIFIER".`,
-		Run: func(cmd *cobra.Command, args []string) {
-			keys := []string{update.AtlasNoUpdateNotifier}
-			for _, k := range keys {
-				if v, ok := os.LookupEnv(k); ok {
-					cmd.Println(fmt.Sprintf("%s=%s", k, v))
-				}
+	Run: func(cmd *cobra.Command, args []string) {
+		keys := []string{update.AtlasNoUpdateNotifier}
+		for _, k := range keys {
+			if v, ok := os.LookupEnv(k); ok {
+				cmd.Println(fmt.Sprintf("%s=%s", k, v))
 			}
-		},
-	}
+		}
+	},
 }
 
 func init() {
-	RootCmd.AddCommand(newEnvCmd())
+	RootCmd.AddCommand(EnvCmd)
 }
diff --git a/cmd/action/env_test.go b/cmd/action/env_test.go
@@ -10,17 +10,15 @@ import (
 )
 
 func TestEnv(t *testing.T) {
-	cmd := newEnvCmd()
-	out, err := runCmd(cmd)
+	out, err := runCmd(RootCmd, "env")
 	require.NoError(t, err)
 	require.Empty(t, out)
 }
 
 func TestEnv_Set(t *testing.T) {
-	cmd := newEnvCmd()
 	err := os.Setenv(update.AtlasNoUpdateNotifier, "test")
 	require.NoError(t, err)
-	out, err := runCmd(cmd)
+	out, err := runCmd(RootCmd, "env")
 	require.NoError(t, err)
 	require.Equal(t, "ATLAS_NO_UPDATE_NOTIFIER=test\n", out)
 }
diff --git a/doc/md/cli/reference.md b/doc/md/cli/reference.md
@@ -36,12 +36,12 @@ atlas env
 ```
 
 #### Details
-`atlas env`prints atlas environment information.
+'atlas env' prints atlas environment information.
 
 Every set environment param will be printed in the form of NAME=VALUE.
 
 List of supported environment parameters:
-* *ATLAS_NO_UPDATE_NOTIFIER*: On any command, the CLI will check for new releases using the GitHub API.
+* ATLAS_NO_UPDATE_NOTIFIER: On any command, the CLI will check for new releases using the GitHub API.
   This check will happen at most once every 24 hours. To cancel this behavior, set the environment 
   variable "ATLAS_NO_UPDATE_NOTIFIER".