feat: include summary of omitted binary data
This commit is contained in:
parent
d63c1fd77b
commit
07330be10b
9 changed files with 57 additions and 30 deletions
10
README.md
10
README.md
|
|
@ -563,15 +563,15 @@ pda get logo > output.png
|
|||
|
||||
<p align="center"></p><!-- spacer -->
|
||||
|
||||
`list` and `get` will omit binary data whenever it's a human reading it. If it's being piped somewhere or ran outside of a TTY, it'll output the whole data.
|
||||
`list` and `get` will show a summary for binary data on a TTY. If it's being piped somewhere or ran outside of a TTY, it'll output the raw bytes.
|
||||
|
||||
`include-binary` to show the full binary data regardless.
|
||||
`--base64`/`-b` to view binary data as base64 on a TTY.
|
||||
```bash
|
||||
pda get logo
|
||||
# (omitted binary data)
|
||||
# (binary: 4.2 KB, image/png)
|
||||
|
||||
pda get logo --include-binary
|
||||
# 89504E470D0A1A0A0000000D4948445200000001000000010802000000
|
||||
pda get logo --base64
|
||||
# iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAIAAACQd1PeAAAADklEQVQI12...
|
||||
```
|
||||
|
||||
<p align="center"></p><!-- spacer -->
|
||||
|
|
|
|||
|
|
@ -100,7 +100,7 @@ func get(cmd *cobra.Command, args []string) error {
|
|||
}
|
||||
v := entry.Value
|
||||
|
||||
binary, err := cmd.Flags().GetBool("include-binary")
|
||||
binary, err := cmd.Flags().GetBool("base64")
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot get '%s': %v", args[0], err)
|
||||
}
|
||||
|
|
@ -235,12 +235,12 @@ func run(cmd *cobra.Command, args []string) error {
|
|||
var runFlag bool
|
||||
|
||||
func init() {
|
||||
getCmd.Flags().BoolP("include-binary", "b", false, "include binary data in text output")
|
||||
getCmd.Flags().BoolP("base64", "b", false, "view binary data as base64")
|
||||
getCmd.Flags().BoolVarP(&runFlag, "run", "c", false, "execute the result as a shell command")
|
||||
getCmd.Flags().Bool("no-template", false, "directly output template syntax")
|
||||
rootCmd.AddCommand(getCmd)
|
||||
|
||||
runCmd.Flags().BoolP("include-binary", "b", false, "include binary data in text output")
|
||||
runCmd.Flags().BoolP("base64", "b", false, "view binary data as base64")
|
||||
runCmd.Flags().Bool("no-template", false, "directly output template syntax")
|
||||
rootCmd.AddCommand(runCmd)
|
||||
}
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ func (e *formatEnum) Set(v string) error {
|
|||
func (e *formatEnum) Type() string { return "format" }
|
||||
|
||||
var (
|
||||
listBinary bool
|
||||
listBase64 bool
|
||||
listNoKeys bool
|
||||
listNoValues bool
|
||||
listTTL bool
|
||||
|
|
@ -194,7 +194,7 @@ func list(cmd *cobra.Command, args []string) error {
|
|||
if e.Locked {
|
||||
valueStr = "locked (identity file missing)"
|
||||
} else {
|
||||
valueStr = store.FormatBytes(listBinary, e.Value)
|
||||
valueStr = store.FormatBytes(listBase64, e.Value)
|
||||
}
|
||||
}
|
||||
row := make(table.Row, 0, len(columns))
|
||||
|
|
@ -315,7 +315,7 @@ func renderTable(tw table.Writer) {
|
|||
}
|
||||
|
||||
func init() {
|
||||
listCmd.Flags().BoolVarP(&listBinary, "binary", "b", false, "include binary data in text output")
|
||||
listCmd.Flags().BoolVarP(&listBase64, "base64", "b", false, "view binary data as base64")
|
||||
listCmd.Flags().BoolVar(&listNoKeys, "no-keys", false, "suppress the key column")
|
||||
listCmd.Flags().BoolVar(&listNoValues, "no-values", false, "suppress the value column")
|
||||
listCmd.Flags().BoolVarP(&listTTL, "ttl", "t", false, "append a TTL column when entries expire")
|
||||
|
|
|
|||
|
|
@ -23,8 +23,10 @@ THE SOFTWARE.
|
|||
package cmd
|
||||
|
||||
import (
|
||||
"encoding/base64"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
|
@ -67,14 +69,39 @@ func (s *Store) FormatBytes(includeBinary bool, v []byte) string {
|
|||
return s.formatBytes(includeBinary, v)
|
||||
}
|
||||
|
||||
func (s *Store) formatBytes(includeBinary bool, v []byte) string {
|
||||
tty := term.IsTerminal(int(os.Stdout.Fd()))
|
||||
if tty && !includeBinary && !utf8.Valid(v) {
|
||||
return "(omitted binary data)"
|
||||
func (s *Store) formatBytes(base64Flag bool, v []byte) string {
|
||||
if !utf8.Valid(v) {
|
||||
tty := term.IsTerminal(int(os.Stdout.Fd()))
|
||||
if !tty {
|
||||
return string(v)
|
||||
}
|
||||
if base64Flag {
|
||||
return base64.StdEncoding.EncodeToString(v)
|
||||
}
|
||||
mime := http.DetectContentType(v)
|
||||
return fmt.Sprintf("(binary: %s, %s)", formatSize(len(v)), mime)
|
||||
}
|
||||
return string(v)
|
||||
}
|
||||
|
||||
func formatSize(n int) string {
|
||||
const (
|
||||
kb = 1024
|
||||
mb = 1024 * kb
|
||||
gb = 1024 * mb
|
||||
)
|
||||
switch {
|
||||
case n < kb:
|
||||
return fmt.Sprintf("%d B", n)
|
||||
case n < mb:
|
||||
return fmt.Sprintf("%.1f KB", float64(n)/float64(kb))
|
||||
case n < gb:
|
||||
return fmt.Sprintf("%.1f MB", float64(n)/float64(mb))
|
||||
default:
|
||||
return fmt.Sprintf("%.1f GB", float64(n)/float64(gb))
|
||||
}
|
||||
}
|
||||
|
||||
func (s *Store) storePath(name string) (string, error) {
|
||||
if name == "" {
|
||||
name = config.Store.DefaultStoreName
|
||||
|
|
|
|||
6
testdata/get__missing__err__with__any.ct
vendored
6
testdata/get__missing__err__with__any.ct
vendored
|
|
@ -1,7 +1,7 @@
|
|||
$ pda get foobar --> FAIL
|
||||
$ pda get foobar --include-binary --> FAIL
|
||||
$ pda get foobar --include-binary --run --> FAIL
|
||||
$ pda get foobar --include-binary --run --secret --> FAIL
|
||||
$ pda get foobar --base64 --> FAIL
|
||||
$ pda get foobar --base64 --run --> FAIL
|
||||
$ pda get foobar --base64 --run --secret --> FAIL
|
||||
$ pda get foobar --run --> FAIL
|
||||
$ pda get foobar --run --secret --> FAIL
|
||||
$ pda get foobar --secret --> FAIL
|
||||
|
|
|
|||
2
testdata/get__ok__with__binary.ct
vendored
2
testdata/get__ok__with__binary.ct
vendored
|
|
@ -1,3 +1,3 @@
|
|||
$ pda set a b
|
||||
$ pda get a --include-binary
|
||||
$ pda get a --base64
|
||||
b
|
||||
|
|
|
|||
2
testdata/get__ok__with__binary_run.ct
vendored
2
testdata/get__ok__with__binary_run.ct
vendored
|
|
@ -1,4 +1,4 @@
|
|||
$ fecho cmd echo hello
|
||||
$ pda set foo < cmd
|
||||
$ pda get foo --include-binary --run
|
||||
$ pda get foo --base64 --run
|
||||
hello
|
||||
|
|
|
|||
16
testdata/help__get__ok.ct
vendored
16
testdata/help__get__ok.ct
vendored
|
|
@ -16,10 +16,10 @@ Aliases:
|
|||
get, g
|
||||
|
||||
Flags:
|
||||
-h, --help help for get
|
||||
-b, --include-binary include binary data in text output
|
||||
--no-template directly output template syntax
|
||||
-c, --run execute the result as a shell command
|
||||
-b, --base64 view binary data as base64
|
||||
-h, --help help for get
|
||||
--no-template directly output template syntax
|
||||
-c, --run execute the result as a shell command
|
||||
Get the value of a key. Optionally specify a store.
|
||||
|
||||
{{ .TEMPLATES }} can be filled by passing TEMPLATE=VALUE as an
|
||||
|
|
@ -36,7 +36,7 @@ Aliases:
|
|||
get, g
|
||||
|
||||
Flags:
|
||||
-h, --help help for get
|
||||
-b, --include-binary include binary data in text output
|
||||
--no-template directly output template syntax
|
||||
-c, --run execute the result as a shell command
|
||||
-b, --base64 view binary data as base64
|
||||
-h, --help help for get
|
||||
--no-template directly output template syntax
|
||||
-c, --run execute the result as a shell command
|
||||
|
|
|
|||
4
testdata/help__list__ok.ct
vendored
4
testdata/help__list__ok.ct
vendored
|
|
@ -9,7 +9,7 @@ Aliases:
|
|||
list, ls
|
||||
|
||||
Flags:
|
||||
-b, --binary include binary data in text output
|
||||
-b, --base64 view binary data as base64
|
||||
-o, --format format output format (table|tsv|csv|markdown|html|ndjson) (default table)
|
||||
-g, --glob strings Filter keys with glob pattern (repeatable)
|
||||
--glob-sep string Characters treated as separators for globbing (default '/-_.@: ')
|
||||
|
|
@ -27,7 +27,7 @@ Aliases:
|
|||
list, ls
|
||||
|
||||
Flags:
|
||||
-b, --binary include binary data in text output
|
||||
-b, --base64 view binary data as base64
|
||||
-o, --format format output format (table|tsv|csv|markdown|html|ndjson) (default table)
|
||||
-g, --glob strings Filter keys with glob pattern (repeatable)
|
||||
--glob-sep string Characters treated as separators for globbing (default '/-_.@: ')
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue