initial commit of chap package (#52)

Co-authored-by: Kirt Fitzpatrick <[email protected]>

Author: kirtfitzpatrick

_posts/2021-05-06-chap.md

@@ -0,0 +1,101 @@
+---
+layout: post
+title: "chap"
+description: "Utility methods for writing scripts for humans"
+category: bash
+tags: [color, bash, utility, utils, library]
+---
+## Installation
+
+{% highlight bash %}
+$ bpkg install [-g] kirtfitzpatrick/chap
+{% endhighlight %}
+
+## Usage
+
+{% highlight bash %}
+$ chap info_msg "Hello, world."
+{% endhighlight %}
+
+<span style="color:cyan">Info:</span> Hello, world.
+
+{% highlight bash %}
+$ chap -h
+Usage:
+  chap [-hV]
+Options:
+  -h|--help      Print this help dialogue and exit
+  -V|--version   Print the current version and exit
+
+Logging:
+  info_msg         MESSAGE
+  nominal_msg      MESSAGE
+  attention_msg    MESSAGE
+  warning_msg      MESSAGE
+  modification_msg MESSAGE
+
+Evaluate command:
+  info_cmd         COMMAND [ MESSAGE ]
+  nominal_cmd      COMMAND [ MESSAGE ]
+  attention_cmd    COMMAND [ MESSAGE ]
+  warning_cmd      COMMAND [ MESSAGE ]
+  modification_cmd COMMAND [ MESSAGE ]
+  echo_cmd         COMMAND
+
+Internal:
+  display_link       FILE_LINK_OR_DIR_PATH
+  brief_echo         OUTPUT_STRING
+  brief_eval         COMMAND
+
+Iterate by line:
+  begin_line_looping # PREV_IFS=$(chap begin_line_looping)
+  end_line_looping   # chap end_line_looping "${PREV_IFS}"
+
+Special purpose:
+  print_header       "$0 $*"
+  verify_line_count  LABEL COMPARISON_OP VALUE COMMAND
+  confirm_cmd        COMMAND [MESSAGE]
+{% endhighlight %}
+
+
+## Example
+
+{% highlight bash %}
+#!/usr/bin/env bash
+source deps/bin/chap
+
+chap print_header "$0 $*"
+chap info_msg "Let's verify line counts."
+chap verify_line_count \
+  "files" "-ge" 4 \ 
+  "find . -type f -or -type l" 
+chap confirm_cmd "find . -name '*.sh'" \ 
+  "Prompt to confirm or skip."
+{% endhighlight %}
+
+
+---
+<span style="color:cyan">Host:</span>        Kirts-MacBook-Pro-2019.local<br />
+<span style="color:cyan">Command:</span>     ./demo.sh <br />
+<span style="color:cyan">Working Dir:</span> /Users/kirt/Dropbox/Development/Bidpath/chap-demo<br />
+
+<span style="color:cyan">Info:</span> Verify correct file count. <br />
+<span style="color:green">Nominal:</span> 4 files found. <br />
+<span style="color:blue">find . -type f -or -type l</span><br />
+./demo.sh<br />
+./deps/bin/chap -> <span style="color:cyan">../chap/chap.sh</span><br />
+./deps/chap/chap.sh<br />
+./deps/chap/package.json<br />
+<span style="color:cyan">Info:</span> Prompt to confirm or skip.<br />
+<span style="color:blue">find . -name '*.sh'</span><br />
+<span style="color:purple">Execute (a=all, s=skip):</span> <br />
+<span style="color:cyan">Initiated at:</span> 15:22:37<br />
+./demo.sh<br />
+./deps/chap/chap.sh<br />
+<span style="color:cyan">Completed at:</span> 15:22:37<br />
+
+
+## Links
+* [Source Code (GitHub)][https://github.com/kirtfitzpatrick/chap]
+* [Author: Kirt Fitzpatrick](https://twitter.com/KirtFitzpatrick)
+{% include JB/setup %}