cli: Nicer usage and indent input iteration

wader · Sep 12, 2021 · 78eb737 · 78eb737
1 parent 2d6573d
commit 78eb737
Show file tree

Hide file tree

Showing 4 changed files with 47 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -77,7 +77,7 @@ Basic usage is:
 
 [fq -h | grep Usage: | sed 's/\(.*\)/<pre>\1<\/pre>/']: sh-start
 
-<pre>Usage: fq [OPTIONS] [EXPR] [FILE...]</pre>
+<pre>Usage: fq [OPTIONS] [--] [EXPR] [FILE...]</pre>
 
 [#]: sh-end
 

diff --git a/doc/usage.md b/doc/usage.md
@@ -2,17 +2,22 @@
 
 <pre sh>
 $ fq -h 
-Usage: fq [OPTIONS] [EXPR] [FILE...]
+fq - jq for binary
+Tool, language and decoders for querying and exploring binary data.
+For more information see https://github.com/wader/fq
+
+Usage: fq [OPTIONS] [--] [EXPR] [FILE...]
 --compact,-c               Compact output
 --decode,-d=NAME           Decode format (probe)
---file,-f=PATH             Read script from file
+--file,-f=PATH             Read EXPR from file
 --formats                  Show supported formats
 --help,-h                  Show help
 --join-output,-j           No newline between outputs
+--null-input,-n            Null input (can still use input/0 and inputs/0)
 --null-output,-0           Null byte between outputs
---null-input,-n            Null input (can still use input/0 or inputs/0)
 --option,-o=KEY=VALUE,...  Set option, eg: color=true
                              addrbase=16
+                             bitsformat=snippet
                              bytecolors=0-0xff=brightwhite,0=brightblack,32-126:9-13=white
                              color=false
                              colors=array=white,dumpaddr=yellow,dumpheader=yellow+underline,error=brightred,false=yellow,index=white,null=brightblack,number=cyan,object=white,objectkey=brightblue,string=green,true=yellow,value=white

diff --git a/pkg/interp/fq.jq b/pkg/interp/fq.jq
@@ -365,7 +365,12 @@ def _main:
       },
     };
   def _usage($arg0; $version):
-    "Usage: \($arg0) [OPTIONS] [--] [EXPR] [FILE...]";
+    ( "fq - jq for binary"
+    , "Tool, language and decoders for querying and exploring binary data."
+    , "For more information see https://github.com/wader/fq"
+    , ""
+    , "Usage: \($arg0) [OPTIONS] [--] [EXPR] [FILE...]"
+    );
   ( . as {$version, $args, args: [$arg0]}
   # make sure we don't unintentionally use . to make things clearer
   | null
@@ -426,26 +431,27 @@ def _main:
         | inputs($filenames) as $_ # store inputs
         | if $null_input then null
           elif $parsed_args.slurp then [inputs]
-          else inputs # will iterate inputs
-          end
-        | if $parsed_args.repl then [_cli_expr_eval($expr)] | repl({}; .[])
-          else
-            ( _cli_last_expr_error(null) as $_
-            | _cli_expr_eval($expr; _repl_display)
-            )
-          end
-        )
-        ; # finally
-        ( if _input_io_errors != null then
-            null | halt_error(_exit_code_input_io_error)
-          end
-        | if _input_decode_errors != null then
-            null | halt_error(_exit_code_input_decode_error)
-          end
-        | if _cli_last_expr_error != null then
-            null | halt_error(_exit_code_expr_error)
+          else inputs
           end
-        )
+          # will iterate zero or more inputs
+          | if $parsed_args.repl then [_cli_expr_eval($expr)] | repl({}; .[])
+            else
+              ( _cli_last_expr_error(null) as $_
+              | _cli_expr_eval($expr; _repl_display)
+              )
+            end
+          )
+          ; # finally
+          ( if _input_io_errors != null then
+              null | halt_error(_exit_code_input_io_error)
+            end
+          | if _input_decode_errors != null then
+              null | halt_error(_exit_code_input_decode_error)
+            end
+          | if _cli_last_expr_error != null then
+              null | halt_error(_exit_code_expr_error)
+            end
+          )
       )
     end
   );
diff --git a/pkg/interp/testdata/args.fqtest b/pkg/interp/testdata/args.fqtest
@@ -1,7 +1,15 @@
 /test.mp3:
 > fq
+fq - jq for binary
+Tool, language and decoders for querying and exploring binary data.
+For more information see https://github.com/wader/fq
+
 Usage: fq [OPTIONS] [--] [EXPR] [FILE...]
 > fq -h
+fq - jq for binary
+Tool, language and decoders for querying and exploring binary data.
+For more information see https://github.com/wader/fq
+
 Usage: fq [OPTIONS] [--] [EXPR] [FILE...]
 --compact,-c               Compact output
 --decode,-d=NAME           Decode format (probe)
@@ -34,6 +42,10 @@ null> ^D
 > fq -i . /test.mp3
 mp3> ^D
 > fq -n
+fq - jq for binary
+Tool, language and decoders for querying and exploring binary data.
+For more information see https://github.com/wader/fq
+
 Usage: fq [OPTIONS] [--] [EXPR] [FILE...]
 > fq -ni
 null> ^D