feat: reverse listing order option

npryce#128

Author: nikcorg

src/_adr_generate_toc

@@ -9,22 +9,27 @@ eval "$("$(dirname "$0")"/adr-config)"
 ## Options:
 ##
 ## -s        include the state of each decision next to its link.
-## -i INTRO  precede the table of contents with text from the INTRO file.
-## -o OUTRO  follow the table of contents with text from the given OUTRO file.
+## -i INTRO  precede the table of contents with the given INTRO text.
+## -o OUTRO  follow the table of contents with the given OUTRO text.
 ## -p LINK_PREFIX
 ##           prefix each decision file link with LINK_PREFIX.
+## -r        list the records in reverse order
 ##
 ## Both INTRO and OUTRO must be in Markdown format.
 
 link_prefix=
 output_status=
+list_args=()
 
-while getopts si:o:p: arg; do
+while getopts rsi:o:p: arg; do
   case "$arg" in
   s)
     output_status=1
     shift
     ;;
+  r)
+    list_args+=("-r")
+    ;;
   i)
     intro="$OPTARG"
     ;;
@@ -42,13 +47,12 @@ cat <<EOF
 
 EOF
 
-if [ -n "$intro" ]
-then
-    cat "$intro"
-    echo
+if [ -n "$intro" ]; then
+  cat "$intro"
+  echo
 fi
 
-for f in $("$adr_bin_dir/adr-list"); do
+for f in $("$adr_bin_dir/adr-list" "${list_args[@]}"); do
   title=$("$adr_bin_dir/_adr_title" "$f")
   link=${link_prefix}$(basename "$f")
   status=
@@ -68,4 +72,3 @@ if [ ! -z "$outro" ]; then
   echo
   cat "$outro"
 fi
-

src/adr-list

@@ -2,15 +2,37 @@
 set -e
 eval "$("$(dirname "$0")"/adr-config)"
 
-## usage: adr list
+## usage: adr list [-r]
 ##
 ## Lists the architecture decision records
+##
+## Options:
+##
+## -r        list decision records in reverse order
 
 adr_dir="$("$adr_bin_dir/_adr_dir")"
 
+sort_args=()
+
+if (( $# > 0 )); then
+   while getopts ":r" arg; do
+       case "${arg}" in
+           r)
+             sort_args+=("-r")
+             ;;
+
+           *)
+             echo "invalid argument: $OPTARG" >&2
+             exit 1
+             ;;
+       esac
+   done
+   shift $((OPTIND-1))
+fi
+
 if [ -d "$adr_dir" ]
 then
-   find "$adr_dir" -maxdepth 1 -type f | grep -E "^.{${#adr_dir}}/[0-9]*[1-9][0-9]*-[^/]*\\.md$" | sort
+   find "$adr_dir" | grep -E "^$adr_dir/[0-9]+-[^/]*\\.md" | sort "${sort_args[@]}"
 else
     echo "The $adr_dir directory does not exist"
     exit 1

tests/generate-contents.expected

@@ -10,3 +10,9 @@ adr generate toc
 * [1. First Decision](0001-first-decision.md)
 * [2. Second Decision](0002-second-decision.md)
 * [3. Third Decision](0003-third-decision.md)
+adr generate toc -r
+# Architecture Decision Records
+
+* [3. Third Decision](0003-third-decision.md)
+* [2. Second Decision](0002-second-decision.md)
+* [1. First Decision](0001-first-decision.md)

tests/generate-contents.sh

@@ -2,3 +2,4 @@ adr new First Decision
 adr new Second Decision
 adr new Third Decision
 adr generate toc
+adr generate toc -r

tests/list-records.expected

@@ -15,4 +15,7 @@ adr list
 doc/adr/0001-first.md
 doc/adr/0002-second.md
 doc/adr/0003-third.md
-
+adr list -r
+doc/adr/0003-third.md
+doc/adr/0002-second.md
+doc/adr/0001-first.md

tests/list-records.sh

@@ -5,4 +5,4 @@ adr new second
 adr list
 adr new third
 adr list
-
+adr list -r