Add mdfmt, a Markdown formatting helper

Also a first POSIX-oriented library!

mkit.ini

@@ -51,4 +51,5 @@
     etc_bc   = src/complete.bash        shellfu.bash
     etc_bc   = src/complete-devel.bash  shellfu-devel.bash
     includes = src/include-bash
+    includes = src/include-sh
     share    = src/shellfu.sh

packaging/debian/control

@@ -108,5 +108,22 @@ Description: Bash-specific base
  This sub-package contains POSIX-oriented parts of library infrastructure.
  Generic Shellfu modules aiming for POSIX compatibility should depend on this.
 
+Package: shellfu-sh-mdfmt
+Architecture: all
+Depends: shellfu-sh
+Description: Markdown formatting helper
+ Shellfu is an attempt to add modularity to your shell scripts.
+ .
+ With Shellfu you can develop your shell modules separately from your
+ scripts, and test, use, explore or study them without need to be aware
+ of details such as where the actual files are placed.
+ .
+ Shellfu is mostly intended for cases when there's need for non-trivial
+ amount of reliable body of shell scripts, and access to advanced modular
+ languages such as Python or Perl is limited.
+ .
+ This sub-package contains Markdown formatting helper, a function that
+ Helps you generate Markdown paragraph elements from your shell scripts.
+
 
 # control file built with MKit __MKIT_SELF_VERSION__

packaging/debian/shellfu-sh-mdfmt.install

@@ -0,0 +1 @@
+/usr/local/share/shellfu/include-sh/mdfmt.sh

packaging/template.spec

@@ -60,6 +60,13 @@ Requires: shellfu
 This sub-package contains POSIX-oriented parts of library infrastructure.
 Generic Shellfu modules aiming for POSIX compatibility should depend on this.
 
+%package sh-mdfmt
+Summary: Markdown formatting helper
+Requires: shellfu-sh
+%description sh-mdfmt
+This sub-package contains Markdown formatting helper, a function that
+helps you generate Markdown paragraph elements from your shell scripts.
+
 
 %prep
 %setup -q
@@ -107,6 +114,9 @@ make %{?_smp_mflags}
 %files sh
 %dir /usr/local/share/shellfu/include-sh
 
+%files sh-mdfmt
+/usr/local/share/shellfu/include-sh/mdfmt.sh
+
 %changelog
 
 # specfile built with MKit __MKIT_SELF_VERSION__

src/include-sh/mdfmt.sh

