refactor: remove cloud flag prefix

Author: snakster

CHANGELOG.md

@@ -26,6 +26,10 @@ Given a version number `MAJOR.MINOR.PATCH`, we increment the:
 
 - Add experimental support for `tmgen` file extension for easy code generation/templating
   of existing infrastructure. You can enable it with `terramate.config.experimental = ["tmgen"]`.
+- Make cloud-related options more concise by dropping the `cloud` prefix.
+  - Option flags `--cloud-*` are shortened to `--*`, e.g. `--cloud-status=ok` => `--status=ok`.
+  - Script command options `cloud_*` are shorted to `*`, e.g. `cloud_sync_deployment` => `sync_deployment`.
+  - Old flags and command options are still supported as aliases for the new ones.
 
 ## v0.6.0
 

cloud/preview/preview.go

@@ -49,7 +49,7 @@ func (l Layer) String() string {
 func (l Layer) Validate() error {
 	for _, c := range string(l) {
 		if !unicode.IsLetter(c) && !unicode.IsDigit(c) && c != '-' {
-			return errors.E("invalid --cloud-sync-layer, only alphanumeric characters and hyphens are allowed")
+			return errors.E("invalid --layer, only alphanumeric characters and hyphens are allowed")
 		}
 	}
 

cmd/terramate/cli/cli.go

@@ -142,17 +142,24 @@ type cliSpec struct {
 	List struct {
 		Why                bool   `help:"Shows the reason why the stack has changed."`
 		ExperimentalStatus string `hidden:"" help:"Filter by status (Deprecated)"`
-		CloudStatus        string `help:"Filter by Terramate Cloud status of the stack."`
+		CloudStatus        string `hidden:""`
+		Status             string `help:"Filter by Terramate Cloud status of the stack."`
 		RunOrder           bool   `default:"false" help:"Sort listed stacks by order of execution"`
 	} `cmd:"" help:"List stacks."`
 
 	Run struct {
-		CloudStatus                string        `help:"Filter by Terramate Cloud status of the stack."`
-		CloudSyncDeployment        bool          `default:"false" help:"Synchronize the command as a new deployment to Terramate Cloud."`
-		CloudSyncDriftStatus       bool          `default:"false" help:"Synchronize the command as a new drift run to Terramate Cloud."`
-		CloudSyncPreview           bool          `default:"false" help:"Synchronize the command as a new preview to Terramate Cloud."`
-		CloudSyncLayer             preview.Layer `default:"" help:"Set a customer layer for synchronizing a preview to Terramate Cloud."`
-		CloudSyncTerraformPlanFile string        `default:"" help:"Add details of the Terraform Plan file to the synchronization to Terramate Cloud."`
+		CloudStatus                string        `hidden:""`
+		Status                     string        `help:"Filter by Terramate Cloud status of the stack."`
+		CloudSyncDeployment        bool          `hidden:""`
+		SyncDeployment             bool          `default:"false" help:"Synchronize the command as a new deployment to Terramate Cloud."`
+		CloudSyncDriftStatus       bool          `hidden:""`
+		SyncDriftStatus            bool          `default:"false" help:"Synchronize the command as a new drift run to Terramate Cloud."`
+		CloudSyncPreview           bool          `hidden:""`
+		SyncPreview                bool          `default:"false" help:"Synchronize the command as a new preview to Terramate Cloud."`
+		CloudSyncLayer             preview.Layer `hidden:""`
+		Layer                      preview.Layer `default:"" help:"Set a customer layer for synchronizing a preview to Terramate Cloud."`
+		CloudSyncTerraformPlanFile string        `hidden:""`
+		TerraformPlanFile          string        `default:"" help:"Add details of the Terraform Plan file to the synchronization to Terramate Cloud."`
 		DebugPreviewURL            string        `hidden:"true" default:"" help:"Create a debug preview URL to Terramate Cloud details."`
 		ContinueOnError            bool          `default:"false" help:"Do not stop execution when an error occurs."`
 		NoRecursive                bool          `default:"false" help:"Do not recurse into nested child stacks."`
@@ -182,7 +189,8 @@ type cliSpec struct {
 			Cmds []string `arg:"" optional:"true" passthrough:"" help:"Script to show info for."`
 		} `cmd:"" help:"Show detailed information about a script"`
 		Run struct {
-			CloudStatus     string `help:"Filter by Terramate Cloud status of the stack."`
+			CloudStatus     string `hidden:""`
+			Status          string `help:"Filter by Terramate Cloud status of the stack."`
 			NoRecursive     bool   `default:"false" help:"Do not recurse into nested child stacks."`
 			ContinueOnError bool   `default:"false" help:"Continue executing next stacks when a command returns an error."`
 			DryRun          bool   `default:"false" help:"Plan the execution but do not execute it."`
@@ -227,7 +235,8 @@ type cliSpec struct {
 			Stack              string `arg:"" optional:"true" name:"stack" predictor:"file" help:"The stacks path."`
 			Reason             string `default:"" name:"reason" help:"Set a reason for triggering the stack."`
 			ExperimentalStatus string `hidden:"" help:"Filter by Terramate Cloud status of the stack. (deprecated)"`
-			CloudStatus        string `help:"Filter by Terramate Cloud status of the stack."`
+			CloudStatus        string `hidden:""`
+			Status             string `help:"Filter by Terramate Cloud status of the stack."`
 		} `cmd:"" help:"Mark a stack as changed so it will be triggered in Change Detection."`
 
 		RunGraph struct {
@@ -425,6 +434,8 @@ func newCLI(version string, args []string, stdin io.Reader, stdout, stderr io.Wr
 		fatal("failed to load cli configuration file", err)
 	}
 
+	migrateFlagAliases(&parsedArgs)
+
 	// cmdline flags override configuration file.
 
 	if parsedArgs.DisableCheckpoint {
@@ -877,11 +888,44 @@ func hasVendorDirConfig(cfg hcl.Config) bool {
 	return cfg.Vendor != nil && cfg.Vendor.Dir != ""
 }
 
+func migrateFlagAliases(parsedArgs *cliSpec) {
+	// list
+	migrateStringFlag(&parsedArgs.List.Status, parsedArgs.List.CloudStatus)
+
+	// run
+	migrateStringFlag(&parsedArgs.Run.Status, parsedArgs.Run.CloudStatus)
+	migrateBoolFlag(&parsedArgs.Run.SyncDeployment, parsedArgs.Run.CloudSyncDeployment)
+	migrateBoolFlag(&parsedArgs.Run.SyncDriftStatus, parsedArgs.Run.CloudSyncDriftStatus)
+	migrateBoolFlag(&parsedArgs.Run.SyncPreview, parsedArgs.Run.CloudSyncPreview)
+	migrateStringFlag(&parsedArgs.Run.TerraformPlanFile, parsedArgs.Run.CloudSyncTerraformPlanFile)
+	if parsedArgs.Run.CloudSyncLayer != "" && parsedArgs.Run.Layer == "" {
+		parsedArgs.Run.Layer = parsedArgs.Run.CloudSyncLayer
+	}
+
+	// script run
+	migrateStringFlag(&parsedArgs.Script.Run.Status, parsedArgs.Script.Run.CloudStatus)
+
+	// experimental trigger
+	migrateStringFlag(&parsedArgs.Experimental.Trigger.Status, parsedArgs.Experimental.Trigger.CloudStatus)
+}
+
+func migrateStringFlag(flag *string, alias string) {
+	if alias != "" && *flag == "" {
+		*flag = alias
+	}
+}
+
+func migrateBoolFlag(flag *bool, alias bool) {
+	if alias && !*flag {
+		*flag = alias
+	}
+}
+
 func (c *cli) triggerStackByFilter() {
 	expStatus := c.parsedArgs.Experimental.Trigger.ExperimentalStatus
-	cloudStatus := c.parsedArgs.Experimental.Trigger.CloudStatus
+	cloudStatus := c.parsedArgs.Experimental.Trigger.Status
 	if expStatus != "" && cloudStatus != "" {
-		fatal("--experimental-status and --cloud-status cannot be used together", nil)
+		fatal("--experimental-status and --status cannot be used together", nil)
 	}
 
 	statusStr := expStatus
@@ -890,7 +934,7 @@ func (c *cli) triggerStackByFilter() {
 	}
 
 	if statusStr == "" {
-		fatal("trigger command expects either a stack path or the --cloud-status flag", nil)
+		fatal("trigger command expects either a stack path or the --status flag", nil)
 	}
 
 	status := parseStatusFilter(statusStr)
@@ -1555,9 +1599,9 @@ func (c *cli) printStacks() {
 	}
 
 	expStatus := c.parsedArgs.List.ExperimentalStatus
-	cloudStatus := c.parsedArgs.List.CloudStatus
+	cloudStatus := c.parsedArgs.List.Status
 	if expStatus != "" && cloudStatus != "" {
-		fatal("Invalid args", errors.E("--experimental-status and --cloud-status cannot be used together"))
+		fatal("Invalid args", errors.E("--experimental-status and --status cannot be used together"))
 	}
 
 	statusStr := expStatus

cmd/terramate/cli/cloud.go

@@ -161,7 +161,7 @@ func isDriftTask(t stackRunTask) bool      { return t.CloudSyncDriftStatus }
 func isPreviewTask(t stackRunTask) bool    { return t.CloudSyncPreview }
 
 func (c *cli) checkCloudSync() {
-	if !c.parsedArgs.Run.CloudSyncDeployment && !c.parsedArgs.Run.CloudSyncDriftStatus && !c.parsedArgs.Run.CloudSyncPreview {
+	if !c.parsedArgs.Run.SyncDeployment && !c.parsedArgs.Run.SyncDriftStatus && !c.parsedArgs.Run.SyncPreview {
 		return
 	}
 
@@ -172,7 +172,7 @@ func (c *cli) checkCloudSync() {
 		return
 	}
 
-	if c.parsedArgs.Run.CloudSyncDeployment {
+	if c.parsedArgs.Run.SyncDeployment {
 		uuid, err := uuid.GenerateUUID()
 		c.handleCriticalError(err)
 		c.cloud.run.runUUID = cloud.UUID(uuid)

cmd/terramate/cli/run.go

@@ -41,7 +41,7 @@ const (
 	// in the system.
 	ErrRunCommandNotFound errors.Kind = "command not found"
 
-	cloudSyncPreviewGHAWarning = "--cloud-sync-preview is only supported in GitHub Actions workflows"
+	cloudSyncPreviewGHAWarning = "--sync-preview is only supported in GitHub Actions workflows"
 )
 
 // stackRun contains a list of tasks to be run per stack.
@@ -116,39 +116,39 @@ func (c *cli) runOnStacks() {
 		stacks = append(stacks, st.Sortable())
 	} else {
 		var err error
-		stacks, err = c.computeSelectedStacks(true, parseStatusFilter(c.parsedArgs.Run.CloudStatus))
+		stacks, err = c.computeSelectedStacks(true, parseStatusFilter(c.parsedArgs.Run.Status))
 		if err != nil {
 			fatal("computing selected stacks", err)
 		}
 	}
 
-	if c.parsedArgs.Run.CloudSyncDeployment && c.parsedArgs.Run.CloudSyncDriftStatus {
-		fatal(sprintf("--cloud-sync-deployment conflicts with --cloud-sync-drift-status"), nil)
+	if c.parsedArgs.Run.SyncDeployment && c.parsedArgs.Run.SyncDriftStatus {
+		fatal(sprintf("--sync-deployment conflicts with --sync-drift-status"), nil)
 	}
 
-	if c.parsedArgs.Run.CloudSyncPreview && (c.parsedArgs.Run.CloudSyncDeployment || c.parsedArgs.Run.CloudSyncDriftStatus) {
-		fatal("cannot use --cloud-sync-preview with --cloud-sync-deployment or --cloud-sync-drift-status", nil)
+	if c.parsedArgs.Run.SyncPreview && (c.parsedArgs.Run.SyncDeployment || c.parsedArgs.Run.SyncDriftStatus) {
+		fatal("cannot use --sync-preview with --sync-deployment or --sync-drift-status", nil)
 	}
 
-	if c.parsedArgs.Run.CloudSyncTerraformPlanFile == "" && c.parsedArgs.Run.CloudSyncPreview {
-		fatal("--cloud-sync-preview requires --cloud-sync-terraform-plan-file", nil)
+	if c.parsedArgs.Run.TerraformPlanFile == "" && c.parsedArgs.Run.SyncPreview {
+		fatal("--sync-preview requires --terraform-plan-file", nil)
 	}
 
-	cloudSyncEnabled := c.parsedArgs.Run.CloudSyncDeployment || c.parsedArgs.Run.CloudSyncDriftStatus || c.parsedArgs.Run.CloudSyncPreview
+	cloudSyncEnabled := c.parsedArgs.Run.SyncDeployment || c.parsedArgs.Run.SyncDriftStatus || c.parsedArgs.Run.SyncPreview
 
-	if c.parsedArgs.Run.CloudSyncTerraformPlanFile != "" && !cloudSyncEnabled {
-		fatal("--cloud-sync-terraform-plan-file requires flags --cloud-sync-deployment or --cloud-sync-drift-status or --cloud-sync-preview", nil)
+	if c.parsedArgs.Run.TerraformPlanFile != "" && !cloudSyncEnabled {
+		fatal("--terraform-plan-file requires flags --sync-deployment or --sync-drift-status or --sync-preview", nil)
 	}
 
-	if c.parsedArgs.Run.CloudSyncDeployment || c.parsedArgs.Run.CloudSyncDriftStatus || c.parsedArgs.Run.CloudSyncPreview {
+	if c.parsedArgs.Run.SyncDeployment || c.parsedArgs.Run.SyncDriftStatus || c.parsedArgs.Run.SyncPreview {
 		if !c.prj.isRepo {
 			fatal("cloud features requires a git repository", nil)
 		}
 		c.ensureAllStackHaveIDs(stacks)
 		c.detectCloudMetadata()
 	}
 
-	if c.parsedArgs.Run.CloudSyncPreview && os.Getenv("GITHUB_ACTIONS") == "" {
+	if c.parsedArgs.Run.SyncPreview && os.Getenv("GITHUB_ACTIONS") == "" {
 		printer.Stderr.Warn(cloudSyncPreviewGHAWarning)
 		c.disableCloudFeatures(errors.E(cloudSyncPreviewGHAWarning))
 	}
@@ -161,11 +161,11 @@ func (c *cli) runOnStacks() {
 			Tasks: []stackRunTask{
 				{
 					Cmd:                        c.parsedArgs.Run.Command,
-					CloudSyncDeployment:        c.parsedArgs.Run.CloudSyncDeployment,
-					CloudSyncDriftStatus:       c.parsedArgs.Run.CloudSyncDriftStatus,
-					CloudSyncPreview:           c.parsedArgs.Run.CloudSyncPreview,
-					CloudSyncTerraformPlanFile: c.parsedArgs.Run.CloudSyncTerraformPlanFile,
-					CloudSyncLayer:             c.parsedArgs.Run.CloudSyncLayer,
+					CloudSyncDeployment:        c.parsedArgs.Run.SyncDeployment,
+					CloudSyncDriftStatus:       c.parsedArgs.Run.SyncDriftStatus,
+					CloudSyncPreview:           c.parsedArgs.Run.SyncPreview,
+					CloudSyncTerraformPlanFile: c.parsedArgs.Run.TerraformPlanFile,
+					CloudSyncLayer:             c.parsedArgs.Run.Layer,
 					UseTerragrunt:              c.parsedArgs.Run.Terragrunt,
 				},
 			},
@@ -179,14 +179,14 @@ func (c *cli) runOnStacks() {
 		runs = append(runs, run)
 	}
 
-	if c.parsedArgs.Run.CloudSyncDeployment {
+	if c.parsedArgs.Run.SyncDeployment {
 		// This will just select all runs, since the CloudSyncDeployment was set just above.
 		// Still, it's convenient to re-use this function here.
 		deployRuns := selectCloudStackTasks(runs, isDeploymentTask)
 		c.createCloudDeployment(deployRuns)
 	}
 
-	if c.parsedArgs.Run.CloudSyncPreview && c.cloudEnabled() {
+	if c.parsedArgs.Run.SyncPreview && c.cloudEnabled() {
 		// See comment above.
 		previewRuns := selectCloudStackTasks(runs, isPreviewTask)
 		for metaID, previewID := range c.createCloudPreview(previewRuns) {
@@ -560,7 +560,7 @@ func (c *cli) createCloudPreview(runs []stackCloudRun) map[string]string {
 	if pullRequest == nil || pullRequest.GetUpdatedAt().IsZero() {
 		printer.Stderr.WarnWithDetails(
 			"unable to create preview: missing pull request information",
-			errors.E("--cloud-sync-preview can only be used in a GitHub Action workflow triggered by a pull request event"),
+			errors.E("--sync-preview can only be used in a GitHub Action workflow triggered by a pull request event"),
 		)
 		c.disableCloudFeatures(cloudError())
 		return map[string]string{}

cmd/terramate/cli/script_run.go

@@ -39,7 +39,7 @@ func (c *cli) runScript() {
 		stacks = append(stacks, st.Sortable())
 	} else {
 		var err error
-		stacks, err = c.computeSelectedStacks(true, parseStatusFilter(c.parsedArgs.Script.Run.CloudStatus))
+		stacks, err = c.computeSelectedStacks(true, parseStatusFilter(c.parsedArgs.Script.Run.Status))
 		if err != nil {
 			fatal("failed to compute selected stacks", err)
 		}