feat(flags): negative flags added for defaults (--no-keys, --no-values), and removes --include- prefix from positive flags

This commit is contained in:
Lewis Wynne 2025-11-07 12:25:03 +00:00
parent 434855e958
commit 4ace97bddc
3 changed files with 46 additions and 29 deletions

View file

@ -55,7 +55,7 @@ func dump(cmd *cobra.Command, args []string) error {
return fmt.Errorf("unsupported encoding %q", mode) return fmt.Errorf("unsupported encoding %q", mode)
} }
includeSecret, err := cmd.Flags().GetBool("include-secret") includeSecret, err := cmd.Flags().GetBool("secret")
if err != nil { if err != nil {
return err return err
} }
@ -121,7 +121,7 @@ func dump(cmd *cobra.Command, args []string) error {
func init() { func init() {
dumpCmd.Flags().StringP("encoding", "e", "auto", "value encoding: auto, base64, or text") dumpCmd.Flags().StringP("encoding", "e", "auto", "value encoding: auto, base64, or text")
dumpCmd.Flags().Bool("include-secret", false, "Include entries marked as secret") dumpCmd.Flags().Bool("secret", false, "Include entries marked as secret")
rootCmd.AddCommand(dumpCmd) rootCmd.AddCommand(dumpCmd)
} }

View file

@ -60,7 +60,7 @@ func get(cmd *cobra.Command, args []string) error {
return err return err
} }
includeSecret, err := cmd.Flags().GetBool("include-secret") includeSecret, err := cmd.Flags().GetBool("secret")
if err != nil { if err != nil {
return err return err
} }
@ -79,6 +79,6 @@ func get(cmd *cobra.Command, args []string) error {
func init() { func init() {
getCmd.Flags().BoolP("include-binary", "b", false, "include binary data in text output") getCmd.Flags().BoolP("include-binary", "b", false, "include binary data in text output")
getCmd.Flags().Bool("include-secret", false, "display values marked as secret") getCmd.Flags().Bool("secret", false, "display values marked as secret")
rootCmd.AddCommand(getCmd) rootCmd.AddCommand(getCmd)
} }

View file

@ -63,38 +63,38 @@ func list(cmd *cobra.Command, args []string) error {
return err return err
} }
includeSecret, err := cmd.Flags().GetBool("include-secret") showSecrets, err := cmd.Flags().GetBool("secret")
if err != nil { if err != nil {
return err return err
} }
keysOnly, err := cmd.Flags().GetBool("only-keys") noKeys, err := cmd.Flags().GetBool("no-keys")
if err != nil { if err != nil {
return err return err
} }
valuesOnly, err := cmd.Flags().GetBool("only-values") noValues, err := cmd.Flags().GetBool("no-values")
if err != nil { if err != nil {
return err return err
} }
if keysOnly && valuesOnly { showTTL, err := cmd.Flags().GetBool("ttl")
return fmt.Errorf("--only-keys and --only-values are mutually exclusive")
}
showExpiry, err := cmd.Flags().GetBool("show-expiry")
if err != nil { if err != nil {
return err return err
} }
binary, err := cmd.Flags().GetBool("include-binary") binary, err := cmd.Flags().GetBool("binary")
if err != nil { if err != nil {
return err return err
} }
includeKey := !valuesOnly includeKey := !noKeys
includeValue := !keysOnly includeValue := !noValues
if !includeKey && !includeValue && !showTTL {
return fmt.Errorf("no columns selected; disable --no-keys/--no-values or pass --ttl")
}
prefetchVals := includeValue prefetchVals := includeValue
columnKinds := selectColumns(includeKey, includeValue, showExpiry) columnKinds := selectColumns(includeKey, includeValue, showTTL)
if len(columnKinds) == 0 { if len(columnKinds) == 0 {
return fmt.Errorf("no columns selected; enable keys or values") return fmt.Errorf("no columns selected; enable key, value, or ttl output")
} }
delimiterBytes := []byte(delimiter) delimiterBytes := []byte(delimiter)
@ -107,7 +107,9 @@ func list(cmd *cobra.Command, args []string) error {
writer := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 0, 2, ' ', 0) writer := tabwriter.NewWriter(cmd.OutOrStdout(), 0, 0, 2, ' ', 0)
defer writer.Flush() defer writer.Flush()
placeholder := []byte("<secrets hidden>") placeholder := []byte("**********")
header := insertDelimiters(buildHeaderCells(columnKinds), delimiterBytes)
store.PrintTo(writer, format, false, header...)
trans := TransactionArgs{ trans := TransactionArgs{
key: targetDB, key: targetDB,
@ -126,7 +128,7 @@ func list(cmd *cobra.Command, args []string) error {
meta := item.UserMeta() meta := item.UserMeta()
isSecret := meta&metaSecret != 0 isSecret := meta&metaSecret != 0
valueBuf = valueBuf[:0] valueBuf = valueBuf[:0]
if includeValue && (!isSecret || includeSecret) { if includeValue && (!isSecret || showSecrets) {
if err := item.Value(func(v []byte) error { if err := item.Value(func(v []byte) error {
valueBuf = append(valueBuf[:0], v...) valueBuf = append(valueBuf[:0], v...)
return nil return nil
@ -140,12 +142,12 @@ func list(cmd *cobra.Command, args []string) error {
case columnKey: case columnKey:
columns = append(columns, key) columns = append(columns, key)
case columnValue: case columnValue:
if isSecret && !includeSecret { if isSecret && !showSecrets {
columns = append(columns, placeholder) columns = append(columns, placeholder)
} else { } else {
columns = append(columns, valueBuf) columns = append(columns, valueBuf)
} }
case columnExpiry: case columnTTL:
columns = append(columns, []byte(formatExpiry(item.ExpiresAt()))) columns = append(columns, []byte(formatExpiry(item.ExpiresAt())))
} }
} }
@ -160,12 +162,12 @@ func list(cmd *cobra.Command, args []string) error {
} }
func init() { func init() {
listCmd.Flags().BoolP("include-binary", "b", false, "include binary data in text output") listCmd.Flags().BoolP("binary", "b", false, "include binary data in text output")
listCmd.Flags().StringP("delimiter", "d", "", "string inserted between columns") listCmd.Flags().StringP("delimiter", "d", "", "string inserted between columns")
listCmd.Flags().Bool("include-secret", false, "include entries marked as secret") listCmd.Flags().Bool("secret", false, "display values marked as secret")
listCmd.Flags().BoolP("only-keys", "k", false, "only print keys") listCmd.Flags().Bool("no-keys", false, "suppress the key column")
listCmd.Flags().BoolP("only-values", "v", false, "only print values") listCmd.Flags().Bool("no-values", false, "suppress the value column")
listCmd.Flags().Bool("show-expiry", false, "append an expiry column when entries have TTLs") listCmd.Flags().Bool("ttl", false, "append a TTL column when entries expire")
rootCmd.AddCommand(listCmd) rootCmd.AddCommand(listCmd)
} }
@ -174,10 +176,10 @@ type columnKind int
const ( const (
columnKey columnKind = iota columnKey columnKind = iota
columnValue columnValue
columnExpiry columnTTL
) )
func selectColumns(includeKey, includeValue, showExpiry bool) []columnKind { func selectColumns(includeKey, includeValue, showTTL bool) []columnKind {
var columns []columnKind var columns []columnKind
if includeKey { if includeKey {
columns = append(columns, columnKey) columns = append(columns, columnKey)
@ -185,8 +187,8 @@ func selectColumns(includeKey, includeValue, showExpiry bool) []columnKind {
if includeValue { if includeValue {
columns = append(columns, columnValue) columns = append(columns, columnValue)
} }
if showExpiry { if showTTL {
columns = append(columns, columnExpiry) columns = append(columns, columnTTL)
} }
return columns return columns
} }
@ -219,3 +221,18 @@ func insertDelimiters(columns [][]byte, delimiter []byte) [][]byte {
} }
return out return out
} }
func buildHeaderCells(columnKinds []columnKind) [][]byte {
headers := make([][]byte, 0, len(columnKinds))
for _, column := range columnKinds {
switch column {
case columnKey:
headers = append(headers, []byte("Key"))
case columnValue:
headers = append(headers, []byte("Value"))
case columnTTL:
headers = append(headers, []byte("TTL"))
}
}
return headers
}