@@ -0,0 +1,231 @@
+#!/usr/bin/sh
+
+#
+# mdfmt - Markdown formatted output from your shell scripts
+#
+# These functions allow you to easily output a valid Markdown
+# from your script.
+#
+
+MDFMT_WIDTH=${MDFMT_WIDTH:-75}
+
+_mdfmt__fmttype() {
+    #
+    # Format fragments $@ as type $Elem
+    #
+    case $Elem in
+        h1)
+            local hdr
+            hdr=$(_mdfmt__join "$@")
+            echo
+            echo
+            echo "$hdr"
+            echo "$hdr" | tr -c '\n' =
+            ;;
+        h2)
+            local hdr
+            hdr=$(_mdfmt__join "$@")
+            echo
+            echo
+            echo "$hdr"
+            echo "$hdr" | tr -c '\n' -
+            ;;
+        h3)
+            local hdr
+            hdr=$(_mdfmt__join "$@")
+            echo
+            echo
+            echo "### $hdr ###"
+            ;;
+        p)
+            echo
+            _mdfmt__join "$@" \
+              | fmt -w "$(_mdfmt__width)"
+            ;;
+        ul)
+            printf '\n *  '
+            _mdfmt__join "$@" \
+              | fmt -t -w "$(_mdfmt__width)" \
+              | sed -e 's/^   /    /'
+            ;;
+        ol)
+            printf '\n 1. '
+            _mdfmt__join "$@" \
+              | fmt -t -w "$(_mdfmt__width)" \
+              | sed -e 's/^   /    /'
+            ;;
+        pre)
+            echo
+            _mdfmt__join "$@" \
+              | sed -e 's/^/    /'
+            ;;
+    esac
+}
+
+_mdfmt__indent() {
+    #
+    # Indent as many spaces as needed
+    #
+    local pfx
+    test "$Nest" -eq 0 && { cat; return; }
+    test "$Elem" == h1 && { cat; return; }
+    test "$Elem" == h2 && { cat; return; }
+    test "$Elem" == h3 && { cat; return; }
+    pfx=$(
+        for n in $(seq 1 "$Nest");
+        do
+            printf '    '
+        done
+    )
+    sed "s/^/$pfx/"
+}
+
+_mdfmt__join() {
+    #
+    # Properly join text fragments $@
+    #
+    case $Elem in
+        pre)  printf '%s\n' "$@" ;;
+        h*)   echo "$1"          ;;
+        *)    echo "$@"          ;;
+    esac
+}
+
+_mdfmt__quote() {
+    #
+    # Quote if needed
+    #
+    local pfx
+    $Quoted || { cat; return; }
+    test "$Elem" == h1 && { cat; return; }
+    test "$Elem" == h2 && { cat; return; }
+    test "$Elem" == h3 && { cat; return; }
+    sed 's/^/> /'
+}
+
+_mdfmt__width() {
+    #
+    # Calculate width
+    #
+    echo "$((MDFMT_WIDTH - Nest * 4))"
+}
+
+mdfmt() {
+    #
+    # Format text as Markdown element $1
+    #
+    # Usage:
+    #     mdfmt [-n|--nest LEVEL] [-q|--quote] ELEM FRAG [FRAG..]
+    #
+    # Take text passed as one or more FRAGs and output it formatted in
+    # Markdown as ELEM.  Passing higher LEVEL than previous item causes
+    # items to nest.
+    #
+    # When multiple FRAGs are provided, the text is simply joined together
+    # (and in most cases re-formatted to fit MDFMT_WIDTH).  This allows
+    # you to pass long texts and keep your code tidy by breaking the text
+    # into several pieces and using line continuation character `\`.
+    #
+    # Additional character-level formatting is achieved using standard
+    # Markdown motation, i.e. asterisk for emphasis, double asterisk
+    # for strong emphasis and backtick for verbatim text.
+    #
+    # Options:
+    #
+    #   * `-n LEVEL`, `--nest LEVEL`  Causes item to be indented so that
+    #     it will be nested into the previous item, if the LEVEL is higher
+    #     than the previous one.  Default value is zero.
+    #
+    #     This can be used to e.g. include unordered items or code examples
+    #     inside ordered items, or multiple paragraphs per (un)ordered
+    #     item.
+    #
+    #   * `-q`, `--quote`  Causes item to appear blockquoted.
+    #
+    # Following values are available for ELEM (names are inspired by
+    # HTML elements):
+    #
+    #  *  `h1`, `h2`, `h3`  - headings of respective weight. Ignores
+    #     nesting.   Accepts only single FRAG.
+    #
+    #  *  `p` - a paragraph.
+    #
+    #  *  `ul`, `ol` - unordered list item (bullet) or ordered (numbered)
+    #     list item.
+    #
+    #  *  `pre` - pre-formatted code.  Multiple FRAGs are treated as lines
+    #     and spaces are preserved.
+    #
+    # Examples:
+    #
+    #     mdfmt h1 "how to boil an egg"
+    #
+    #     mdfmt p  "this tutorial shows you how to boil an egg" \
+    #              "the best way possible"
+    #
+    #     mdfmt h2 "variant 1"
+    #
+    #     mdfmt ol "take egg"
+    #     mdfmt ol "put it in a pot full of water"
+    #     mdfmt ol "place pot onto stove"
+    #     mdfmt ol "turn on stove"
+    #     mdfmt ol "wait"
+    #     mdfmt --nest 1 ul "for hard-boiled, wait 10 minutes"
+    #     mdfmt --nest 1 ul "for soft-boiled, wait 3 minutes"
+    #     mdfmt ol "turn off the stove"
+    #     mdfmt ol "replace water with cold water "
+    #     mdfmt ol "break and replace shell from the egg"
+    #
+    #     mdfmt h2 "variant 1"
+    #
+    #     mdfmt ol "start your favorite browser"
+    #     mdfmt ol "open youtube:"
+    #     mdfmt --nest 1 pre "https://www.youtube.com/"
+    #     mdfmt ol "enter following text in Search box:"
+    #     mdfmt --nest 1 pre "how to boil an egg"
+    #     mdfmt ol "watch at least 5 videos"
+    #     mdfmt ol "go to the closest restaurant and ask for" \
+    #               "a boiled egg"
+    #
+    #     mdfmt h2 "conclusion"
+    #
+    #     mdfmt p  "We hope you enjoy the egg. Seriously."
+    #
+    local Nest=0
+    local Elem
+    local Quoted=false
+    local usage="usage: mdfmt [-n|--nest LVL] ELEM FRAG [FRAG..]"
+    while true; do case $1 in
+        -n|--nest)
+            Nest=$2
+            shift 2 || {
+                echo "$usage" >&2
+                return 2
+            }
+            ;;
+        -q|--quote)
+            Quoted=true
+            shift
+            ;;
+        -*)
+            echo "$usage" >&2
+            return 2
+            ;;
+        *)
+            break
+            ;;
+    esac done
+    Elem=$1; shift
+    case $Elem in
+        h1|h2|h3|p|ol|ul|pre)
+            true
+            ;;
+        *)
+            echo "$usage" >&2
+            return 2
+            ;;
+    esac
+    _mdfmt__fmttype "$@" \
+      | _mdfmt__quote \
+      | _mdfmt__indent
+}

