Remove sps references from help messages

turbot · Jun 5, 2024 · 805699f · 805699f
1 parent aa27aa6
commit 805699f
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 10 deletions.
diff --git a/internal/cmd/dashboard.go b/internal/cmd/dashboard.go
@@ -54,7 +54,7 @@ The current mod is the working directory, or the directory specified by the --mo
 		AddCloudFlags().
 		AddModLocationFlag().
 		AddStringArrayFlag(constants.ArgArg, nil, "Specify the value of a dashboard argument").
-		AddStringSliceFlag(constants.ArgExport, nil, "Export output to file, supported format: sps (snapshot)").
+		AddStringSliceFlag(constants.ArgExport, nil, "Export output to file, supported format: pps (snapshot)").
 		AddStringFlag(constants.ArgDatabase, app_specific.DefaultDatabase, "Turbot Pipes workspace database").
 		AddIntFlag(constants.ArgDatabaseQueryTimeout, localconstants.DatabaseDefaultQueryTimeout, "The query timeout").
 		AddBoolFlag(constants.ArgHelp, false, "Help for dashboard", cmdconfig.FlagOptions.WithShortHand("h")).

diff --git a/internal/cmd/query.go b/internal/cmd/query.go
@@ -54,7 +54,7 @@ The current mod is the working directory, or the directory specified by the --mo
 		AddStringArrayFlag(constants.ArgArg, nil, "Specify the value of a query argument").
 		AddStringFlag(constants.ArgDatabase, app_specific.DefaultDatabase, "Turbot Pipes workspace database").
 		AddIntFlag(constants.ArgDatabaseQueryTimeout, localconstants.DatabaseDefaultQueryTimeout, "The query timeout").
-		AddStringSliceFlag(constants.ArgExport, nil, "Export output to file, supported formats: csv, html, json, md, nunit3, sps (snapshot), asff").
+		AddStringSliceFlag(constants.ArgExport, nil, "Export output to file, supported formats: csv, html, json, md, nunit3, pps (snapshot), asff").
 		AddBoolFlag(constants.ArgHeader, true, "Include column headers for csv and table output").
 		AddBoolFlag(constants.ArgHelp, false, "Help for query", cmdconfig.FlagOptions.WithShortHand("h")).
 		AddBoolFlag(constants.ArgInput, true, "Enable interactive prompts").

diff --git a/internal/constants/extensions.go b/internal/constants/extensions.go
@@ -0,0 +1,5 @@
+package constants
+
+const (
+	SnapshotExtension = ".pps"
+)
diff --git a/internal/constants/flags.go b/internal/constants/flags.go
@@ -35,12 +35,15 @@ const (
 	QueryOutputModeNone
 )
 
+// powerpipe snapshot
+const OutputFormatPpSnapshotShort = "pps"
+
 var QueryOutputModeIds = map[QueryOutputMode][]string{
 	QueryOutputModeCsv:           {constants.OutputFormatCSV},
 	QueryOutputModeJson:          {constants.OutputFormatJSON},
 	QueryOutputModeLine:          {constants.OutputFormatLine},
 	QueryOutputModeSnapshot:      {constants.OutputFormatSnapshot},
-	QueryOutputModeSnapshotShort: {constants.OutputFormatSnapshotShort},
+	QueryOutputModeSnapshotShort: {OutputFormatPpSnapshotShort},
 	QueryOutputModeTable:         {constants.OutputFormatTable},
 	QueryOutputModeNone:          {constants.OutputFormatNone},
 }
@@ -55,7 +58,7 @@ const (
 
 var DashboardOutputModeIds = map[DashboardOutputMode][]string{
 	DashboardOutputModeSnapshot:      {constants.OutputFormatSnapshot},
-	DashboardOutputModeSnapshotShort: {constants.OutputFormatSnapshotShort},
+	DashboardOutputModeSnapshotShort: {OutputFormatPpSnapshotShort},
 	DashboardOutputModeNone:          {constants.OutputFormatNone},
 }
 
@@ -83,6 +86,6 @@ var CheckOutputModeIds = map[CheckOutputMode][]string{
 	CheckOutputModeMd:            {constants.OutputFormatMD},
 	CheckOutputModeTest:          {constants.OutputFormatText},
 	CheckOutputModeSnapshot:      {constants.OutputFormatSnapshot},
-	CheckOutputModeSnapshotShort: {constants.OutputFormatSnapshotShort},
+	CheckOutputModeSnapshotShort: {OutputFormatPpSnapshotShort},
 	CheckOutputModeNone:          {constants.OutputFormatNone},
 }
diff --git a/internal/controldisplay/formatter_snapshot.go b/internal/controldisplay/formatter_snapshot.go
@@ -7,6 +7,7 @@ import (
 	"strings"
 
 	"github.com/turbot/pipe-fittings/constants"
+	localconstants "github.com/turbot/powerpipe/internal/constants"
 	"github.com/turbot/powerpipe/internal/controlexecute"
 )
 
@@ -38,13 +39,13 @@ func (f *SnapshotFormatter) Format(ctx context.Context, tree *controlexecute.Exe
 }
 
 func (f *SnapshotFormatter) FileExtension() string {
-	return constants.SnapshotExtension
+	return localconstants.SnapshotExtension
 }
 
 func (f SnapshotFormatter) Name() string {
 	return constants.OutputFormatSnapshot
 }
 
 func (f *SnapshotFormatter) Alias() string {
-	return "pps"
+	return localconstants.OutputFormatPpSnapshotShort
 }
diff --git a/internal/controldisplay/formatter_test.go b/internal/controldisplay/formatter_test.go
@@ -2,12 +2,13 @@ package controldisplay
 
 import (
 	"context"
-	"github.com/turbot/pipe-fittings/app_specific"
 	"io"
 	"os"
 	"testing"
 
+	"github.com/turbot/pipe-fittings/app_specific"
 	"github.com/turbot/pipe-fittings/constants"
+	localconstants "github.com/turbot/powerpipe/internal/constants"
 	"github.com/turbot/powerpipe/internal/controlexecute"
 )
 
@@ -39,8 +40,8 @@ var formatterTestCase = []testCase{
 	{
 		input: "snapshot",
 		expected: testFormatter{
-			alias:     "pps",
-			extension: constants.SnapshotExtension,
+			alias:     localconstants.OutputFormatPpSnapshotShort,
+			extension: localconstants.SnapshotExtension,
 			name:      constants.OutputFormatSnapshot,
 		},
 	},