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/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/t1950-report.sh

@@ -1,91 +0,0 @@
-#!/bin/sh
-
-test_description='report functionality
-
-This test checks the reporting and the format of the report file.
-'
-. ./test-lib.sh
-
-cat > todo.txt <<EOF
-(B) smell the uppercase Roses +flowers @outside
-stop and think
-smell the coffee +wakeup
-make the coffee +wakeup
-visit http://example.com
-EOF
-
-test_todo_session 'create new report' <<EOF
->>> todo.sh report
-2009-02-13T04:40:00 5 0
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-4 make the coffee +wakeup
-3 smell the coffee +wakeup
-2 stop and think
-5 visit http://example.com
---
-TODO: 5 of 5 tasks shown
-EOF
-
-test_todo_session 'report of done tasks' <<EOF
->>> todo.sh -A do 3
-3 x 2009-02-13 smell the coffee +wakeup
-TODO: 3 marked as done.
-x 2009-02-13 smell the coffee +wakeup
-TODO: $HOME/todo.txt archived.
-
->>> todo.sh report
-2009-02-13T04:40:00 4 1
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-3 make the coffee +wakeup
-2 stop and think
-4 visit http://example.com
---
-TODO: 4 of 4 tasks shown
-EOF
-
-test_todo_session 'report performs archiving' <<EOF
->>> todo.sh -a do 3
-3 x 2009-02-13 make the coffee +wakeup
-TODO: 3 marked as done.
-
->>> todo.sh report
-2009-02-13T04:40:00 3 2
-TODO: Report file updated.
-
->>> todo.sh -p list
-1 (B) smell the uppercase Roses +flowers @outside
-2 stop and think
-3 visit http://example.com
---
-TODO: 3 of 3 tasks shown
-
->>> todo.sh -p listfile done.txt
-2 x 2009-02-13 make the coffee +wakeup
-1 x 2009-02-13 smell the coffee +wakeup
---
-DONE: 2 of 2 tasks shown
-EOF
-
-test_todo_session 'report is unchanged when no changes' <<EOF
->>> cat report.txt
-2009-02-13T04:40:00 5 0
-2009-02-13T04:40:00 4 1
-2009-02-13T04:40:00 3 2
-
->>> todo.sh report
-2009-02-13T04:40:00 3 2
-TODO: Report file is up-to-date.
-
->>> cat report.txt
-2009-02-13T04:40:00 5 0
-2009-02-13T04:40:00 4 1
-2009-02-13T04:40:00 3 2
-EOF
-
-test_done

tests/t9999-testsuite_example.sh

@@ -85,8 +85,13 @@ TODO: $HOME/todo.txt archived.
 TODO: 5 of 5 tasks shown
 
 >>> todo.sh report
-2009-02-13T04:40:00 5 1
 TODO: Report file updated.
+2009-02-13-04:40:00 5 1
+
+>>> todo.sh report
+TODO: Report file updated.
+2009-02-13-04:40:00 5 1
+2009-02-13-04:40:00 5 1
 
 >>> todo.sh append g a
 usage: todo.sh append ITEM# "TEXT TO APPEND"

todo.sh

@@ -812,8 +812,9 @@ _list() {
             }
           '''  \
         | sed '''
-            s/'${HIDE_PROJECTS_SUBSTITUTION:-^}'//g
+            s/'"${HIDE_PROJECTS_SUBSTITUTION:-^}"'//g
-            s/'${HIDE_CONTEXTS_SUBSTITUTION:-^}'//g
+            s/'"${HIDE_CONTEXTS_SUBSTITUTION:-^}"'//g
+            s/'"${HIDE_CUSTOM_SUBSTITUTION:-^}"'//g
           '''                                                   \
         | eval ${TODOTXT_FINAL_FILTER}                          \
     )
@@ -1191,20 +1192,18 @@ note: PRIORITY must be anywhere from A to Z."
     sed '/^x /!d' "$TODO_FILE" >> "$DONE_FILE"
     sed -i.bak '/^x /d' "$TODO_FILE"
 
+    NUMLINES=$( sed -n '$ =' "$TODO_FILE" )
+    if [ ${NUMLINES:-0} = "0" ]; then
+         echo "datetime todos dones" >> "$REPORT_FILE"
+    fi
+    #now report
     TOTAL=$( sed -n '$ =' "$TODO_FILE" )
     TDONE=$( sed -n '$ =' "$DONE_FILE" )
-    NEWDATA="${TOTAL:-0} ${TDONE:-0}"
+    TECHO=$(echo $(date +%Y-%m-%d-%T); echo ' '; echo ${TOTAL:-0}; echo ' ';
-    LASTREPORT=$(sed -ne '$p' "$REPORT_FILE")
+    echo ${TDONE:-0})
-    LASTDATA=${LASTREPORT#* }   # Strip timestamp.
+    echo $TECHO >> "$REPORT_FILE"
-    if [ "$LASTDATA" = "$NEWDATA" ]; then
+    [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-        echo "$LASTREPORT"
+    cat "$REPORT_FILE"
-        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file is up-to-date."
-    else
-        NEWREPORT="$(date +%Y-%m-%dT%T) ${NEWDATA}"
-        echo "${NEWREPORT}" >> "$REPORT_FILE"
-        echo "${NEWREPORT}"
-        [ $TODOTXT_VERBOSE -gt 0 ] && echo "TODO: Report file updated."
-    fi
     ;;
 
 * )