tests/mdfmt/TF_RUN

@@ -0,0 +1,212 @@
+#!/bin/bash
+
+. "$TF_DIR/include/subtest.sh"
+. "$TF_DIR/include/tools.sh"
+
+. "$(shellfu-get path)" || tf_exit_error "failed to init shellfu"
+export PRETTY=plain
+shellfu import mdfmt    || tf_exit_error "failed to import mdfmt"
+
+
+tf_enum_subtests() {
+
+    #
+    # Whole text as single argument (fragment)
+    #
+    echo "single_h1"
+    echo "single_h2"
+    echo "single_h3"
+    echo "single_p"
+    echo "single_ul"
+    echo "single_ol"
+    echo "single_pre"
+
+    #
+    # Each line as separate argument (fragment)
+    #
+    echo "args_h1"
+    echo "args_h2"
+    echo "args_h3"
+    echo "args_p"
+    echo "args_ul"
+    echo "args_ol"
+    echo "args_pre"
+
+    #
+    # Blockquoted elements (single argument)
+    #
+    echo "blockquoted_h1"
+    echo "blockquoted_h2"
+    echo "blockquoted_h3"
+    echo "blockquoted_p"
+    echo "blockquoted_ul"
+    echo "blockquoted_ol"
+    echo "blockquoted_pre"
+
+    #
+    # Pairs of element types
+    #
+    echo "pair_h1_h2"
+    echo "pair_h1_p"
+    echo "pair_p_ol"
+    echo "pair_p_ul"
+    echo "pair_p_pre"
+
+    #
+    # Nested pairs of element types
+    #
+    echo "nest_ol_ol"
+    echo "nest_ol_ul"
+    echo "nest_ol_p"
+    echo "nest_ol_pre"
+    echo "nest_ul_ol"
+    echo "nest_ul_ul"
+    echo "nest_ul_p"
+    echo "nest_ul_pre"
+
+    #
+    # A more full-fletched example
+    #
+    echo "doc_egg"
+
+}
+
+lipsum() {
+    case $elm in
+        p|ol|ul)
+            echo -n \
+                "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed" \
+                " do eiusmod tempor incididunt ut labore et dolore magna aliqua." \
+                " Ut enim ad minim veniam, quis nostrud exercitation ullamco" \
+                " laboris nisi ut aliquip ex ea commodo consequat. Duis aute" \
+                " irure dolor in reprehenderit in voluptate velit esse cillum" \
+                " dolore eu fugiat nulla pariatur. Excepteur sint occaecat" \
+                " cupidatat non proident, sunt in culpa qui officia deserunt" \
+                " mollit anim id est laborum."
+                ;;
+        h*)
+            echo "How did I grow my rhino nose"
+            ;;
+        pre)
+            echo 'found = False'
+            echo 'for x in sequence:'
+            echo '    if pred(x.n):'
+            echo '        found = True'
+            echo 'if found:'
+            echo '    ...'
+            ;;
+    esac
+}
+
+do_mdfmt() {
+    #
+    #
+    #
+    local elm=$1
+    local pass=$2
+    local nest=$3
+    local args=()
+    local frags=()
+    test -n "$nest" && args=( --nest "$nest" )
+    case $name in
+        blockquoted_*) args+=( --quote )
+    esac
+    case $pass in
+        line2frag)
+            IFS=$'\n' frags=( $(lipsum) )
+            ;;
+        single)
+            frags=("$(lipsum)")
+            ;;
+    esac
+    args+=( "$elm" "${frags[@]}")
+    mdfmt "${args[@]}"
+}
+
+
+mkresult() {
+    local elm elm1 elm2 elms
+    case $name in
+
+        single_*)
+            elm=${name#single_}
+            do_mdfmt "$elm" single
+            ;;
+
+        args_*)
+            elm=${name#args_}
+            do_mdfmt "$elm" line2frag
+            ;;
+
+        blockquoted_*)
+            elm=${name#blockquoted_}
+            do_mdfmt "$elm" single
+            ;;
+
+        pair_*)
+            local elms=${name#pair_}
+            local elm1=${elms%_*}
+            local elm2=${elms#*_}
+            do_mdfmt "$elm1" line2frag
+            do_mdfmt "$elm2" line2frag
+            ;;
+
+        nest_*)
+            local elms=${name#nest_}
+            local elm1=${elms%_*}
+            local elm2=${elms#*_}
+            do_mdfmt "$elm1" line2frag
+            do_mdfmt "$elm2" line2frag 1
+            ;;
+
+        doc_egg)
+            mdfmt h1 "how to boil an egg"
+            mdfmt p  "this tutorial shows you how to boil an egg" \
+                     "the best way possible"
+            mdfmt h2 "variant 1"
+            mdfmt ol "take egg"
+            mdfmt ol "put it in a pot full of water"
+            mdfmt ol "place pot onto stove"
+            mdfmt ol "turn on stove"
+            mdfmt ol "wait"
+            mdfmt --nest 1 ul "for soft-boiled, wait 3 minutes"
+            mdfmt --nest 2 ol "wait first minute"
+            mdfmt --nest 2 ol "wait second minute"
+            mdfmt --nest 2 ol "wait third minute"
+            mdfmt --nest 1 ul "for hard-boiled, wait 10 minutes"
+            mdfmt ol "turn off the stove"
+            mdfmt ol "replace water with cold water "
+            mdfmt ol "break and replace shell from the egg"
+            mdfmt h2 "variant 1"
+            mdfmt ol "start your favorite browser"
+            mdfmt ol "open youtube:"
+            mdfmt --nest 1 pre "https://www.youtube.com/"
+            mdfmt ol "enter following text in Search box:"
+            mdfmt --nest 1 pre "how to boil an egg"
+            mdfmt ol "watch at least 5 videos"
+            mdfmt ol "go to the closest restaurant and ask for" \
+                      "a boiled egg"
+            mdfmt h2 "conclusion"
+            mdfmt p  "We hope you enjoy the egg. Seriously."
+            mdfmt h2 "references"
+            mdfmt p "This is what fsumsal said about it:"
+            mdfmt -q p "OK.  I feel honored by inclusion in the test."
+            mdfmt p "A more thorough review by mr. knowitalmostall:"
+            mdfmt -q p "The egg was good, except"
+            mdfmt -q ul "the shell could have been softer,"
+            mdfmt -q ul "the yolk could have been harder,"
+            mdfmt -q ul "the white could have been yellower."
+            mdfmt -q p "Overall, I liked it."
+            mdfmt p "(It's worth noting that mr. knowitalmostall does not work" \
+                    "in the egg review business anymore.)"
+            ;;
+
+    esac
+}
+
+tf_do_subtest() {
+    local name=$1
+    tf_testflt -n "$name" -O "oracle/$name.stdout" "mkresult"
+}
+
+tf_do_subtests

tests/mdfmt/oracle/args_h1.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+============================

tests/mdfmt/oracle/args_h2.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+----------------------------

tests/mdfmt/oracle/args_h3.stdout

@@ -0,0 +1,3 @@
+
+
+### How did I grow my rhino nose ###

tests/mdfmt/oracle/args_ol.stdout

@@ -0,0 +1,8 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/args_p.stdout

@@ -0,0 +1,8 @@
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.

tests/mdfmt/oracle/args_pre.stdout

@@ -0,0 +1,7 @@
+
+    found = False
+    for x in sequence:
+        if pred(x.n):
+            found = True
+    if found:
+        ...

tests/mdfmt/oracle/args_ul.stdout

@@ -0,0 +1,8 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/blockquoted_h1.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+============================

tests/mdfmt/oracle/blockquoted_h2.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+----------------------------

tests/mdfmt/oracle/blockquoted_h3.stdout

@@ -0,0 +1,3 @@
+
+
+### How did I grow my rhino nose ###

tests/mdfmt/oracle/blockquoted_ol.stdout

@@ -0,0 +1,8 @@
+> 
+>  1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+>     tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+>     veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+>     ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+>     voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+>     sint occaecat  cupidatat non proident, sunt in culpa qui officia
+>     deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/blockquoted_p.stdout

@@ -0,0 +1,8 @@
+> 
+> Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+> tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+> veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+> commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+> velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+> occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+> mollit anim id est laborum.

tests/mdfmt/oracle/blockquoted_pre.stdout

@@ -0,0 +1,7 @@
+> 
+>     found = False
+>     for x in sequence:
+>         if pred(x.n):
+>             found = True
+>     if found:
+>         ...

tests/mdfmt/oracle/blockquoted_ul.stdout

@@ -0,0 +1,8 @@
+> 
+>  *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+>     tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+>     veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+>     ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+>     voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+>     sint occaecat  cupidatat non proident, sunt in culpa qui officia
+>     deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/doc_egg.stdout

@@ -0,0 +1,83 @@
+
+
+how to boil an egg
+==================
+
+this tutorial shows you how to boil an egg the best way possible
+
+
+variant 1
+---------
+
+ 1. take egg
+
+ 1. put it in a pot full of water
+
+ 1. place pot onto stove
+
+ 1. turn on stove
+
+ 1. wait
+    
+     *  for soft-boiled, wait 3 minutes
+        
+         1. wait first minute
+        
+         1. wait second minute
+        
+         1. wait third minute
+    
+     *  for hard-boiled, wait 10 minutes
+
+ 1. turn off the stove
+
+ 1. replace water with cold water
+
+ 1. break and replace shell from the egg
+
+
+variant 1
+---------
+
+ 1. start your favorite browser
+
+ 1. open youtube:
+    
+        https://www.youtube.com/
+
+ 1. enter following text in Search box:
+    
+        how to boil an egg
+
+ 1. watch at least 5 videos
+
+ 1. go to the closest restaurant and ask for a boiled egg
+
+
+conclusion
+----------
+
+We hope you enjoy the egg. Seriously.
+
+
+references
+----------
+
+This is what fsumsal said about it:
+> 
+> OK.  I feel honored by inclusion in the test.
+
+A more thorough review by mr. knowitalmostall:
+> 
+> The egg was good, except
+> 
+>  *  the shell could have been softer,
+> 
+>  *  the yolk could have been harder,
+> 
+>  *  the white could have been yellower.
+> 
+> Overall, I liked it.
+
+(It's worth noting that mr. knowitalmostall does not work in the egg
+review business anymore.)

tests/mdfmt/oracle/nest_ol_ol.stdout

@@ -0,0 +1,16 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+     1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do
+        eiusmod tempor incididunt ut labore et dolore magna aliqua.
+        Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+        nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+        in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+        nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+        sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/nest_ol_p.stdout

@@ -0,0 +1,16 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
+    do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+    Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+    nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+    in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+    nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+    sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/nest_ol_pre.stdout

@@ -0,0 +1,15 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+        found = False
+        for x in sequence:
+            if pred(x.n):
+                found = True
+        if found:
+            ...

tests/mdfmt/oracle/nest_ol_ul.stdout

@@ -0,0 +1,16 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+     *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do
+        eiusmod tempor incididunt ut labore et dolore magna aliqua.
+        Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+        nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+        in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+        nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+        sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/nest_ul_ol.stdout

@@ -0,0 +1,16 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+     1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do
+        eiusmod tempor incididunt ut labore et dolore magna aliqua.
+        Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+        nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+        in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+        nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+        sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/nest_ul_p.stdout

@@ -0,0 +1,16 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+    Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed
+    do eiusmod tempor incididunt ut labore et dolore magna aliqua.
+    Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+    nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+    in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+    nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+    sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/nest_ul_pre.stdout

@@ -0,0 +1,15 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+        found = False
+        for x in sequence:
+            if pred(x.n):
+                found = True
+        if found:
+            ...

tests/mdfmt/oracle/nest_ul_ul.stdout

@@ -0,0 +1,16 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.
+    
+     *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do
+        eiusmod tempor incididunt ut labore et dolore magna aliqua.
+        Ut enim ad minim veniam, quis nostrud exercitation ullamco  laboris
+        nisi ut aliquip ex ea commodo consequat. Duis aute  irure dolor
+        in reprehenderit in voluptate velit esse cillum  dolore eu fugiat
+        nulla pariatur. Excepteur sint occaecat  cupidatat non proident,
+        sunt in culpa qui officia deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/pair_h1_h2.stdout

@@ -0,0 +1,8 @@
+
+
+How did I grow my rhino nose
+============================
+
+
+How did I grow my rhino nose
+----------------------------

tests/mdfmt/oracle/pair_h1_p.stdout

@@ -0,0 +1,12 @@
+
+
+How did I grow my rhino nose
+============================
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.

tests/mdfmt/oracle/pair_p_ol.stdout

@@ -0,0 +1,16 @@
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/pair_p_pre.stdout

@@ -0,0 +1,15 @@
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.
+
+    found = False
+    for x in sequence:
+        if pred(x.n):
+            found = True
+    if found:
+        ...

tests/mdfmt/oracle/pair_p_ul.stdout

@@ -0,0 +1,16 @@
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/single_h1.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+============================

tests/mdfmt/oracle/single_h2.stdout

@@ -0,0 +1,4 @@
+
+
+How did I grow my rhino nose
+----------------------------

tests/mdfmt/oracle/single_h3.stdout

@@ -0,0 +1,3 @@
+
+
+### How did I grow my rhino nose ###

tests/mdfmt/oracle/single_ol.stdout

@@ -0,0 +1,8 @@
+
+ 1. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/mdfmt/oracle/single_p.stdout

@@ -0,0 +1,8 @@
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip ex ea
+commodo consequat. Duis aute  irure dolor in reprehenderit in voluptate
+velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur sint
+occaecat  cupidatat non proident, sunt in culpa qui officia deserunt
+mollit anim id est laborum.

tests/mdfmt/oracle/single_pre.stdout

@@ -0,0 +1,7 @@
+
+    found = False
+    for x in sequence:
+        if pred(x.n):
+            found = True
+    if found:
+        ...

tests/mdfmt/oracle/single_ul.stdout

@@ -0,0 +1,8 @@
+
+ *  Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed  do eiusmod
+    tempor incididunt ut labore et dolore magna aliqua.  Ut enim ad minim
+    veniam, quis nostrud exercitation ullamco  laboris nisi ut aliquip
+    ex ea commodo consequat. Duis aute  irure dolor in reprehenderit in
+    voluptate velit esse cillum  dolore eu fugiat nulla pariatur. Excepteur
+    sint occaecat  cupidatat non proident, sunt in culpa qui officia
+    deserunt  mollit anim id est laborum.

tests/shellfu_api/oracle/functions.stdout

@@ -42,6 +42,12 @@ inigrep._inigrep__fltsct
 inigrep._inigrep__query
 inigrep._inigrep__validate_ks
 inigrep.inigrep
+mdfmt._mdfmt__fmttype
+mdfmt._mdfmt__indent
+mdfmt._mdfmt__join
+mdfmt._mdfmt__quote
+mdfmt._mdfmt__width
+mdfmt.mdfmt
 pretty.__shellfu_pretty__init
 pretty._pretty__cat
 pretty._pretty__echo

tests/shellfu_api/oracle/modules.stdout

@@ -6,6 +6,7 @@ _pretty_plain
 charmenu
 exit
 inigrep
+mdfmt
 pretty
 sync
 termcolors

tests/shellfu_api/oracle/variables.stdout

@@ -10,6 +10,7 @@ exit.EXIT_NO
 exit.EXIT_OK
 exit.EXIT_PANIC
 exit.EXIT_USAGE
+mdfmt.MDFMT_WIDTH
 pretty.PRETTY
 pretty.PRETTY_DEBUG
 pretty.PRETTY_DEBUG_EXCLUDE