Add HIDE_CUSTOM_SUBSTITUTION for customization and add-ons.

Add-ons or users may want to hide parts of the task text from the output.
Though this can already be solved through TODOTXT_FINAL_FILTER, augmenting the configured value is not trivial, and it introduces another SED command into the already long _list() pipeline. Putting an additional HIDE_CUSTOM_SUBSTITUTION into the existing pipeline has hardly any performance implications, and makes the realization of this use case trivial.

tests/t0001-null.sh

@@ -45,8 +45,6 @@ test_expect_success 'null listpri a' '
 cat > expect <<EOF
 --
 TODO: 0 of 0 tasks shown
-DONE: 0 of 0 tasks shown
-total 0 of 0 tasks shown
 EOF
 
 test_expect_success 'null lsa' '

tests/t1300-ls.sh

@@ -53,6 +53,18 @@ test_todo_session 'checking TODOTXT_FINAL_FILTER' <<EOF
 TODO: 3 of 3 tasks shown
 EOF
 
+#
+# check the custom hiding
+#
+test_todo_session 'checking HIDE_CUSTOM_SUBSTITUTION' <<EOF
+>>> HIDE_CUSTOM_SUBSTITUTION='[tT]h' todo.sh ls
+2 aaa zzz is line should be first.
+3 bbb yyy is line should be second.
+1 ccc xxx is line should be ird.
+--
+TODO: 3 of 3 tasks shown
+EOF
+
 #
 # check the filtering of TERM
 #

tests/t1350-listall.sh

@@ -1,150 +0,0 @@
-#!/bin/sh
-
-test_description='listall functionality
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-smell the uppercase Roses +flowers @outside
-x 2011-08-08 tend the garden @outside
-notice the sunflowers
-x 2011-12-26 go outside +wakeup
-(A) stop
-EOF
-cat > done.txt <<EOF
-x 2011-12-01 eat breakfast
-x 2011-12-05 smell the coffee +wakeup
-EOF
-
-test_todo_session 'basic listall' <<EOF
->>> todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 2 of 2 tasks shown
-total 7 of 7 tasks shown
-EOF
-
-test_todo_session 'listall highlighting' <<EOF
->>> todo.sh listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 2 of 2 tasks shown
-total 7 of 7 tasks shown
-EOF
-
-test_todo_session 'listall nonverbose' <<EOF
->>> TODOTXT_VERBOSE=0 todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
-EOF
-
-test_todo_session 'listall filtering' <<EOF
->>> todo.sh -p listall @outside
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
---
-TODO: 2 of 5 tasks shown
-DONE: 0 of 2 tasks shown
-total 2 of 7 tasks shown
-
->>> todo.sh -p listall the
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-05 smell the coffee +wakeup
---
-TODO: 3 of 5 tasks shown
-DONE: 1 of 2 tasks shown
-total 4 of 7 tasks shown
-
->>> todo.sh -p listall breakfast
-0 x 2011-12-01 eat breakfast
---
-TODO: 0 of 5 tasks shown
-DONE: 1 of 2 tasks shown
-total 1 of 7 tasks shown
-
->>> todo.sh -p listall doesnotmatch
---
-TODO: 0 of 5 tasks shown
-DONE: 0 of 2 tasks shown
-total 0 of 7 tasks shown
-EOF
-
-cat >> done.txt <<EOF
-x 2010-01-01 old task 1
-x 2010-01-01 old task 2
-x 2010-01-01 old task 3
-x 2010-01-01 old task 4
-EOF
-test_todo_session 'listall number width' <<EOF
->>> todo.sh -p listall
-5 (A) stop
-3 notice the sunflowers
-1 smell the uppercase Roses +flowers @outside
-0 x 2010-01-01 old task 1
-0 x 2010-01-01 old task 2
-0 x 2010-01-01 old task 3
-0 x 2010-01-01 old task 4
-2 x 2011-08-08 tend the garden @outside
-0 x 2011-12-01 eat breakfast
-0 x 2011-12-05 smell the coffee +wakeup
-4 x 2011-12-26 go outside +wakeup
---
-TODO: 5 of 5 tasks shown
-DONE: 6 of 6 tasks shown
-total 11 of 11 tasks shown
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 1
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 2
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 3
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 4
-
->>> TODOTXT_VERBOSE=0 todo.sh add new task 5
-
->>> todo.sh -p listall
-05 (A) stop
-06 new task 1
-07 new task 2
-08 new task 3
-09 new task 4
-10 new task 5
-03 notice the sunflowers
-01 smell the uppercase Roses +flowers @outside
-00 x 2010-01-01 old task 1
-00 x 2010-01-01 old task 2
-00 x 2010-01-01 old task 3
-00 x 2010-01-01 old task 4
-02 x 2011-08-08 tend the garden @outside
-00 x 2011-12-01 eat breakfast
-00 x 2011-12-05 smell the coffee +wakeup
-04 x 2011-12-26 go outside +wakeup
---
-TODO: 10 of 10 tasks shown
-DONE: 6 of 6 tasks shown
-total 16 of 16 tasks shown
-EOF
-
-test_done

todo.sh

@@ -812,8 +812,9 @@ _list() {
             }
           '''  \
         | sed '''
-            s/'${HIDE_PROJECTS_SUBSTITUTION:-^}'//g
-            s/'${HIDE_CONTEXTS_SUBSTITUTION:-^}'//g
+            s/'"${HIDE_PROJECTS_SUBSTITUTION:-^}"'//g
+            s/'"${HIDE_CONTEXTS_SUBSTITUTION:-^}"'//g
+            s/'"${HIDE_CUSTOM_SUBSTITUTION:-^}"'//g
           '''                                                   \
         | eval ${TODOTXT_FINAL_FILTER}                          \
     )
@@ -1068,20 +1069,7 @@ case $action in
     shift  ## Was lsa; new $1 is first search term
 
     cat "$TODO_FILE" "$DONE_FILE" > "$TMP_FILE"
-    TOTAL=$( sed -n '$ =' "$TODO_FILE" )
-
-    post_filter_command="awk -v TOTAL=$TOTAL -v PADDING=${#TOTAL} '{ \$1 = sprintf(\"%\" PADDING \"d\", (\$1 > TOTAL ? 0 : \$1)); print }' "
-    TODOTXT_VERBOSE=0 _list "$TMP_FILE" "$@"
-
-    if [ $TODOTXT_VERBOSE -gt 0 ]; then
-        TDONE=$( sed -n '$ =' "$DONE_FILE" )
-        TASKNUM=$(TODOTXT_PLAIN=1 TODOTXT_VERBOSE=0 _list "$TODO_FILE" "$@" | sed -n '$ =')
-        DONENUM=$(TODOTXT_PLAIN=1 TODOTXT_VERBOSE=0 _list "$DONE_FILE" "$@" | sed -n '$ =')
-        echo "--"
-        echo "$(getPrefix "$TODO_FILE"): ${TASKNUM:-0} of ${TOTAL:-0} tasks shown"
-        echo "$(getPrefix "$DONE_FILE"): ${DONENUM:-0} of ${TDONE:-0} tasks shown"
-        echo "total $((TASKNUM + DONENUM)) of $((TOTAL + TDONE)) tasks shown"
-    fi
+    _list "$TMP_FILE" "$@"
     ;;
 
 "listfile" | "lf" )