bf1bf1ae84
* ENH: Allow to customize what can be before / inside / after +project and @context
I noticed that todo.sh mistakenly picks up some random stuff as projects and contexts. The todo.txt specification is very lenient in what makes those (allowing any length of non-whitespace characters), but in practice, every user has its own idea of the set of used words. This change allows (expert) users to tweak the pattern (via TODOTXT_SIGIL_VALID_PATTERN), to be able to reduce the amount of "false positives" that listproj and listcon show.
Additionally, there's a (mainly unspecified) extension mechanism in the form of key:value, which often is used to implement custom "markers", like w:something to make a task blocked and waiting for "something". It would be nice to be able to refer to @contexts (and maybe also +projects), but the default syntax (which requires whitespace around those) doesn't allow it, and these context then don't show up in searches, which is unfortunate. The added TODOTXT_SIGIL_BEFORE_PATTERN and TODOTXT_SIGIL_AFTER_PATTERN allow to tweak the syntax to accommodate this.
The implementation just exchanges grep with a corresponding sed pipeline step, which shouldn't negatively affect the performance at all (as sed is one of the main commands used thoughout the script), but which allows for the additional matching flexibility.
* FIX: Compatibility: sed \? multi not supported on MacOS
Use the POSIX \{0,1\} instead.
* FIX: Compatibility: sed \| multi not supported on MacOS
Concatenate both alternatives as optional matches; this is only an approximation but satisfies the test case here. It would probably be better if the entire sed code used extended regular expression syntax (-E) instead of basic ones (-e), but that change would also affect all add-ons. As this is an optional customization feature, uses who really need this either also have to work around, or supply a GNU sed port on MacOS.
* FIX: Compatibility: sed \+ multi not supported on MacOS
Use the POSIX \{1,\} instead.
Co-authored-by: Ali Karbassi <ali@karbassi.com>
129 lines
2.8 KiB
Bash
Executable File
129 lines
2.8 KiB
Bash
Executable File
#!/bin/bash
|
|
#
|
|
|
|
test_description='listcon functionality
|
|
|
|
This test checks basic context listing functionality
|
|
'
|
|
. ./test-lib.sh
|
|
|
|
cat > todo.txt <<EOF
|
|
item 1
|
|
item 2
|
|
item 3
|
|
EOF
|
|
test_expect_success 'listcon no contexts' '
|
|
todo.sh listcon > output && ! test -s output
|
|
'
|
|
|
|
cat > todo.txt <<EOF
|
|
(A) @1 -- Some context 1 task, whitespace, one char
|
|
(A) @c2 -- Some context 2 task, whitespace, two char
|
|
@con03 -- Some context 3 task, no whitespace
|
|
@con04 -- Some context 4 task, no whitespace
|
|
@con05@con06 -- weird context
|
|
EOF
|
|
test_todo_session 'Single context per line' <<EOF
|
|
>>> todo.sh listcon
|
|
@1
|
|
@c2
|
|
@con03
|
|
@con04
|
|
@con05@con06
|
|
EOF
|
|
|
|
cat > todo.txt <<EOF
|
|
@con01 -- Some context 1 task
|
|
@con02 -- Some context 2 task
|
|
@con02 @con03 -- Multi-context task
|
|
EOF
|
|
test_todo_session 'Multi-context per line' <<EOF
|
|
>>> todo.sh listcon
|
|
@con01
|
|
@con02
|
|
@con03
|
|
EOF
|
|
|
|
cat > todo.txt <<EOF
|
|
@con01 -- Some context 1 task
|
|
@con02 -- Some context 2 task
|
|
@con02 ginatrapani@gmail.com -- Some context 2 task
|
|
EOF
|
|
test_todo_session 'listcon e-mail address test' <<EOF
|
|
>>> todo.sh listcon
|
|
@con01
|
|
@con02
|
|
EOF
|
|
|
|
cat > todo.txt <<EOF
|
|
(B) smell the uppercase Roses +roses @outside +shared
|
|
(C) notice the sunflowers +sunflowers @garden +shared +landscape
|
|
stop
|
|
EOF
|
|
test_todo_session 'listcon with project' <<EOF
|
|
>>> todo.sh listcon +landscape
|
|
@garden
|
|
EOF
|
|
|
|
cat > todo.txt <<EOF
|
|
(B) +math (@school or @home) integrate @x and @y
|
|
(C) say thanks @GinaTrapani w:@OtherContributors
|
|
stop
|
|
EOF
|
|
test_todo_session 'listcon with default configuration' <<EOF
|
|
>>> todo.sh listcon
|
|
@GinaTrapani
|
|
@home)
|
|
@x
|
|
@y
|
|
EOF
|
|
test_todo_session 'listcon limiting to multi-character sequences' <<EOF
|
|
>>> TODOTXT_SIGIL_VALID_PATTERN='.\{2,\}' todo.sh listcon
|
|
@GinaTrapani
|
|
@home)
|
|
EOF
|
|
test_todo_session 'listcon allowing w: marker before contexts' <<EOF
|
|
>>> TODOTXT_SIGIL_BEFORE_PATTERN='\(w:\)\{0,1\}' todo.sh listcon
|
|
@GinaTrapani
|
|
@OtherContributors
|
|
@home)
|
|
@x
|
|
@y
|
|
EOF
|
|
test_todo_session 'listcon allowing parentheses around contexts' <<EOF
|
|
>>> TODOTXT_SIGIL_BEFORE_PATTERN='(\{0,1\}' TODOTXT_SIGIL_AFTER_PATTERN=')\{0,1\}' todo.sh listcon
|
|
@GinaTrapani
|
|
@home
|
|
@school
|
|
@x
|
|
@y
|
|
EOF
|
|
test_todo_session 'listcon with all customizations combined' <<EOF
|
|
>>> TODOTXT_SIGIL_VALID_PATTERN='.\{2,\}' TODOTXT_SIGIL_BEFORE_PATTERN='\(w:\)\{0,1\}\((\)\{0,1\}' TODOTXT_SIGIL_AFTER_PATTERN=')\{0,1\}' todo.sh listcon
|
|
@GinaTrapani
|
|
@OtherContributors
|
|
@home
|
|
@school
|
|
EOF
|
|
|
|
cat > todo.txt <<EOF
|
|
@con01 -- Some context 1 task
|
|
EOF
|
|
cat > done.txt <<EOF
|
|
x 2012-02-21 @done01 -- Some context 1 done task
|
|
x 2012-02-21 @done02 -- Some context 2 done task
|
|
EOF
|
|
test_todo_session 'listcon from done tasks' <<'EOF'
|
|
>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listcon
|
|
@done01
|
|
@done02
|
|
EOF
|
|
test_todo_session 'listcon from combined open + done tasks' <<'EOF'
|
|
>>> TODOTXT_SOURCEVAR='("$TODO_FILE" "$DONE_FILE")' todo.sh listcon
|
|
@con01
|
|
@done01
|
|
@done02
|
|
EOF
|
|
|
|
test_done
|