Compare commits
102 Commits
archive/ri
...
develop
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8fed2da86f | ||
|
|
34b6135415 | ||
|
|
21f3a9da36 | ||
|
|
6e1003b51e | ||
|
|
3c2ad85b47 | ||
|
|
095bdb380a | ||
|
|
66634da336 | ||
|
|
a510598998 | ||
|
|
98141a6e36 | ||
|
|
2c279b65b1 | ||
|
|
837ce22937 | ||
|
|
7c92f46c25 | ||
|
|
07b50a07e0 | ||
|
|
745f5d5179 | ||
|
|
236069c519 | ||
|
|
e60c14ab2b | ||
|
|
33eb234048 | ||
|
|
42e7a079f8 | ||
|
|
1f410e4066 | ||
|
|
d8ceb46364 | ||
|
|
0d139d2027 | ||
|
|
07821f9cff | ||
|
|
2faf072cf7 | ||
|
|
ce365df67c | ||
|
|
93d8e16d50 | ||
|
|
111afe6958 | ||
|
|
92f7b724e6 | ||
|
|
629a301d43 | ||
|
|
4a7dd852a6 | ||
|
|
ec9613e19e | ||
|
|
79845c8eb1 | ||
|
|
b853198c3a | ||
|
|
e1d6b91fa3 | ||
|
|
8ff79102a5 | ||
|
|
8d8ef812a2 | ||
|
|
50aea1e4f0 | ||
|
|
da683366f4 | ||
|
|
e48ad81ecc | ||
|
|
7b5c983bb6 | ||
|
|
f67f630466 | ||
|
|
fe27b10765 | ||
|
|
c0c93c8c0c | ||
|
|
137140a542 | ||
|
|
322c6b95d6 | ||
|
|
28e8a4cd8b | ||
|
|
7f1bdbf3d9 | ||
|
|
a5481990fd | ||
|
|
38d75afeff | ||
|
|
6473802644 | ||
|
|
6a3ddad787 | ||
|
|
7acb521190 | ||
|
|
f2b9734047 | ||
|
|
97035d3425 | ||
|
|
99e5e57a75 | ||
|
|
42424d5881 | ||
|
|
7ab90476f7 | ||
|
|
fac5533b96 | ||
|
|
736e69bd6c | ||
|
|
d2c44e9ffe | ||
|
|
f45bbd1a1d | ||
|
|
e0b93e48fb | ||
|
|
24d0fb003a | ||
|
|
3b0309d9bc | ||
|
|
b21d16878f | ||
|
|
3e82f3ca56 | ||
|
|
e5e31b0f75 | ||
|
|
35f9c4276c | ||
|
|
661dac0cfb | ||
|
|
d7056c5e1e | ||
|
|
92322e7064 | ||
|
|
ebe6a403c8 | ||
|
|
a6fed991e5 | ||
|
|
94f770926b | ||
|
|
322f3075d2 | ||
|
|
bc81db2f2b | ||
|
|
6259cdb6da | ||
|
|
f76b6d5210 | ||
|
|
c1ad7f3560 | ||
|
|
a777b266ed | ||
|
|
ebce735d04 | ||
|
|
e5a308eb03 | ||
|
|
e600a2162b | ||
|
|
3d0a4d0b30 | ||
|
|
79f428779c | ||
|
|
c1dcd0ed78 | ||
|
|
c9d1993dc8 | ||
|
|
451dbdda6b | ||
|
|
060e81aa05 | ||
|
|
296bad334d | ||
|
|
3b90d09b27 | ||
|
|
46afb7f46a | ||
|
|
9e13dfd290 | ||
|
|
fbee428e75 | ||
|
|
3b960a2e3c | ||
|
|
ad1ca6c2c9 | ||
|
|
36e018fd86 | ||
|
|
74858365f6 | ||
|
|
dfec12e2a4 | ||
|
|
c31716af47 | ||
|
|
ebe9fb868b | ||
|
|
189779c6de | ||
|
|
516f806d58 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -1,3 +1,6 @@
|
||||
VERSION-FILE
|
||||
tests/test-results
|
||||
tests/trash\ directory.*
|
||||
done.txt
|
||||
report.txt
|
||||
todo.txt
|
||||
|
||||
6
.travis.yml
Normal file
6
.travis.yml
Normal file
@@ -0,0 +1,6 @@
|
||||
# Note: "shell" would be more appropriate
|
||||
language: python
|
||||
|
||||
install: make dist && sudo make install
|
||||
|
||||
script: make test
|
||||
97
CONTRIBUTING.md
Normal file
97
CONTRIBUTING.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Contributing
|
||||
|
||||
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
|
||||
|
||||
It's people like you that make [todo.txt] such a great tool.
|
||||
|
||||
The following is a set of guidelines for contributing to [todo.txt] and its packages. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
|
||||
|
||||
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
|
||||
|
||||
[todo.txt] is an open source project and we love to receive contributions from our community — you! There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into [todo.txt] itself.
|
||||
|
||||
Please, don't use the issue tracker for support questions. Check whether our [Gitter.im] channel can help with your issue. Stack Overflow is also worth considering.
|
||||
|
||||
# Ground Rules
|
||||
|
||||
## Responsibilities
|
||||
|
||||
- Be welcoming to newcomers and encourage diverse new contributors from all backgrounds. See our [Code of Conduct].
|
||||
- Ensure cross-platform compatibility for every change that's accepted. Windows, Mac, Linux.
|
||||
- Create issues for any major changes and enhancements that you wish to make. Discuss things transparently and get community feedback.
|
||||
- Don't add any classes to the codebase unless absolutely needed. Err on the side of using functions.
|
||||
- Keep feature versions as small as possible, preferably one new feature per version.
|
||||
|
||||
# Your First Contribution
|
||||
|
||||
Unsure where to begin contributing? You can start by looking through these beginner and help-wanted issues:
|
||||
|
||||
- Beginner issues - issues which should only require a few lines of code, and a test or two.
|
||||
- Help wanted issues - issues which should be a bit more involved than beginner issues.
|
||||
|
||||
Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
|
||||
|
||||
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first :smile_cat:
|
||||
|
||||
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
|
||||
|
||||
# Getting started
|
||||
|
||||
For something that is bigger than a one or two line fix:
|
||||
|
||||
1. Create your own fork of the code.
|
||||
1. Do the changes in your fork.
|
||||
1. If you like the change and think the project could use it:
|
||||
- Be sure you have followed the code style for the project.
|
||||
- Note the [Code of Conduct].
|
||||
|
||||
As a rule of thumb, changes are obvious fixes if they do not introduce any new functionality or creative thinking. As long as the change does not affect functionality, some likely examples include the following:
|
||||
|
||||
- Spelling / grammar fixes
|
||||
- Typo correction, white space and formatting changes
|
||||
- Comment clean up
|
||||
- Bug fixes that change default return values or error codes stored in constants
|
||||
- Adding logging messages or debugging output
|
||||
- Changes to ‘metadata’ files like .gitignore, build scripts, etc.
|
||||
- Moving source files from one directory or package to another
|
||||
|
||||
# How to report a bug
|
||||
|
||||
## Security Vulnerability
|
||||
|
||||
If you find a security vulnerability, do NOT open an issue. Get ahold of the maintainers personally.
|
||||
|
||||
In order to determine whether you are dealing with a security issue, ask yourself these two questions:
|
||||
|
||||
- Can I access something that's not mine, or something I shouldn't have access to?
|
||||
- Can I disable something for other people?
|
||||
|
||||
If the answer to either of those two questions are "yes", then you're probably dealing with a security issue. Note that even if you answer "no" to both questions, you may still be dealing with a security issue, so if you're unsure, just email us directly.
|
||||
|
||||
## Bug
|
||||
|
||||
When filing an issue, make sure to answer these five questions:
|
||||
|
||||
1. What version of shell are you using (`echo $0` or `$(echo $SHELL) --version)`)?
|
||||
1. What operating system and processor architecture are you using?
|
||||
1. What did you do?
|
||||
1. What did you expect to see?
|
||||
1. What did you see instead?
|
||||
|
||||
# How to suggest a feature or enhancement
|
||||
|
||||
The [todo.txt] philosophy is to provide a plain-text, software-agnostic way to keep track of your tasks.
|
||||
|
||||
If you find yourself wishing for a feature that doesn't exist, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that todo.txt-cli has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
|
||||
|
||||
# Code review process
|
||||
|
||||
The core team looks at Pull Requests on a regular basis. After feedback has been given we expect responses within two weeks. After two weeks we may close the pull request if it isn't showing any activity.
|
||||
|
||||
# Community
|
||||
|
||||
You can chat with the core team on https://gitter.im/todotxt/.
|
||||
|
||||
[todo.txt]: https://github.com/todotxt/
|
||||
[Code of Conduct]: /CODE_OF_CONDUCT.md
|
||||
[Gitter.im]: https://gitter.im/todotxt/
|
||||
8
Makefile
8
Makefile
@@ -1,6 +1,7 @@
|
||||
#
|
||||
# Makefile for todo.txt
|
||||
#
|
||||
INSTALL_DIR=/usr/local/bin
|
||||
|
||||
# Dynamically detect/generate version file as necessary
|
||||
# This file will define a variable called VERSION.
|
||||
@@ -29,7 +30,12 @@ dist: $(DISTFILES) todo.sh
|
||||
clean:
|
||||
rm -f $(DISTNAME).tar.gz $(DISTNAME).zip
|
||||
|
||||
|
||||
install:
|
||||
install --mode=755 todo.sh $(INSTALL_DIR)
|
||||
install --mode=644 todo_completion /etc/bash_completion.d/todo
|
||||
mkdir -p /etc/todo
|
||||
[ -e /etc/todo/config ] || \
|
||||
sed "s/^\(export[ \t]*TODO_DIR=\).*/\1~\/.todo/" todo.cfg > /etc/todo/config
|
||||
#
|
||||
# Testing
|
||||
#
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
h1. TODO.TXT Command Line Interface
|
||||
h1. TODO.TXT Command Line Interface !https://secure.travis-ci.org/ginatrapani/todo.txt-cli.png?branch=master(Build Status)!:http://travis-ci.org/ginatrapani/todo.txt-cli
|
||||
|
||||
A simple and extensible shell script for managing your todo.txt file.
|
||||
|
||||
@@ -23,5 +23,5 @@ h2. Quick Links
|
||||
* Licensed under the "GPL":http://www.gnu.org/copyleft/gpl.html
|
||||
* "Add-on Directory":https://github.com/ginatrapani/todo.txt-cli/wiki/Todo.sh-Add-on-Directory
|
||||
https://github.com/ginatrapani/todo.txt-cli/wiki/Creating-and-Installing-Add-ons
|
||||
* "Changelog":http://wiki.github.com/ginatrapani/todo.txt-cli/todosh-changelog
|
||||
* "Changelog":https://github.com/ginatrapani/todo.txt-cli/wiki/Todo.sh-Changelog
|
||||
* "Known Bugs":http://github.com/ginatrapani/todo.txt-cli/issues
|
||||
|
||||
29
tests/README
29
tests/README
@@ -125,10 +125,10 @@ Writing Tests
|
||||
-------------
|
||||
|
||||
The test script is written as a shell script. It should start
|
||||
with the standard "#!/bin/sh" with copyright notices, and an
|
||||
with the standard "#!/bin/bash" with copyright notices, and an
|
||||
assignment to variable 'test_description', like this:
|
||||
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
# Copyright (c) 2005 Junio C Hamano
|
||||
#
|
||||
@@ -186,6 +186,24 @@ library for your script to use.
|
||||
expected output. (See below for how to generate transcripts
|
||||
easily.)
|
||||
|
||||
- test_todo_completion <message> <cmdline> <completions>
|
||||
|
||||
This takes three strings as parameter. Based on <cmdline>,
|
||||
the todo_completion script is triggered in the current test
|
||||
environment and completions are compared with <completions>,
|
||||
which should be a space-separated list. If any completion
|
||||
contains whitespace, quote it; the entire <completions>
|
||||
argument is eval()'ed.
|
||||
Include a trailing space in <cmdline> when you want to check
|
||||
new argument completion; otherwise, completion is triggered
|
||||
with the context of the last argument. <message> should state
|
||||
what it is testing.
|
||||
|
||||
- test_todo_custom_completion <completefunc> <message> <cmdline> <completions>
|
||||
|
||||
Same as above, but in addition allows to specify a custom
|
||||
completion function.
|
||||
|
||||
- test_tick [interval]
|
||||
|
||||
The test harness has an internal view of time which is
|
||||
@@ -205,6 +223,13 @@ library for your script to use.
|
||||
'git-write-tree should be able to write an empty tree.' \
|
||||
'tree=$(git-write-tree)'
|
||||
|
||||
- test_expect_code <code> <message> <script>
|
||||
|
||||
This takes an exit status and two strings as parameter, and
|
||||
evaluates the <script>. If it yields <code>, test is
|
||||
considered successful. <message> should state what it is
|
||||
testing.
|
||||
|
||||
- test_expect_failure <message> <script>
|
||||
|
||||
This is NOT the opposite of test_expect_success, but is used
|
||||
|
||||
36
tests/actions-test-lib.sh
Normal file
36
tests/actions-test-lib.sh
Normal file
@@ -0,0 +1,36 @@
|
||||
#!/bin/bash
|
||||
|
||||
make_action()
|
||||
{
|
||||
unset TODO_ACTIONS_DIR
|
||||
[ -d .todo.actions.d ] || mkdir .todo.actions.d
|
||||
cat > ".todo.actions.d/$1" <<EOF
|
||||
#!/bin/bash
|
||||
[ "\$1" = "usage" ] && {
|
||||
echo " $1 ITEM#[, ITEM#, ...] [TERM...]"
|
||||
echo " This custom action does $1."
|
||||
echo ""
|
||||
exit
|
||||
}
|
||||
echo "custom action $1"
|
||||
EOF
|
||||
chmod +x ".todo.actions.d/$1"
|
||||
}
|
||||
|
||||
make_action_in_folder()
|
||||
{
|
||||
unset TODO_ACTIONS_DIR
|
||||
[ -d .todo.actions.d ] || mkdir .todo.actions.d
|
||||
mkdir .todo.actions.d/$1
|
||||
cat > ".todo.actions.d/$1/$1" <<EOF
|
||||
#!/bin/bash
|
||||
[ "\$1" = "usage" ] && {
|
||||
echo " $1 ITEM#[, ITEM#, ...] [TERM...]"
|
||||
echo " This custom action does $1."
|
||||
echo ""
|
||||
exit
|
||||
}
|
||||
echo "custom action $1 in folder $1"
|
||||
EOF
|
||||
chmod +x ".todo.actions.d/$1/$1"
|
||||
}
|
||||
@@ -1,4 +1,57 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
[ "x$TERM" != "xdumb" ] && (
|
||||
export TERM &&
|
||||
[ -t 1 ] &&
|
||||
tput bold >/dev/null 2>&1 &&
|
||||
tput setaf 1 >/dev/null 2>&1 &&
|
||||
tput sgr0 >/dev/null 2>&1
|
||||
) &&
|
||||
color=t
|
||||
|
||||
case "$1" in
|
||||
--no-color)
|
||||
color=; shift ;;
|
||||
esac
|
||||
|
||||
if test -n "$color"; then
|
||||
say_color () {
|
||||
(
|
||||
export TERM
|
||||
case "$1" in
|
||||
error) tput bold; tput setaf 1;; # bold red
|
||||
skip) tput bold; tput setaf 2;; # bold green
|
||||
pass) tput setaf 2;; # green
|
||||
info) tput setaf 3;; # brown
|
||||
*) test -n "$quiet" && return;;
|
||||
esac
|
||||
shift
|
||||
printf "* %s" "$*"
|
||||
tput sgr0
|
||||
echo
|
||||
)
|
||||
}
|
||||
else
|
||||
say_color() {
|
||||
test -z "$1" && test -n "$quiet" && return
|
||||
shift
|
||||
echo "* $*"
|
||||
}
|
||||
fi
|
||||
|
||||
get_color()
|
||||
{
|
||||
# Only use the supplied color if there are actually instances of that
|
||||
# type, so that a clean test run does not distract the user by the
|
||||
# appearance of the error highlighting.
|
||||
if [ ${1:?} -eq 0 ]
|
||||
then
|
||||
echo 'info'
|
||||
else
|
||||
echo "${2:-info}"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
fixed=0
|
||||
success=0
|
||||
@@ -27,8 +80,8 @@ do
|
||||
done <"$file"
|
||||
done
|
||||
|
||||
printf "%-8s%d\n" fixed $fixed
|
||||
printf "%-8s%d\n" success $success
|
||||
printf "%-8s%d\n" failed $failed
|
||||
printf "%-8s%d\n" broken $broken
|
||||
printf "%-8s%d\n" total $total
|
||||
say_color 'info' "$(printf "%-8s%d\n" fixed $fixed)"
|
||||
say_color "$(get_color "$success" 'pass')" "$(printf "%-8s%d\n" success $success)"
|
||||
say_color "$(get_color "$failed" 'error')" "$(printf "%-8s%d\n" failed $failed)"
|
||||
say_color "$(get_color "$broken" 'error')" "$(printf "%-8s%d\n" broken $broken)"
|
||||
say_color 'info' "$(printf "%-8s%d\n" total $total)"
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='todo.sh configuration file location
|
||||
|
||||
@@ -8,6 +8,10 @@ to find it somewhere else.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
|
||||
# Override default global config file
|
||||
export TODOTXT_GLOBAL_CFG_FILE=global.cfg
|
||||
|
||||
# Remove the pre-created todo.cfg to test behavior in its absence
|
||||
rm -f todo.cfg
|
||||
echo "Fatal Error: Cannot read configuration file $HOME/.todo/config" > expect
|
||||
@@ -55,6 +59,14 @@ test_expect_success 'config file (default location 3)' '
|
||||
rm -f .todo.cfg
|
||||
'
|
||||
|
||||
rm -f used_config
|
||||
test_expect_success 'config file (global config file)' '
|
||||
cp test.cfg "$TODOTXT_GLOBAL_CFG_FILE"
|
||||
todo.sh > output;
|
||||
test_cmp expect output && test -f used_config &&
|
||||
rm -f "$TODOTXT_GLOBAL_CFG_FILE"
|
||||
'
|
||||
|
||||
rm -f used_config
|
||||
test_expect_success 'config file (command line)' '
|
||||
todo.sh -d test.cfg > output;
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='todo.sh basic null functionality test.
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='todo.sh actions.d
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='no old-style backtick command substitution
|
||||
|
||||
@@ -9,8 +9,15 @@ On failure, it will print each offending line number and line.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
backtick_check()
|
||||
{
|
||||
sed -n -e 's/\(^\|[ \t]\)#.*//' -e '/`/{' -e '=;p' -e '}' "$@"
|
||||
}
|
||||
|
||||
test_todo_session 'no old-style backtick command substitution' <<EOF
|
||||
>>> sed -n -e 's/\(^\|[ \t]\)#.*//' -e '/\`/{' -e '=;p' -e '}' "$(which todo.sh)"
|
||||
>>> backtick_check bin/todo.sh
|
||||
|
||||
>>> backtick_check ../../todo.cfg
|
||||
EOF
|
||||
|
||||
test_done
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic add and list functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='test the date on add feature
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic addto and list functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='test the date on addto feature
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic replace functionality
|
||||
|
||||
@@ -164,4 +164,12 @@ TODO: Replaced task with:
|
||||
1 (A) 2010-07-04 this also has a new date
|
||||
EOF
|
||||
|
||||
echo '2009-02-13 this is just a new one' > todo.txt
|
||||
test_todo_session 'replace with prepended priority and date replaces existing date' <<EOF
|
||||
>>> todo.sh replace 1 '(B) 2010-07-04 this also has a new date'
|
||||
1 2009-02-13 this is just a new one
|
||||
TODO: Replaced task with:
|
||||
1 (B) 2010-07-04 this also has a new date
|
||||
EOF
|
||||
|
||||
test_done
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic priority functionality
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='list priority functionality
|
||||
'
|
||||
@@ -61,6 +61,42 @@ TODO: 0 of 5 tasks shown
|
||||
TODO: 0 of 5 tasks shown
|
||||
EOF
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) smell the uppercase Roses +flowers @outside
|
||||
(X) clean the house from A-Z
|
||||
(C) notice the sunflowers
|
||||
(X) listen to music
|
||||
buy more records from artists A-Z
|
||||
EOF
|
||||
test_todo_session 'listpri filtering priority ranges' <<EOF
|
||||
>>> todo.sh -p listpri a-c
|
||||
1 (B) smell the uppercase Roses +flowers @outside
|
||||
3 (C) notice the sunflowers
|
||||
--
|
||||
TODO: 2 of 5 tasks shown
|
||||
|
||||
>>> todo.sh -p listpri c-Z
|
||||
3 (C) notice the sunflowers
|
||||
2 (X) clean the house from A-Z
|
||||
4 (X) listen to music
|
||||
--
|
||||
TODO: 3 of 5 tasks shown
|
||||
|
||||
>>> todo.sh -p listpri A-
|
||||
2 (X) clean the house from A-Z
|
||||
--
|
||||
TODO: 1 of 5 tasks shown
|
||||
|
||||
>>> todo.sh -p listpri A-C A-Z
|
||||
--
|
||||
TODO: 0 of 5 tasks shown
|
||||
|
||||
>>> todo.sh -p listpri X A-Z
|
||||
2 (X) clean the house from A-Z
|
||||
--
|
||||
TODO: 1 of 5 tasks shown
|
||||
EOF
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) ccc xxx this line should be third.
|
||||
ccc xxx this line should be third.
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
test_description='list project functionality
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
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 'basic listproj' <<EOF
|
||||
>>> todo.sh listproj
|
||||
+landscape
|
||||
+roses
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
test_todo_session 'listproj with context' <<EOF
|
||||
>>> todo.sh listproj @garden
|
||||
+landscape
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
TEST_TODO_CUSTOM=todo-custom.cfg
|
||||
cat todo.cfg > "$TEST_TODO_CUSTOM"
|
||||
cat >> "$TEST_TODO_CUSTOM" <<'EOF'
|
||||
export DEFAULT='</color>'
|
||||
export PRI_B='<color type=green>'
|
||||
export PRI_C='<color type=blue>'
|
||||
export TODOTXT_FINAL_FILTER='grep -i roses'
|
||||
EOF
|
||||
test_todo_session 'listproj with context special cases' <<EOF
|
||||
>>> todo.sh -+ -d "$TEST_TODO_CUSTOM" listproj @garden
|
||||
+landscape
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
test_done
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='list functionality
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='listcon functionality
|
||||
@@ -55,4 +55,33 @@ test_todo_session 'listcon e-mail address test' <<EOF
|
||||
@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
|
||||
@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
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='listproj functionality
|
||||
@@ -55,4 +55,68 @@ test_todo_session 'listproj embedded + test' <<EOF
|
||||
+prj02
|
||||
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 'basic listproj' <<EOF
|
||||
>>> todo.sh listproj
|
||||
+landscape
|
||||
+roses
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
test_todo_session 'listproj with context' <<EOF
|
||||
>>> todo.sh listproj @garden
|
||||
+landscape
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
TEST_TODO_CUSTOM=todo-custom.cfg
|
||||
cat todo.cfg > "$TEST_TODO_CUSTOM"
|
||||
cat >> "$TEST_TODO_CUSTOM" <<'EOF'
|
||||
export DEFAULT='</color>'
|
||||
export PRI_B='<color type=green>'
|
||||
export PRI_C='<color type=blue>'
|
||||
export TODOTXT_FINAL_FILTER='grep -i roses'
|
||||
EOF
|
||||
test_todo_session 'listproj with context special cases' <<EOF
|
||||
>>> todo.sh -+ -d "$TEST_TODO_CUSTOM" listproj @garden
|
||||
+landscape
|
||||
+shared
|
||||
+sunflowers
|
||||
EOF
|
||||
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
+prj01 -- Some project 1 task
|
||||
EOF
|
||||
cat > done.txt <<EOF
|
||||
x 2012-02-21 +done01 -- Special project 1 done task
|
||||
x 2012-02-21 +done02 -- Some project 2 done task
|
||||
EOF
|
||||
test_todo_session 'listproj from done tasks' <<'EOF'
|
||||
>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listproj
|
||||
+done01
|
||||
+done02
|
||||
EOF
|
||||
test_todo_session 'listproj from done tasks with filtering' <<'EOF'
|
||||
>>> TODOTXT_SOURCEVAR=\$DONE_FILE todo.sh listproj Special
|
||||
+done01
|
||||
EOF
|
||||
test_todo_session 'listproj from combined open + done tasks' <<'EOF'
|
||||
>>> TODOTXT_SOURCEVAR='("$TODO_FILE" "$DONE_FILE")' todo.sh listproj
|
||||
+done01
|
||||
+done02
|
||||
+prj01
|
||||
EOF
|
||||
|
||||
test_todo_session 'listproj with GREP_OPTIONS disruption' <<'EOF'
|
||||
>>> GREP_OPTIONS=-n todo.sh listproj
|
||||
+prj01
|
||||
EOF
|
||||
|
||||
test_done
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='list highlighting
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='listall functionality
|
||||
'
|
||||
|
||||
91
tests/t1360-ls-project-context-highlighting.sh
Executable file
91
tests/t1360-ls-project-context-highlighting.sh
Executable file
@@ -0,0 +1,91 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='highlighting projects and contexts
|
||||
|
||||
This test checks the highlighting (with colors) of projects and contexts.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
# Prioritized tasks with projects and contexts
|
||||
cat > todo.txt <<EOF
|
||||
(A) prioritized @con01 context
|
||||
(B) prioritized +prj02 project
|
||||
(C) prioritized context at EOL @con03
|
||||
(D) prioritized project at EOL +prj04
|
||||
+prj05 non-prioritized project at BOL
|
||||
@con06 non-prioritized context at BOL
|
||||
multiple @con_ @texts and +pro_ +jects
|
||||
non-contexts: seti@home @ @* @(foo)
|
||||
non-projects: lost+found + +! +(bar)
|
||||
EOF
|
||||
|
||||
# config file specifying COLOR_PROJECT and COLOR_CONTEXT
|
||||
#
|
||||
TEST_TODO_LABEL_COLORS=todo-colors.cfg
|
||||
cat todo.cfg > "$TEST_TODO_LABEL_COLORS"
|
||||
|
||||
echo "export COLOR_CONTEXT='\\\\033[1m'" >>"$TEST_TODO_LABEL_COLORS"
|
||||
echo "export COLOR_PROJECT='\\\\033[2m'" >>"$TEST_TODO_LABEL_COLORS"
|
||||
|
||||
test_todo_session 'highlighting for contexts and projects' <<'EOF'
|
||||
>>> todo.sh -d "$TEST_TODO_LABEL_COLORS" ls
|
||||
[1;33m1 (A) prioritized [1m@con01[0m[1;33m context[0m
|
||||
[0;32m2 (B) prioritized [2m+prj02[0m[0;32m project[0m
|
||||
[1;34m3 (C) prioritized context at EOL [1m@con03[0m[1;34m[0m
|
||||
[1;37m4 (D) prioritized project at EOL [2m+prj04[0m[1;37m[0m
|
||||
5 [2m+prj05[0m non-prioritized project at BOL
|
||||
6 [1m@con06[0m non-prioritized context at BOL
|
||||
7 multiple [1m@con_[0m [1m@texts[0m and [2m+pro_[0m [2m+jects[0m
|
||||
8 non-contexts: seti@home @ @* @(foo)
|
||||
9 non-projects: lost+found + +! +(bar)
|
||||
--
|
||||
TODO: 9 of 9 tasks shown
|
||||
EOF
|
||||
|
||||
test_todo_session 'suppressing highlighting for contexts and projects' <<'EOF'
|
||||
>>> todo.sh -p -d "$TEST_TODO_LABEL_COLORS" ls
|
||||
1 (A) prioritized @con01 context
|
||||
2 (B) prioritized +prj02 project
|
||||
3 (C) prioritized context at EOL @con03
|
||||
4 (D) prioritized project at EOL +prj04
|
||||
5 +prj05 non-prioritized project at BOL
|
||||
6 @con06 non-prioritized context at BOL
|
||||
7 multiple @con_ @texts and +pro_ +jects
|
||||
8 non-contexts: seti@home @ @* @(foo)
|
||||
9 non-projects: lost+found + +! +(bar)
|
||||
--
|
||||
TODO: 9 of 9 tasks shown
|
||||
EOF
|
||||
|
||||
test_todo_session 'suppressing display of contexts' <<'EOF'
|
||||
>>> todo.sh -@ -d "$TEST_TODO_LABEL_COLORS" ls
|
||||
[1;33m1 (A) prioritized context[0m
|
||||
[0;32m2 (B) prioritized [2m+prj02[0m[0;32m project[0m
|
||||
[1;34m3 (C) prioritized context at EOL[0m
|
||||
[1;37m4 (D) prioritized project at EOL [2m+prj04[0m[1;37m[0m
|
||||
5 [2m+prj05[0m non-prioritized project at BOL
|
||||
6 non-prioritized context at BOL
|
||||
7 multiple and [2m+pro_[0m [2m+jects[0m
|
||||
8 non-contexts: seti@home @
|
||||
9 non-projects: lost+found + +! +(bar)
|
||||
--
|
||||
TODO: 9 of 9 tasks shown
|
||||
EOF
|
||||
|
||||
test_todo_session 'suppressing display of projects' <<'EOF'
|
||||
>>> todo.sh -+ -d "$TEST_TODO_LABEL_COLORS" ls
|
||||
[1;33m1 (A) prioritized [1m@con01[0m[1;33m context[0m
|
||||
[0;32m2 (B) prioritized project[0m
|
||||
[1;34m3 (C) prioritized context at EOL [1m@con03[0m[1;34m[0m
|
||||
[1;37m4 (D) prioritized project at EOL[0m
|
||||
5 non-prioritized project at BOL
|
||||
6 [1m@con06[0m non-prioritized context at BOL
|
||||
7 multiple [1m@con_[0m [1m@texts[0m and
|
||||
8 non-contexts: seti@home @ @* @(foo)
|
||||
9 non-projects: lost+found +
|
||||
--
|
||||
TODO: 9 of 9 tasks shown
|
||||
EOF
|
||||
|
||||
test_done
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic prepend functionality
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='do functionality
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic append functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic depriority functionality
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic del functionality
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='archive functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='deduplicate functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='report functionality
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='Multi-line functionality'
|
||||
|
||||
@@ -8,18 +8,18 @@ test_description='Multi-line functionality'
|
||||
# Create the expected file
|
||||
echo "1 smell the cheese
|
||||
TODO: Replaced task with:
|
||||
1 eat apples eat oranges drink milk">$HOME/expect.multi
|
||||
1 eat apples eat oranges drink milk">"$HOME/expect.multi"
|
||||
|
||||
test_expect_success 'multiline squash item replace' '
|
||||
(
|
||||
# Prepare single line todo file
|
||||
cat /dev/null > $HOME/todo.txt
|
||||
cat /dev/null > "$HOME/todo.txt"
|
||||
"$HOME/bin/todo.sh" add smell the cheese
|
||||
|
||||
# Run replace
|
||||
"$HOME/bin/todo.sh" replace 1 "eat apples
|
||||
eat oranges
|
||||
drink milk" > $HOME/output.multi
|
||||
drink milk" > "$HOME/output.multi"
|
||||
|
||||
# Test output against expected
|
||||
diff "$HOME/output.multi" "$HOME/expect.multi"
|
||||
@@ -34,18 +34,18 @@ fi
|
||||
## Add test
|
||||
# Create the expected file
|
||||
echo "2 eat apples eat oranges drink milk
|
||||
TODO: 2 added.">$HOME/expect.multi
|
||||
TODO: 2 added.">"$HOME/expect.multi"
|
||||
|
||||
test_expect_success 'multiline squash item add' '
|
||||
(
|
||||
# Prepare single line todo file
|
||||
cat /dev/null > $HOME/todo.txt
|
||||
cat /dev/null > "$HOME/todo.txt"
|
||||
"$HOME/bin/todo.sh" add smell the cheese
|
||||
|
||||
# Run add
|
||||
"$HOME/bin/todo.sh" add "eat apples
|
||||
eat oranges
|
||||
drink milk" > $HOME/output.multi
|
||||
drink milk" > "$HOME/output.multi"
|
||||
|
||||
# Test output against expected
|
||||
diff "$HOME/output.multi" "$HOME/expect.multi"
|
||||
@@ -59,18 +59,18 @@ fi
|
||||
|
||||
## Append test
|
||||
# Create the expected file
|
||||
echo "1 smell the cheese eat apples eat oranges drink milk">$HOME/expect.multi
|
||||
echo "1 smell the cheese eat apples eat oranges drink milk">"$HOME/expect.multi"
|
||||
|
||||
test_expect_success 'multiline squash item append' '
|
||||
(
|
||||
# Prepare single line todo file
|
||||
cat /dev/null > $HOME/todo.txt
|
||||
cat /dev/null > "$HOME/todo.txt"
|
||||
"$HOME/bin/todo.sh" add smell the cheese
|
||||
|
||||
# Run append
|
||||
"$HOME/bin/todo.sh" append 1 "eat apples
|
||||
eat oranges
|
||||
drink milk" > $HOME/output.multi
|
||||
drink milk" > "$HOME/output.multi"
|
||||
|
||||
# Test output against expected
|
||||
diff "$HOME/output.multi" "$HOME/expect.multi"
|
||||
@@ -84,18 +84,18 @@ fi
|
||||
|
||||
## Prepend test
|
||||
# Create the expected file
|
||||
echo "1 eat apples eat oranges drink milk smell the cheese">$HOME/expect.multi
|
||||
echo "1 eat apples eat oranges drink milk smell the cheese">"$HOME/expect.multi"
|
||||
|
||||
test_expect_success 'multiline squash item prepend' '
|
||||
(
|
||||
# Prepare single line todo file
|
||||
cat /dev/null > $HOME/todo.txt
|
||||
cat /dev/null > "$HOME/todo.txt"
|
||||
"$HOME/bin/todo.sh" add smell the cheese
|
||||
|
||||
# Run prepend
|
||||
"$HOME/bin/todo.sh" prepend 1 "eat apples
|
||||
eat oranges
|
||||
drink milk" > $HOME/output.multi
|
||||
drink milk" > "$HOME/output.multi"
|
||||
|
||||
# Test output against expected
|
||||
diff "$HOME/output.multi" "$HOME/expect.multi"
|
||||
@@ -110,18 +110,18 @@ fi
|
||||
## Multiple line addition
|
||||
# Create the expected file
|
||||
echo "2 eat apples
|
||||
TODO: 2 added." > $HOME/expect.multi
|
||||
TODO: 2 added." > "$HOME/expect.multi"
|
||||
echo "3 eat oranges
|
||||
TODO: 3 added." >>$HOME/expect.multi
|
||||
TODO: 3 added." >>"$HOME/expect.multi"
|
||||
echo "4 drink milk
|
||||
TODO: 4 added." >> $HOME/expect.multi
|
||||
TODO: 4 added." >>"$HOME/expect.multi"
|
||||
|
||||
test_expect_success 'actual multiline add' '
|
||||
(
|
||||
# Run addm
|
||||
"$HOME/bin/todo.sh" addm "eat apples
|
||||
eat oranges
|
||||
drink milk" > $HOME/output.multi
|
||||
drink milk" > "$HOME/output.multi"
|
||||
|
||||
# Test output against expected
|
||||
diff "$HOME/output.multi" "$HOME/expect.multi"
|
||||
|
||||
44
tests/t2100-help.sh
Executable file
44
tests/t2100-help.sh
Executable file
@@ -0,0 +1,44 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='help functionality
|
||||
|
||||
This test covers the help output.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
|
||||
# Note: To avoid having to adapt the test whenever the help documentation
|
||||
# slightly changes, only check for the section headers.
|
||||
test_todo_session 'help output' <<EOF
|
||||
>>> todo.sh help | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Options:
|
||||
Built-in Actions:
|
||||
EOF
|
||||
|
||||
test_todo_session 'verbose help output' <<EOF
|
||||
>>> todo.sh -v help | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Options:
|
||||
Built-in Actions:
|
||||
EOF
|
||||
|
||||
test_todo_session 'very verbose help output' <<EOF
|
||||
>>> todo.sh -vv help | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Options:
|
||||
Environment variables:
|
||||
Built-in Actions:
|
||||
EOF
|
||||
|
||||
make_action "foo"
|
||||
test_todo_session 'help output with custom action' <<EOF
|
||||
>>> todo.sh -v help | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Options:
|
||||
Built-in Actions:
|
||||
Add-on Actions:
|
||||
EOF
|
||||
|
||||
test_done
|
||||
66
tests/t2110-help-action.sh
Executable file
66
tests/t2110-help-action.sh
Executable file
@@ -0,0 +1,66 @@
|
||||
#!/bin/bash
|
||||
|
||||
test_description='built-in actions help functionality
|
||||
|
||||
This test checks listing the usage help of a built-in action.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
test_todo_session 'nonexisting action help' <<'EOF'
|
||||
>>> todo.sh help doesnotexist
|
||||
TODO: No action "doesnotexist" exists.
|
||||
=== 1
|
||||
|
||||
>>> todo.sh help hel
|
||||
TODO: No action "hel" exists.
|
||||
=== 1
|
||||
|
||||
>>> todo.sh help h
|
||||
TODO: No action "h" exists.
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
test_todo_session 'single action help' <<'EOF'
|
||||
>>> todo.sh help shorthelp
|
||||
shorthelp
|
||||
List the one-line usage of all built-in and add-on actions.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'multiple actions help' <<'EOF'
|
||||
>>> todo.sh help shorthelp append
|
||||
shorthelp
|
||||
List the one-line usage of all built-in and add-on actions.
|
||||
\
|
||||
append ITEM# "TEXT TO APPEND"
|
||||
app ITEM# "TEXT TO APPEND"
|
||||
Adds TEXT TO APPEND to the end of the task on line ITEM#.
|
||||
Quotes optional.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'short and long form of action help' <<'EOF'
|
||||
>>> todo.sh help append
|
||||
append ITEM# "TEXT TO APPEND"
|
||||
app ITEM# "TEXT TO APPEND"
|
||||
Adds TEXT TO APPEND to the end of the task on line ITEM#.
|
||||
Quotes optional.
|
||||
\
|
||||
|
||||
>>> todo.sh help app
|
||||
app ITEM# "TEXT TO APPEND"
|
||||
Adds TEXT TO APPEND to the end of the task on line ITEM#.
|
||||
Quotes optional.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'mixed existing and nonexisting action help' <<'EOF'
|
||||
>>> todo.sh help shorthelp doesnotexist list
|
||||
shorthelp
|
||||
List the one-line usage of all built-in and add-on actions.
|
||||
\
|
||||
TODO: No action "doesnotexist" exists.
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
test_done
|
||||
82
tests/t2120-shorthelp.sh
Executable file
82
tests/t2120-shorthelp.sh
Executable file
@@ -0,0 +1,82 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='shorthelp functionality
|
||||
|
||||
This test covers the output of the -h option and the shorthelp action.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
|
||||
# Note: To avoid having to adapt the test whenever the actions change, only
|
||||
# check for the section headers.
|
||||
test_todo_session '-h output' <<EOF
|
||||
>>> todo.sh -h | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
See "help" for more details.
|
||||
EOF
|
||||
|
||||
test_todo_session 'shorthelp output' <<EOF
|
||||
>>> todo.sh shorthelp | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
See "help" for more details.
|
||||
EOF
|
||||
|
||||
make_action "foo"
|
||||
test_todo_session 'shorthelp output with custom action' <<EOF
|
||||
>>> todo.sh -v shorthelp | sed '/^ [A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
Add-on Actions:
|
||||
See "help" for more details.
|
||||
EOF
|
||||
|
||||
|
||||
# Verify that custom configuration is actually processed (when the -d option
|
||||
# precedes the -h option) by specifying a different actions directory and moving
|
||||
# our custom action there. The help output should mention the "Add-On Actions".
|
||||
set -o pipefail # So that the sed filter doesn't swallow todo.sh's exit code.
|
||||
mv todo.cfg custom.cfg
|
||||
mv .todo.actions.d custom.actions
|
||||
echo 'export TODO_ACTIONS_DIR=$HOME/custom.actions' >> custom.cfg
|
||||
|
||||
# Avoid the use of global config file, if it exists
|
||||
export TODOTXT_GLOBAL_CFG_FILE=global.cfg
|
||||
|
||||
test_todo_session '-h and fatal error without config' <<EOF
|
||||
>>> todo.sh -h | sed '/^ \\{0,2\\}[A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
See "help" for more details.
|
||||
Fatal Error: Cannot read configuration file $HOME/.todo/config
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
# Config option comes too late; "Add-on Actions" is *not* mentioned here.
|
||||
test_todo_session '-h and fatal error with trailing custom config' <<EOF
|
||||
>>> todo.sh -h -d custom.cfg | sed '/^ \\{0,2\\}[A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
See "help" for more details.
|
||||
Fatal Error: Cannot read configuration file $HOME/.todo/config
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
# Config option processed; "Add-on Actions" is mentioned here.
|
||||
test_todo_session '-h output with preceding custom config' <<EOF
|
||||
>>> todo.sh -d custom.cfg -h | sed '/^ \\{0,2\\}[A-Z]/!d'
|
||||
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
|
||||
Actions:
|
||||
Actions can be added and overridden using scripts in the actions
|
||||
Add-on Actions:
|
||||
See "help" for more details.
|
||||
EOF
|
||||
|
||||
test_done
|
||||
49
tests/t2200-no-done-report-files.sh
Executable file
49
tests/t2200-no-done-report-files.sh
Executable file
@@ -0,0 +1,49 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='todo.sh configuration with a sole todo.txt data file.
|
||||
|
||||
This test covers turning off done.txt and report.txt, and
|
||||
checks that no such empty files are created.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > test.cfg << EOF
|
||||
export TODO_DIR=.
|
||||
export TODO_FILE="\$TODO_DIR/todo.txt"
|
||||
export DONE_FILE=/dev/null
|
||||
export REPORT_FILE=/dev/null
|
||||
export TMP_FILE="\$TODO_DIR/todo.tmp"
|
||||
touch used_config
|
||||
EOF
|
||||
|
||||
test_todo_session 'invoke todo.sh' <<EOF
|
||||
>>> todo.sh -d test.cfg add notice the daisies
|
||||
1 notice the daisies
|
||||
TODO: 1 added.
|
||||
EOF
|
||||
|
||||
test_expect_success 'the todo file has been created' '[ -e todo.txt ]'
|
||||
test_expect_success 'no done file has been created' '[ ! -e done.txt ]'
|
||||
test_expect_success 'no report file has been created' '[ ! -e report.txt ]'
|
||||
|
||||
test_todo_session 'perform archive' <<EOF
|
||||
>>> todo.sh -A -d test.cfg do 1
|
||||
1 x 2009-02-13 notice the daisies
|
||||
TODO: 1 marked as done.
|
||||
x 2009-02-13 notice the daisies
|
||||
TODO: ./todo.txt archived.
|
||||
EOF
|
||||
|
||||
test_expect_success 'no done file has been created by the archiving' '[ ! -e done.txt ]'
|
||||
|
||||
test_todo_session 'perform report' <<EOF
|
||||
>>> todo.sh -d test.cfg report
|
||||
TODO: ./todo.txt archived.
|
||||
2009-02-13T04:40:00 0 0
|
||||
TODO: Report file updated.
|
||||
EOF
|
||||
|
||||
test_expect_success 'no report file has been created by the reporting' '[ ! -e report.txt ]'
|
||||
|
||||
test_done
|
||||
22
tests/t6000-completion.sh
Executable file
22
tests/t6000-completion.sh
Executable file
@@ -0,0 +1,22 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash completion functionality
|
||||
|
||||
This test checks basic todo_completion of actions and options
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
readonly ACTIONS='add a addto addm append app archive command del rm depri dp do help list ls listaddons listall lsa listcon lsc listfile lf listpri lsp listproj lsprj move mv prepend prep pri p replace report shorthelp'
|
||||
readonly OPTIONS='-@ -@@ -+ -++ -d -f -h -p -P -PP -a -n -t -v -vv -V -x'
|
||||
|
||||
test_todo_completion 'all arguments' 'todo.sh ' "$ACTIONS $OPTIONS"
|
||||
test_todo_completion 'arguments beginning with a' 'todo.sh a' 'add a addto addm append app archive'
|
||||
test_todo_completion 'all options' 'todo.sh -' "$OPTIONS"
|
||||
test_todo_completion 'all actions after command action' 'todo.sh command ' "$ACTIONS"
|
||||
test_todo_completion 'all arguments after option' 'todo.sh -a ' "$ACTIONS $OPTIONS"
|
||||
test_todo_completion 'all arguments after options' 'todo.sh -a -p ' "$ACTIONS $OPTIONS"
|
||||
test_todo_completion 'all options after options' 'todo.sh -a -p -' "$OPTIONS"
|
||||
test_todo_completion 'nothing after action' 'todo.sh archive ' ''
|
||||
|
||||
test_done
|
||||
27
tests/t6010-completion-contexts.sh
Executable file
27
tests/t6010-completion-contexts.sh
Executable file
@@ -0,0 +1,27 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash context completion functionality
|
||||
|
||||
This test checks todo_completion of contexts
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) smell the +roses @outside @outdoor +shared
|
||||
notice the sunflowers +sunflowers @outside @garden +shared +landscape
|
||||
stop
|
||||
EOF
|
||||
cat > done.txt <<EOF
|
||||
x 2012-02-21 +herbs @oriental buy spices
|
||||
x 2012-02-21 +slack @home watch tv
|
||||
EOF
|
||||
test_todo_completion 'all contexts' 'todo.sh list @' '@garden @outdoor @outside'
|
||||
test_todo_completion 'contexts beginning with o' 'todo.sh list @o' '@outdoor @outside'
|
||||
test_todo_completion 'contexts beginning with outs' 'todo.sh list @outs' '@outside'
|
||||
test_todo_completion 'contexts beginning with x' 'todo.sh list @x' ''
|
||||
|
||||
test_todo_completion 'contexts from done tasks beginning with h' 'todo.sh list @h' '@home'
|
||||
test_todo_completion 'contexts from done tasks beginning with or' 'todo.sh list @or' '@oriental'
|
||||
|
||||
test_done
|
||||
27
tests/t6020-completion-projects.sh
Executable file
27
tests/t6020-completion-projects.sh
Executable file
@@ -0,0 +1,27 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash project completion functionality
|
||||
|
||||
This test checks todo_completion of projects
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) smell the +roses @outside @outdoor +shared
|
||||
notice the sunflowers +sunflowers @outside @garden +shared +landscape
|
||||
stop
|
||||
EOF
|
||||
cat > done.txt <<EOF
|
||||
x 2012-02-21 +herbs @oriental buy spices
|
||||
x 2012-02-21 +slack @home watch tv
|
||||
EOF
|
||||
test_todo_completion 'all projects' 'todo.sh list +' '+landscape +roses +shared +sunflowers'
|
||||
test_todo_completion 'projects beginning with s' 'todo.sh list +s' '+shared +sunflowers'
|
||||
test_todo_completion 'projects beginning with ro' 'todo.sh list +ro' '+roses'
|
||||
test_todo_completion 'projects beginning with x' 'todo.sh list +x' ''
|
||||
|
||||
test_todo_completion 'projects from done tasks beginning with h' 'todo.sh list +h' '+herbs'
|
||||
test_todo_completion 'projects from done tasks beginning with sl' 'todo.sh list +sl' '+slack'
|
||||
|
||||
test_done
|
||||
27
tests/t6030-completion-tasks.sh
Executable file
27
tests/t6030-completion-tasks.sh
Executable file
@@ -0,0 +1,27 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash task number completion functionality
|
||||
|
||||
This test checks todo_completion of a task number into the abbreviated task text.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
simple task
|
||||
notice the sunflowers +sunflowers @outside @garden +shared +landscape
|
||||
(B) smell the +roses flower @outside @outdoor +shared
|
||||
(C) 2012-02-28 @outside mow the lawn
|
||||
x 2012-02-21 +herbs @oriental buy spices
|
||||
x 2012-02-28 2012-02-21 +slack @home watch tv
|
||||
2012-02-28 +herbs buy cinnamon @grocer
|
||||
EOF
|
||||
test_todo_completion 'simple task' 'todo.sh list 1' '"1 # simple task"'
|
||||
test_todo_completion 'remove projects and contents from task' 'todo.sh list 2' '"2 # notice the sunflowers"'
|
||||
test_todo_completion 'keep priority' 'todo.sh list 3' '"3 # (B) smell the flower"'
|
||||
test_todo_completion 'keep priority and remove timestamp' 'todo.sh list 4' '"4 # (C) mow the lawn"'
|
||||
test_todo_completion 'keep done marker and remove done date' 'todo.sh list 5' '"5 # x buy spices"'
|
||||
test_todo_completion 'keep done marker and remove timestamp and done date' 'todo.sh list 6' '"6 # x watch tv"'
|
||||
test_todo_completion 'remove add date' 'todo.sh list 7' '"7 # buy cinnamon"'
|
||||
|
||||
test_done
|
||||
21
tests/t6040-completion-files.sh
Executable file
21
tests/t6040-completion-files.sh
Executable file
@@ -0,0 +1,21 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash todo file completion functionality
|
||||
|
||||
This test checks todo_completion of files in TODO_DIR.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
> dummy.txt
|
||||
readonly FILES='done.txt dummy.txt report.txt todo.txt'
|
||||
test_todo_completion 'all files after addto' 'todo.sh addto ' "$FILES"
|
||||
test_todo_completion 'files beginning with d after addto' 'todo.sh addto d' 'done.txt dummy.txt'
|
||||
test_todo_completion 'all files after listfile' 'todo.sh listfile ' "$FILES"
|
||||
test_todo_completion 'all files after lf' 'todo.sh -v lf ' "$FILES"
|
||||
test_todo_completion 'nothing after move' 'todo.sh move ' ''
|
||||
test_todo_completion 'all files after move ITEM#' 'todo.sh move 1 ' "$FILES"
|
||||
test_todo_completion 'all files after mv ITEM#' 'todo.sh mv 1 ' "$FILES"
|
||||
test_todo_completion 'all files after move ITEM# DEST' 'todo.sh move 1 todo.sh ' "$FILES"
|
||||
|
||||
test_done
|
||||
92
tests/t6050-completion-addons.sh
Executable file
92
tests/t6050-completion-addons.sh
Executable file
@@ -0,0 +1,92 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash add-on action completion functionality
|
||||
|
||||
This test checks todo_completion of custom actions in .todo.actions.d
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
readonly ACTIONS='add a addto addm append app archive command del rm depri dp do help list ls listaddons listall lsa listcon lsc listfile lf listpri lsp listproj lsprj move mv prepend prep pri p replace report shorthelp'
|
||||
readonly OPTIONS='-@ -@@ -+ -++ -d -f -h -p -P -PP -a -n -t -v -vv -V -x'
|
||||
|
||||
readonly ADDONS='bar baz foobar'
|
||||
|
||||
readonly CONTAINED='xeno zoolander'
|
||||
makeCustomActions()
|
||||
{
|
||||
set -e
|
||||
mkdir "${1:?}"
|
||||
for addon in $ADDONS
|
||||
do
|
||||
addonFile="${1}/$addon"
|
||||
> "$addonFile"
|
||||
chmod +x "$addonFile"
|
||||
done
|
||||
|
||||
# Also create a subdirectory, to test that it is skipped.
|
||||
mkdir "${1}/subdir"
|
||||
|
||||
# Also create a non-executable file, to test that it is skipped.
|
||||
datafile="${1:?}/datafile"
|
||||
> "$datafile"
|
||||
chmod -x "$datafile"
|
||||
[ -x "$datafile" ] && rm "$datafile" # Some file systems may always make files executable; then, skip this check.
|
||||
|
||||
# Add an executable file in a folder with the same name as the file,
|
||||
# in order to ensure completion
|
||||
for contained in $CONTAINED
|
||||
do
|
||||
mkdir "${1}/$contained"
|
||||
> "${1}/$contained/$contained"
|
||||
chmod u+x "${1}/$contained/$contained"
|
||||
done
|
||||
|
||||
set +e
|
||||
}
|
||||
removeCustomActions()
|
||||
{
|
||||
set -e
|
||||
rmdir "${1}/subdir"
|
||||
|
||||
for contained in $CONTAINED
|
||||
do
|
||||
rm "${1}/$contained/$contained"
|
||||
rmdir "${1}/$contained"
|
||||
done
|
||||
|
||||
rm "${1:?}/"*
|
||||
rmdir "$1"
|
||||
set +e
|
||||
}
|
||||
|
||||
#
|
||||
# Test resolution of the default TODO_ACTIONS_DIR.
|
||||
#
|
||||
makeCustomActions "$HOME/.todo.actions.d"
|
||||
test_todo_completion 'all arguments' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
|
||||
test_todo_completion 'all arguments after option' 'todo.sh -a ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
|
||||
test_todo_completion 'all arguments beginning with b' 'todo.sh b' 'bar baz'
|
||||
test_todo_completion 'all arguments beginning with f after options' 'todo.sh -a -v f' 'foobar'
|
||||
test_todo_completion 'nothing after addon action' 'todo.sh foobar ' ''
|
||||
removeCustomActions "$HOME/.todo.actions.d"
|
||||
|
||||
#
|
||||
# Test resolution of an alternative TODO_ACTIONS_DIR.
|
||||
#
|
||||
mkdir "$HOME/.todo"
|
||||
makeCustomActions "$HOME/.todo/actions"
|
||||
test_todo_completion 'all arguments with actions from .todo/actions/' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
|
||||
removeCustomActions "$HOME/.todo/actions"
|
||||
|
||||
#
|
||||
# Test resolution of a configured TODO_ACTIONS_DIR.
|
||||
#
|
||||
makeCustomActions "$HOME/addons"
|
||||
cat >> todo.cfg <<'EOF'
|
||||
export TODO_ACTIONS_DIR="$HOME/addons"
|
||||
EOF
|
||||
test_todo_completion 'all arguments with actions from addons/' 'todo.sh ' "$ACTIONS $ADDONS $CONTAINED $OPTIONS"
|
||||
removeCustomActions "$HOME/addons"
|
||||
|
||||
test_done
|
||||
45
tests/t6080-completion-path.sh
Executable file
45
tests/t6080-completion-path.sh
Executable file
@@ -0,0 +1,45 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash completion with different path functionality
|
||||
|
||||
This test checks that todo_completion can use a different path to todo.sh when
|
||||
it is not accessible through PATH.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) smell the +roses @outside @outdoor +shared
|
||||
notice the sunflowers +sunflowers @outside @garden +shared +landscape
|
||||
stop
|
||||
EOF
|
||||
|
||||
mv bin/todo.sh bin/todo2.sh
|
||||
test_expect_success 'todo2.sh executable' 'todo2.sh list'
|
||||
|
||||
# Define a second completion function that injects the different executable. In
|
||||
# real use, this would be installed via
|
||||
# complete -F _todo2 todo2.sh
|
||||
_todo2()
|
||||
{
|
||||
local _todo_sh='todo2.sh'
|
||||
_todo "$@"
|
||||
}
|
||||
|
||||
test_todo_custom_completion _todo2 'all todo2 contexts' 'todo2 list @' '@garden @outdoor @outside'
|
||||
|
||||
|
||||
|
||||
# Remove the test environment's bin directory from the PATH, so that our test
|
||||
# executable must be launched with an explicit path.
|
||||
PATH=${PATH##"${PWD}/bin:"}
|
||||
test_expect_code 127 'todo2.sh executable not in PATH' 'todo2.sh'
|
||||
|
||||
_todo2path()
|
||||
{
|
||||
local _todo_sh='./bin/todo2.sh'
|
||||
_todo "$@"
|
||||
}
|
||||
test_todo_custom_completion _todo2path 'all todo2 contexts' 'todo2 list @' '@garden @outdoor @outside'
|
||||
|
||||
test_done
|
||||
62
tests/t6090-completion-aliases.sh
Executable file
62
tests/t6090-completion-aliases.sh
Executable file
@@ -0,0 +1,62 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash completion with different aliases functionality
|
||||
|
||||
This test checks that todo_completion can use a different configuration
|
||||
when another todo.sh alias is defined that uses that configuration.
|
||||
'
|
||||
. ./test-lib.sh
|
||||
|
||||
cat > todo.txt <<EOF
|
||||
(B) smell the +roses @outside @outdoor +shared
|
||||
notice the sunflowers +sunflowers @outside @garden +shared +landscape
|
||||
stop
|
||||
EOF
|
||||
cat > todo2.txt <<EOF
|
||||
+herbs @oriental buy spices
|
||||
+slack @home watch tv
|
||||
EOF
|
||||
|
||||
cp todo.cfg todo2.cfg
|
||||
cat >> todo2.cfg <<'EOF'
|
||||
export TODO_FILE="$TODO_DIR/todo2.txt"
|
||||
EOF
|
||||
|
||||
# Note: We cannot use aliases within the test framework, but functions are
|
||||
# equivalent and work fine.
|
||||
todo1()
|
||||
{
|
||||
todo.sh "$@"
|
||||
}
|
||||
todo2()
|
||||
{
|
||||
todo.sh -d "$HOME/todo2.cfg" "$@"
|
||||
}
|
||||
|
||||
# Ensure that the test fixture works as planned.
|
||||
test_todo_session 'todo 1 and 2 contexts' <<EOF
|
||||
>>> todo1 listcon
|
||||
@garden
|
||||
@outdoor
|
||||
@outside
|
||||
|
||||
>>> todo2 listcon
|
||||
@home
|
||||
@oriental
|
||||
EOF
|
||||
|
||||
|
||||
# Define a second completion function that injects the different configuration
|
||||
# file. In real use, this would be installed via
|
||||
# complete -F _todo2 todo2
|
||||
_todo2()
|
||||
{
|
||||
local _todo_sh='todo.sh -d "$HOME/todo2.cfg"'
|
||||
_todo "$@"
|
||||
}
|
||||
|
||||
test_todo_completion 'all todo1 contexts' 'todo1 list @' '@garden @outdoor @outside'
|
||||
test_todo_custom_completion _todo2 'all todo2 contexts' 'todo2 list @' '@home @oriental'
|
||||
|
||||
test_done
|
||||
20
tests/t6100-completion-help.sh
Executable file
20
tests/t6100-completion-help.sh
Executable file
@@ -0,0 +1,20 @@
|
||||
#!/bin/bash
|
||||
#
|
||||
|
||||
test_description='Bash help completion functionality
|
||||
|
||||
This test checks todo_completion of actions for usage help.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
make_action "zany"
|
||||
make_action "aardvark"
|
||||
|
||||
readonly ACTIONS='add a addto addm append app archive command del rm depri dp do help list ls listaddons listall lsa listcon lsc listfile lf listpri lsp listproj lsprj move mv prepend prep pri p replace report shorthelp'
|
||||
readonly ADDONS='aardvark zany'
|
||||
|
||||
test_todo_completion 'all actions after help' 'todo.sh help ' "$ACTIONS $ADDONS"
|
||||
test_todo_completion 'all actions after command help' 'todo.sh command help ' "$ACTIONS $ADDONS"
|
||||
test_todo_completion 'actions beginning with a' 'todo.sh help a' 'add a addto addm append app archive aardvark'
|
||||
|
||||
test_done
|
||||
@@ -1,22 +1,12 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='custom actions functionality
|
||||
|
||||
This test covers the contract between todo.sh and custom actions.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
|
||||
unset TODO_ACTIONS_DIR
|
||||
mkdir .todo.actions.d
|
||||
make_action()
|
||||
{
|
||||
cat > ".todo.actions.d/$1" <<- EOF
|
||||
#!/bin/bash
|
||||
echo "custom action $1"
|
||||
EOF
|
||||
chmod +x ".todo.actions.d/$1"
|
||||
}
|
||||
|
||||
make_action "foo"
|
||||
test_todo_session 'executable action' <<EOF
|
||||
>>> todo.sh foo
|
||||
|
||||
84
tests/t8010-listaddons.sh
Executable file
84
tests/t8010-listaddons.sh
Executable file
@@ -0,0 +1,84 @@
|
||||
#!/bin/bash
|
||||
|
||||
test_description='listaddons functionality
|
||||
|
||||
This test checks listing of custom actions.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
|
||||
test_todo_session 'no custom actions' <<EOF
|
||||
>>> todo.sh listaddons
|
||||
EOF
|
||||
|
||||
make_action "foo"
|
||||
test_todo_session 'one custom action' <<EOF
|
||||
>>> todo.sh listaddons
|
||||
foo
|
||||
EOF
|
||||
|
||||
make_action "bar"
|
||||
make_action "ls"
|
||||
make_action "quux"
|
||||
test_todo_session 'multiple custom actions' <<EOF
|
||||
>>> todo.sh listaddons
|
||||
bar
|
||||
foo
|
||||
ls
|
||||
quux
|
||||
EOF
|
||||
|
||||
chmod -x .todo.actions.d/foo
|
||||
# On Cygwin, clearing the executable flag may have no effect, as the Windows ACL
|
||||
# may still grant execution rights. In this case, we skip the test.
|
||||
if [ -x .todo.actions.d/foo ]; then
|
||||
SKIP_TESTS="${SKIP_TESTS}${SKIP_TESTS+ }t8010.4"
|
||||
fi
|
||||
test_todo_session 'nonexecutable action' <<EOF
|
||||
>>> todo.sh listaddons
|
||||
bar
|
||||
ls
|
||||
quux
|
||||
EOF
|
||||
|
||||
make_action_in_folder "chuck"
|
||||
# Add a bit of cruft in the action folders in order to ensure that we only
|
||||
# care about the executables with the same name as the folder in which they
|
||||
# reside.
|
||||
touch .todo.actions.d/chuck/mc_hammer # can't touch this
|
||||
chmod u+x .todo.actions.d/chuck/mc_hammer # better run, better run run
|
||||
touch .todo.actions.d/chuck/README
|
||||
|
||||
make_action_in_folder "norris"
|
||||
|
||||
test_todo_session 'custom actions in subfolders' <<EOF
|
||||
>>> test -f .todo.actions.d/chuck/README
|
||||
=== 0
|
||||
|
||||
>>> test -x .todo.actions.d/chuck/mc_hammer
|
||||
=== 0
|
||||
|
||||
>>> todo.sh listaddons
|
||||
bar
|
||||
chuck
|
||||
ls
|
||||
norris
|
||||
quux
|
||||
EOF
|
||||
|
||||
# nthorne: shamelessly stolen from above..
|
||||
chmod -x .todo.actions.d/norris/norris
|
||||
# On Cygwin, clearing the executable flag may have no effect, as the Windows ACL
|
||||
# may still grant execution rights. In this case, we skip the test.
|
||||
if [ -x .todo.actions.d/norris/norris ]; then
|
||||
SKIP_TESTS="${SKIP_TESTS}${SKIP_TESTS+ }t8010.8"
|
||||
fi
|
||||
test_todo_session 'nonexecutable action in subfolder' <<EOF
|
||||
>>> todo.sh listaddons
|
||||
bar
|
||||
chuck
|
||||
ls
|
||||
quux
|
||||
EOF
|
||||
|
||||
test_done
|
||||
76
tests/t8020-actions-help.sh
Executable file
76
tests/t8020-actions-help.sh
Executable file
@@ -0,0 +1,76 @@
|
||||
#!/bin/bash
|
||||
|
||||
test_description='custom actions help functionality
|
||||
|
||||
This test checks listing the usage help of a custom action.
|
||||
'
|
||||
. ./actions-test-lib.sh
|
||||
. ./test-lib.sh
|
||||
|
||||
test_todo_session 'custom action help with no custom action directory' <<'EOF'
|
||||
>>> todo.sh help foo
|
||||
TODO: No action "foo" exists.
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
make_action "foo"
|
||||
make_action "bar"
|
||||
make_action "ls"
|
||||
make_action "quux"
|
||||
|
||||
test_todo_session 'custom action help' <<'EOF'
|
||||
>>> todo.sh help foo
|
||||
foo ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does foo.
|
||||
\
|
||||
|
||||
>>> todo.sh help bar
|
||||
bar ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does bar.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'multiple custom actions help' <<'EOF'
|
||||
>>> todo.sh help foo bar
|
||||
foo ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does foo.
|
||||
\
|
||||
bar ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does bar.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'nonexisting action help' <<'EOF'
|
||||
>>> todo.sh help doesnotexist
|
||||
TODO: No action "doesnotexist" exists.
|
||||
=== 1
|
||||
|
||||
>>> todo.sh help foo doesnotexist bar
|
||||
foo ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does foo.
|
||||
\
|
||||
TODO: No action "doesnotexist" exists.
|
||||
=== 1
|
||||
EOF
|
||||
|
||||
test_todo_session 'mixed built-in and custom actions help' <<'EOF'
|
||||
>>> todo.sh help foo shorthelp bar
|
||||
foo ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does foo.
|
||||
\
|
||||
shorthelp
|
||||
List the one-line usage of all built-in and add-on actions.
|
||||
\
|
||||
bar ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does bar.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_todo_session 'custom override of built-in action help' <<'EOF'
|
||||
>>> todo.sh help ls
|
||||
ls ITEM#[, ITEM#, ...] [TERM...]
|
||||
This custom action does ls.
|
||||
\
|
||||
EOF
|
||||
|
||||
test_done
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='basic tests imported from previous framework
|
||||
'
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
#
|
||||
# Copyright (c) 2005 Junio C Hamano
|
||||
#
|
||||
@@ -180,7 +180,7 @@ test_failure_ () {
|
||||
test_failure=$(($test_failure + 1))
|
||||
say_color error "FAIL $test_count: $1"
|
||||
shift
|
||||
echo "$@" | sed -e 's/^/ /'
|
||||
echo "$@"
|
||||
test "$immediate" = "" || { trap - EXIT; exit 1; }
|
||||
}
|
||||
|
||||
@@ -199,8 +199,9 @@ test_debug () {
|
||||
}
|
||||
|
||||
test_run_ () {
|
||||
eval >&3 2>&4 "$1"
|
||||
eval > output 2>&1 "$1"
|
||||
eval_ret="$?"
|
||||
cat >&3 output
|
||||
return 0
|
||||
}
|
||||
|
||||
@@ -260,6 +261,43 @@ test_expect_success () {
|
||||
echo >&3 ""
|
||||
}
|
||||
|
||||
test_expect_output () {
|
||||
test "$#" = 2 ||
|
||||
error "bug in the test script: not 2 parameters to test-expect-output"
|
||||
test_expect_code_and_output 0 "$@"
|
||||
}
|
||||
|
||||
test_expect_code_and_output () {
|
||||
test "$#" = 3 ||
|
||||
error "bug in the test script: not 3 parameters to test-expect-code-and-output"
|
||||
if ! test_skip "$@"
|
||||
then
|
||||
if [ "$1" = 0 ]; then
|
||||
say >&3 "expecting success and output: $3"
|
||||
else
|
||||
say >&3 "expecting exit code $1 and output: $3"
|
||||
fi
|
||||
test_run_ "$3"
|
||||
if [ "$?" = 0 -a "$eval_ret" = "$1" ]
|
||||
then
|
||||
cmp_output=$(test_cmp expect output)
|
||||
if [ "$?" = 0 ]
|
||||
then
|
||||
test_ok_ "$2"
|
||||
else
|
||||
test_failure_ "$2" "$3" "
|
||||
$cmp_output"
|
||||
fi
|
||||
else
|
||||
cmp_output=$(test_cmp expect output)
|
||||
test_failure_ "$2" "$3" "
|
||||
expected exit code $1, actual ${eval_ret}${cmp_output:+
|
||||
}${cmp_output}"
|
||||
fi
|
||||
fi
|
||||
echo >&3 ""
|
||||
}
|
||||
|
||||
test_expect_code () {
|
||||
test "$#" = 3 ||
|
||||
error "bug in the test script: not 3 parameters to test-expect-code"
|
||||
@@ -271,7 +309,8 @@ test_expect_code () {
|
||||
then
|
||||
test_ok_ "$2"
|
||||
else
|
||||
test_failure_ "$@"
|
||||
test_failure_ "$2" "$3" "
|
||||
expected exit code $1, actual ${eval_ret}"
|
||||
fi
|
||||
fi
|
||||
echo >&3 ""
|
||||
@@ -513,14 +552,16 @@ test_tick () {
|
||||
}
|
||||
|
||||
# Generate and run a series of tests based on a transcript.
|
||||
# Usage: test_todo_session "description" <<EOF
|
||||
# Usage: test_todo_session "description" <<'EOF'
|
||||
# >>> command
|
||||
# output1
|
||||
# output2
|
||||
#
|
||||
# >>> command
|
||||
# === exit status
|
||||
# output3
|
||||
# output4
|
||||
# output3 with empty line (must be escaped here)
|
||||
# \
|
||||
# output5
|
||||
# EOF
|
||||
test_todo_session () {
|
||||
test "$#" = 1 ||
|
||||
@@ -529,7 +570,7 @@ test_todo_session () {
|
||||
cmd=""
|
||||
status=0
|
||||
> expect
|
||||
while read -r line
|
||||
while IFS= read -r line
|
||||
do
|
||||
case $line in
|
||||
">>> "*)
|
||||
@@ -542,9 +583,9 @@ test_todo_session () {
|
||||
"")
|
||||
if [ ! -z "$cmd" ]; then
|
||||
if [ $status = 0 ]; then
|
||||
test_expect_success "$1 $subnum" "$cmd > output && test_cmp expect output"
|
||||
test_expect_output "$1 $subnum" "$cmd"
|
||||
else
|
||||
test_expect_success "$1 $subnum" "$cmd > output ; test \$? = $status && test_cmp expect output"
|
||||
test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
|
||||
fi
|
||||
|
||||
subnum=$(($subnum + 1))
|
||||
@@ -553,6 +594,9 @@ test_todo_session () {
|
||||
> expect
|
||||
fi
|
||||
;;
|
||||
\\)
|
||||
echo "" >> expect
|
||||
;;
|
||||
*)
|
||||
echo "$line" >> expect
|
||||
;;
|
||||
@@ -560,9 +604,9 @@ test_todo_session () {
|
||||
done
|
||||
if [ ! -z "$cmd" ]; then
|
||||
if [ $status = 0 ]; then
|
||||
test_expect_success "$1 $subnum" "$cmd > output && test_cmp expect output"
|
||||
test_expect_output "$1 $subnum" "$cmd"
|
||||
else
|
||||
test_expect_success "$1 $subnum" "$cmd > output ; test \$? = $status && test_cmp expect output"
|
||||
test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
|
||||
fi
|
||||
fi
|
||||
}
|
||||
@@ -579,6 +623,66 @@ EOF
|
||||
exit 0
|
||||
}
|
||||
|
||||
test_todo_custom_completion () {
|
||||
test "$#" = 4 ||
|
||||
error "bug in the test script: not 4 parameters to test_todo_custom_completion"
|
||||
completeFunc=$1
|
||||
shift
|
||||
if ! test_skip "$@"
|
||||
then
|
||||
description=$1
|
||||
expected=$3
|
||||
|
||||
if [ "${2: -1}" = ' ' ]
|
||||
then
|
||||
offset=0
|
||||
say >&3 "expecting completions after: '$2'"
|
||||
else
|
||||
offset=1
|
||||
say >&3 "expecting context completions for: '$2'"
|
||||
fi
|
||||
|
||||
SAVEIFS=$IFS
|
||||
IFS=' ' set -- $2
|
||||
COMP_WORDS=("$@")
|
||||
COMP_CWORD=$(($# - $offset))
|
||||
IFS=' ' eval "set -- $expected"
|
||||
EXPECT=("$@")
|
||||
|
||||
source "$TEST_DIRECTORY/../todo_completion"
|
||||
$completeFunc
|
||||
ret=$?
|
||||
if [ "$ret" = 0 ]
|
||||
then
|
||||
IFS=$'\n'
|
||||
printf "%s${EXPECT:+\\n}" "${EXPECT[*]}" > expect
|
||||
printf "%s${COMPREPLY:+\\n}" "${COMPREPLY[*]}" > compreply
|
||||
IFS=$SAVEIFS
|
||||
|
||||
if [ ${#COMPREPLY[@]} -eq ${#EXPECT[@]} ]
|
||||
then
|
||||
if [ "${COMPREPLY[*]}" = "${EXPECT[*]}" ]
|
||||
then
|
||||
test_ok_ "$description"
|
||||
else
|
||||
test_failure_ "$description" "$(test_cmp expect compreply)"
|
||||
fi
|
||||
else
|
||||
test_failure_ "$description" "expected ${#EXPECT[@]} completion(s), got ${#COMPREPLY[@]}:
|
||||
$(test_cmp expect compreply)"
|
||||
fi
|
||||
else
|
||||
test_failure_ "$description" "expected completions, actual exit code $ret"
|
||||
fi
|
||||
fi
|
||||
echo >&3 ""
|
||||
}
|
||||
test_todo_completion () {
|
||||
test "$#" = 3 ||
|
||||
error "bug in the test script: not 3 parameters to test_todo_completion"
|
||||
test_todo_custom_completion _todo "$@"
|
||||
}
|
||||
|
||||
test_init_todo "$test"
|
||||
# Use -P to resolve symlinks in our working directory so that the pwd
|
||||
# in subprocesses equals our $PWD (for pathname comparisons).
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
#!/bin/sh
|
||||
#!/bin/bash
|
||||
|
||||
test_description='Providing an interactive shell in the proper environment'
|
||||
. ./test-lib.sh
|
||||
|
||||
9
todo.cfg
9
todo.cfg
@@ -1,8 +1,8 @@
|
||||
# === EDIT FILE LOCATIONS BELOW ===
|
||||
|
||||
# Your todo.txt directory
|
||||
# Your todo.txt directory (this should be an absolute path)
|
||||
#export TODO_DIR="/Users/gina/Documents/todo"
|
||||
export TODO_DIR=`dirname "$0"`
|
||||
export TODO_DIR=$(dirname "$0")
|
||||
|
||||
# Your todo/done/report.txt locations
|
||||
export TODO_FILE="$TODO_DIR/todo.txt"
|
||||
@@ -62,6 +62,11 @@ export REPORT_FILE="$TODO_DIR/report.txt"
|
||||
#
|
||||
# export COLOR_DONE=$LIGHT_GREY
|
||||
|
||||
# There is highlighting for projects and contexts.
|
||||
#
|
||||
# export COLOR_PROJECT=$RED
|
||||
# export COLOR_CONTEXT=$RED
|
||||
|
||||
# === BEHAVIOR ===
|
||||
|
||||
## customize list output
|
||||
|
||||
252
todo.sh
252
todo.sh
@@ -13,10 +13,10 @@ version() {
|
||||
|
||||
First release: 5/11/2006
|
||||
Original conception by: Gina Trapani (http://ginatrapani.org)
|
||||
Contributors: http://github.com/ginatrapani/todo.txt-cli/network
|
||||
License: GPL, http://www.gnu.org/copyleft/gpl.html
|
||||
Contributors: https://github.com/ginatrapani/todo.txt-cli/network
|
||||
License: GPL, https://www.gnu.org/copyleft/gpl.html
|
||||
More information and mailing list at http://todotxt.com
|
||||
Code repository: http://github.com/ginatrapani/todo.txt-cli/tree/master
|
||||
Code repository: https://github.com/ginatrapani/todo.txt-cli/tree/master
|
||||
EndVersion
|
||||
exit 1
|
||||
}
|
||||
@@ -54,12 +54,13 @@ shorthelp()
|
||||
del|rm ITEM# [TERM]
|
||||
depri|dp ITEM#[, ITEM#, ITEM#, ...]
|
||||
do ITEM#[, ITEM#, ITEM#, ...]
|
||||
help
|
||||
help [ACTION...]
|
||||
list|ls [TERM...]
|
||||
listall|lsa [TERM...]
|
||||
listcon|lsc
|
||||
listaddons
|
||||
listcon|lsc [TERM...]
|
||||
listfile|lf [SRC [TERM...]]
|
||||
listpri|lsp [PRIORITY] [TERM...]
|
||||
listpri|lsp [PRIORITIES] [TERM...]
|
||||
listproj|lsprj [TERM...]
|
||||
move|mv ITEM# DEST [SRC]
|
||||
prepend|prep ITEM# "TEXT TO PREPEND"
|
||||
@@ -80,7 +81,6 @@ shorthelp()
|
||||
|
||||
See "help" for more details.
|
||||
EndHelpFooter
|
||||
exit 0
|
||||
}
|
||||
|
||||
help()
|
||||
@@ -136,7 +136,7 @@ help()
|
||||
|
||||
EndOptionsHelp
|
||||
|
||||
[ $TODOTXT_VERBOSE -gt 1 ] && cat <<-EndVerboseHelp
|
||||
[ $TODOTXT_VERBOSE -gt 1 ] && cat <<-'EndVerboseHelp'
|
||||
Environment variables:
|
||||
TODOTXT_AUTO_ARCHIVE is same as option -a (0)/-A (1)
|
||||
TODOTXT_CFG_FILE=CONFIG_FILE is same as option -d CONFIG_FILE
|
||||
@@ -149,9 +149,16 @@ help()
|
||||
TODOTXT_DEFAULT_ACTION="" run this when called with no arguments
|
||||
TODOTXT_SORT_COMMAND="sort ..." customize list output
|
||||
TODOTXT_FINAL_FILTER="sed ..." customize list after color, P@+ hiding
|
||||
TODOTXT_SOURCEVAR=\$DONE_FILE use another source for listcon, listproj
|
||||
|
||||
|
||||
EndVerboseHelp
|
||||
actionsHelp
|
||||
addonHelp
|
||||
}
|
||||
|
||||
actionsHelp()
|
||||
{
|
||||
cat <<-EndActionsHelp
|
||||
Built-in Actions:
|
||||
add "THING I NEED TO DO +project @context"
|
||||
@@ -198,8 +205,9 @@ help()
|
||||
do ITEM#[, ITEM#, ITEM#, ...]
|
||||
Marks task(s) on line ITEM# as done in todo.txt.
|
||||
|
||||
help
|
||||
Display this help message.
|
||||
help [ACTION...]
|
||||
Display help about usage, options, built-in and add-on actions,
|
||||
or just the usage help for the passed ACTION(s).
|
||||
|
||||
list [TERM...]
|
||||
ls [TERM...]
|
||||
@@ -218,9 +226,13 @@ help()
|
||||
TERM specified, lists entire todo.txt AND done.txt
|
||||
concatenated and sorted.
|
||||
|
||||
listcon
|
||||
lsc
|
||||
listaddons
|
||||
Lists all added and overridden actions in the actions directory.
|
||||
|
||||
listcon [TERM...]
|
||||
lsc [TERM...]
|
||||
Lists all the task contexts that start with the @ sign in todo.txt.
|
||||
If TERM specified, considers only tasks that contain TERM(s).
|
||||
|
||||
listfile [SRC [TERM...]]
|
||||
lf [SRC [TERM...]]
|
||||
@@ -231,18 +243,20 @@ help()
|
||||
Without any arguments, the names of all text files in the todo.txt
|
||||
directory are listed.
|
||||
|
||||
listpri [PRIORITY] [TERM...]
|
||||
lsp [PRIORITY] [TERM...]
|
||||
Displays all tasks prioritized PRIORITY.
|
||||
If no PRIORITY specified, lists all prioritized tasks.
|
||||
listpri [PRIORITIES] [TERM...]
|
||||
lsp [PRIORITIES] [TERM...]
|
||||
Displays all tasks prioritized PRIORITIES.
|
||||
PRIORITIES can be a single one (A) or a range (A-C).
|
||||
If no PRIORITIES specified, lists all prioritized tasks.
|
||||
If TERM specified, lists only prioritized tasks that contain TERM(s).
|
||||
Hides all tasks that contain TERM(s) preceded by a minus sign
|
||||
(i.e. -TERM).
|
||||
|
||||
listproj
|
||||
lsprj
|
||||
listproj [TERM...]
|
||||
lsprj [TERM...]
|
||||
Lists all the projects (terms that start with a + sign) in
|
||||
todo.txt.
|
||||
If TERM specified, considers only tasks that contain TERM(s).
|
||||
|
||||
move ITEM# DEST [SRC]
|
||||
mv ITEM# DEST [SRC]
|
||||
@@ -272,9 +286,6 @@ help()
|
||||
List the one-line usage of all built-in and add-on actions.
|
||||
|
||||
EndActionsHelp
|
||||
|
||||
addonHelp
|
||||
exit 1
|
||||
}
|
||||
|
||||
addonHelp()
|
||||
@@ -291,11 +302,50 @@ addonHelp()
|
||||
didPrintAddonActionsHeader=1
|
||||
fi
|
||||
"$action" usage
|
||||
elif [ -d "$action" -a -x "$action/$(basename $action)" ]; then
|
||||
if [ ! "$didPrintAddonActionsHeader" ]; then
|
||||
cat <<-EndAddonActionsHeader
|
||||
Add-on Actions:
|
||||
EndAddonActionsHeader
|
||||
didPrintAddonActionsHeader=1
|
||||
fi
|
||||
"$action/$(basename $action)" usage
|
||||
fi
|
||||
done
|
||||
fi
|
||||
}
|
||||
|
||||
actionUsage()
|
||||
{
|
||||
for actionName
|
||||
do
|
||||
action="${TODO_ACTIONS_DIR}/${actionName}"
|
||||
if [ -f "$action" -a -x "$action" ]; then
|
||||
"$action" usage
|
||||
elif [ -d "$action" -a -x "$action/$(basename $action)" ]; then
|
||||
"$action/$(basename $action)" usage
|
||||
else
|
||||
builtinActionUsage=$(actionsHelp | sed -n -e "/^ ${actionName//\//\\/} /,/^\$/p" -e "/^ ${actionName//\//\\/}$/,/^\$/p")
|
||||
if [ "$builtinActionUsage" ]; then
|
||||
echo "$builtinActionUsage"
|
||||
echo
|
||||
else
|
||||
die "TODO: No action \"${actionName}\" exists."
|
||||
fi
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
dieWithHelp()
|
||||
{
|
||||
case "$1" in
|
||||
help) help;;
|
||||
shorthelp) shorthelp;;
|
||||
esac
|
||||
shift
|
||||
|
||||
die "$@"
|
||||
}
|
||||
die()
|
||||
{
|
||||
echo "$*"
|
||||
@@ -383,21 +433,22 @@ replaceOrPrepend()
|
||||
else
|
||||
input=$*
|
||||
fi
|
||||
cleaninput "for sed"
|
||||
|
||||
# Retrieve existing priority and prepended date
|
||||
priority=$(sed -e "$item!d" -e $item's/^\((.) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\1/' "$TODO_FILE")
|
||||
prepdate=$(sed -e "$item!d" -e $item's/^\((.) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}.*/\2/' "$TODO_FILE")
|
||||
local -r priAndDateExpr='^\((.) \)\{0,1\}\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{0,1\}'
|
||||
priority=$(sed -e "$item!d" -e "${item}s/${priAndDateExpr}.*/\\1/" "$TODO_FILE")
|
||||
prepdate=$(sed -e "$item!d" -e "${item}s/${priAndDateExpr}.*/\\2/" "$TODO_FILE")
|
||||
|
||||
if [ "$prepdate" -a "$action" = "replace" ] && [ "$(echo "$input"|sed -e 's/^\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\}\)\{0,1\}.*/\1/')" ]; then
|
||||
# If the replaced text starts with a date, it will replace the existing
|
||||
# date, too.
|
||||
if [ "$prepdate" -a "$action" = "replace" ] && [ "$(echo "$input"|sed -e "s/${priAndDateExpr}.*/\\1\\2/")" ]; then
|
||||
# If the replaced text starts with a [priority +] date, it will replace
|
||||
# the existing date, too.
|
||||
prepdate=
|
||||
fi
|
||||
|
||||
# Temporarily remove any existing priority and prepended date, perform the
|
||||
# change (replace/prepend) and re-insert the existing priority and prepended
|
||||
# date again.
|
||||
cleaninput "for sed"
|
||||
sed -i.bak -e "$item s/^${priority}${prepdate}//" -e "$item s|^.*|${priority}${prepdate}${input}${backref}|" "$TODO_FILE"
|
||||
if [ $TODOTXT_VERBOSE -gt 0 ]; then
|
||||
getNewtodo "$item"
|
||||
@@ -426,6 +477,9 @@ OVR_TODOTXT_DEFAULT_ACTION="$TODOTXT_DEFAULT_ACTION"
|
||||
OVR_TODOTXT_SORT_COMMAND="$TODOTXT_SORT_COMMAND"
|
||||
OVR_TODOTXT_FINAL_FILTER="$TODOTXT_FINAL_FILTER"
|
||||
|
||||
# Prevent GREP_OPTIONS from malforming grep's output
|
||||
GREP_OPTIONS=""
|
||||
|
||||
# == PROCESS OPTIONS ==
|
||||
while getopts ":fhpcnNaAtTvVx+@Pd:" Option
|
||||
do
|
||||
@@ -482,6 +536,7 @@ do
|
||||
# Cannot just invoke shorthelp() because we need the configuration
|
||||
# processed to locate the add-on actions directory.
|
||||
set -- '-h' 'shorthelp'
|
||||
OPTIND=2
|
||||
;;
|
||||
n )
|
||||
OVR_TODOTXT_PRESERVE_LINE_NUMBERS=0
|
||||
@@ -539,6 +594,7 @@ TODOTXT_DEFAULT_ACTION=${TODOTXT_DEFAULT_ACTION:-}
|
||||
TODOTXT_SORT_COMMAND=${TODOTXT_SORT_COMMAND:-env LC_COLLATE=C sort -f -k2}
|
||||
TODOTXT_DISABLE_FILTER=${TODOTXT_DISABLE_FILTER:-}
|
||||
TODOTXT_FINAL_FILTER=${TODOTXT_FINAL_FILTER:-cat}
|
||||
TODOTXT_GLOBAL_CFG_FILE=${TODOTXT_GLOBAL_CFG_FILE:-/etc/todo/config}
|
||||
|
||||
# Export all TODOTXT_* variables
|
||||
export ${!TODOTXT_@}
|
||||
@@ -569,6 +625,10 @@ export PRI_B=$GREEN # color for B priority
|
||||
export PRI_C=$LIGHT_BLUE # color for C priority
|
||||
export PRI_X=$WHITE # color unless explicitly defined
|
||||
|
||||
# Default project and context colors.
|
||||
export COLOR_PROJECT=$NONE
|
||||
export COLOR_CONTEXT=$NONE
|
||||
|
||||
# Default highlight colors.
|
||||
export COLOR_DONE=$LIGHT_GREY # color for done (but not yet archived) tasks
|
||||
|
||||
@@ -596,6 +656,15 @@ export SENTENCE_DELIMITERS=',.:;'
|
||||
fi
|
||||
}
|
||||
|
||||
[ -e "$TODOTXT_CFG_FILE" ] || {
|
||||
CFG_FILE_ALT="${XDG_CONFIG_HOME:-$HOME/.config}/todo/config"
|
||||
|
||||
if [ -e "$CFG_FILE_ALT" ]
|
||||
then
|
||||
TODOTXT_CFG_FILE="$CFG_FILE_ALT"
|
||||
fi
|
||||
}
|
||||
|
||||
[ -e "$TODOTXT_CFG_FILE" ] || {
|
||||
CFG_FILE_ALT=$(dirname "$0")"/todo.cfg"
|
||||
|
||||
@@ -605,6 +674,15 @@ export SENTENCE_DELIMITERS=',.:;'
|
||||
fi
|
||||
}
|
||||
|
||||
[ -e "$TODOTXT_CFG_FILE" ] || {
|
||||
CFG_FILE_ALT="$TODOTXT_GLOBAL_CFG_FILE"
|
||||
|
||||
if [ -e "$CFG_FILE_ALT" ]
|
||||
then
|
||||
TODOTXT_CFG_FILE="$CFG_FILE_ALT"
|
||||
fi
|
||||
}
|
||||
|
||||
|
||||
if [ -z "$TODO_ACTIONS_DIR" -o ! -d "$TODO_ACTIONS_DIR" ]
|
||||
then
|
||||
@@ -621,8 +699,17 @@ fi
|
||||
fi
|
||||
}
|
||||
|
||||
[ -d "$TODO_ACTIONS_DIR" ] || {
|
||||
TODO_ACTIONS_DIR_ALT="${XDG_CONFIG_HOME:-$HOME/.config}/todo/actions"
|
||||
|
||||
if [ -d "$TODO_ACTIONS_DIR_ALT" ]
|
||||
then
|
||||
TODO_ACTIONS_DIR="$TODO_ACTIONS_DIR_ALT"
|
||||
fi
|
||||
}
|
||||
|
||||
# === SANITY CHECKS (thanks Karl!) ===
|
||||
[ -r "$TODOTXT_CFG_FILE" ] || die "Fatal Error: Cannot read configuration file $TODOTXT_CFG_FILE"
|
||||
[ -r "$TODOTXT_CFG_FILE" ] || dieWithHelp "$1" "Fatal Error: Cannot read configuration file $TODOTXT_CFG_FILE"
|
||||
|
||||
. "$TODOTXT_CFG_FILE"
|
||||
|
||||
@@ -661,12 +748,12 @@ fi
|
||||
ACTION=${1:-$TODOTXT_DEFAULT_ACTION}
|
||||
|
||||
[ -z "$ACTION" ] && usage
|
||||
[ -d "$TODO_DIR" ] || die "Fatal Error: $TODO_DIR is not a directory"
|
||||
( cd "$TODO_DIR" ) || die "Fatal Error: Unable to cd to $TODO_DIR"
|
||||
[ -d "$TODO_DIR" ] || mkdir -p $TODO_DIR 2> /dev/null || dieWithHelp "$1" "Fatal Error: $TODO_DIR is not a directory"
|
||||
( cd "$TODO_DIR" ) || dieWithHelp "$1" "Fatal Error: Unable to cd to $TODO_DIR"
|
||||
|
||||
[ -f "$TODO_FILE" ] || cp /dev/null "$TODO_FILE"
|
||||
[ -f "$DONE_FILE" ] || cp /dev/null "$DONE_FILE"
|
||||
[ -f "$REPORT_FILE" ] || cp /dev/null "$REPORT_FILE"
|
||||
[ -f "$TODO_FILE" -o -c "$TODO_FILE" ] || > "$TODO_FILE"
|
||||
[ -f "$DONE_FILE" -o -c "$DONE_FILE" ] || > "$DONE_FILE"
|
||||
[ -f "$REPORT_FILE" -o -c "$REPORT_FILE" ] || > "$REPORT_FILE"
|
||||
|
||||
if [ $TODOTXT_PLAIN = 1 ]; then
|
||||
for clr in ${!PRI_@}; do
|
||||
@@ -675,8 +762,13 @@ if [ $TODOTXT_PLAIN = 1 ]; then
|
||||
PRI_X=$NONE
|
||||
DEFAULT=$NONE
|
||||
COLOR_DONE=$NONE
|
||||
COLOR_PROJECT=$NONE
|
||||
COLOR_CONTEXT=$NONE
|
||||
fi
|
||||
|
||||
[[ "$HIDE_PROJECTS_SUBSTITUTION" ]] && COLOR_PROJECT="$NONE"
|
||||
[[ "$HIDE_CONTEXTS_SUBSTITUTION" ]] && COLOR_CONTEXT="$NONE"
|
||||
|
||||
_addto() {
|
||||
file="$1"
|
||||
input="$2"
|
||||
@@ -823,15 +915,38 @@ _format()
|
||||
return color
|
||||
}
|
||||
{
|
||||
clr = ""
|
||||
if (match($0, /^[0-9]+ x /)) {
|
||||
print highlight("COLOR_DONE") $0 highlight("DEFAULT")
|
||||
} else if (match($0, /^[0-9]+ \([A-Z]\)[[:space:]]/)) {
|
||||
clr = highlight("COLOR_DONE")
|
||||
} else if (match($0, /^[0-9]+ \([A-Z]\) /)) {
|
||||
clr = highlight("PRI_" substr($0, RSTART + RLENGTH - 3, 1))
|
||||
print \
|
||||
(clr ? clr : highlight("PRI_X")) \
|
||||
(ENVIRON["HIDE_PRIORITY_SUBSTITUTION"] == "" ? $0 : substr($0, 1, RLENGTH - 4) substr($0, RSTART + RLENGTH)) \
|
||||
highlight("DEFAULT")
|
||||
} else { print }
|
||||
clr = (clr ? clr : highlight("PRI_X"))
|
||||
if (ENVIRON["HIDE_PRIORITY_SUBSTITUTION"] != "") {
|
||||
$0 = substr($0, 1, RLENGTH - 4) substr($0, RSTART + RLENGTH)
|
||||
}
|
||||
}
|
||||
end_clr = (clr ? highlight("DEFAULT") : "")
|
||||
|
||||
prj_beg = highlight("COLOR_PROJECT")
|
||||
prj_end = (prj_beg ? (highlight("DEFAULT") clr) : "")
|
||||
|
||||
ctx_beg = highlight("COLOR_CONTEXT")
|
||||
ctx_end = (ctx_beg ? (highlight("DEFAULT") clr) : "")
|
||||
|
||||
gsub(/[ \t][ \t]*/, "\n&\n")
|
||||
len = split($0, words, /\n/)
|
||||
|
||||
printf "%s", clr
|
||||
for (i = 1; i <= len; ++i) {
|
||||
if (words[i] ~ /^[+].*[A-Za-z0-9_]$/) {
|
||||
printf "%s", prj_beg words[i] prj_end
|
||||
} else if (words[i] ~ /^[@].*[A-Za-z0-9_]$/) {
|
||||
printf "%s", ctx_beg words[i] ctx_end
|
||||
} else {
|
||||
printf "%s", words[i]
|
||||
}
|
||||
}
|
||||
printf "%s\n", end_clr
|
||||
}
|
||||
''' \
|
||||
| sed '''
|
||||
@@ -852,7 +967,17 @@ _format()
|
||||
fi
|
||||
}
|
||||
|
||||
export -f cleaninput getPrefix getTodo getNewtodo shellquote filtercommand _list getPadding _format die
|
||||
listWordsWithSigil()
|
||||
{
|
||||
sigil=$1
|
||||
shift
|
||||
|
||||
FILE=$TODO_FILE
|
||||
[ "$TODOTXT_SOURCEVAR" ] && eval "FILE=$TODOTXT_SOURCEVAR"
|
||||
eval "$(filtercommand 'cat "${FILE[@]}"' '' "$@")" | grep -o "[^ ]*${sigil}[^ ]\\+" | grep "^$sigil" | sort -u
|
||||
}
|
||||
|
||||
export -f cleaninput getPrefix getTodo getNewtodo shellquote filtercommand _list listWordsWithSigil getPadding _format die
|
||||
|
||||
# == HANDLE ACTION ==
|
||||
action=$( printf "%s\n" "$ACTION" | tr 'A-Z' 'a-z' )
|
||||
@@ -867,6 +992,10 @@ then
|
||||
shift
|
||||
## Reset action to new first argument
|
||||
action=$( printf "%s\n" "$1" | tr 'A-Z' 'a-z' )
|
||||
elif [ -d "$TODO_ACTIONS_DIR/$action" -a -x "$TODO_ACTIONS_DIR/$action/$action" ]
|
||||
then
|
||||
"$TODO_ACTIONS_DIR/$action/$action" "$@"
|
||||
exit $?
|
||||
elif [ -d "$TODO_ACTIONS_DIR" -a -x "$TODO_ACTIONS_DIR/$action" ]
|
||||
then
|
||||
"$TODO_ACTIONS_DIR/$action" "$@"
|
||||
@@ -1069,13 +1198,19 @@ case $action in
|
||||
;;
|
||||
|
||||
"help" )
|
||||
if [ -t 1 ] ; then # STDOUT is a TTY
|
||||
if which "${PAGER:-less}" >/dev/null 2>&1; then
|
||||
# we have a working PAGER (or less as a default)
|
||||
help | "${PAGER:-less}" && exit 0
|
||||
shift ## Was help; new $1 is first help topic / action name
|
||||
if [ $# -gt 0 ]; then
|
||||
# Don't use PAGER here; we don't expect much usage output from one / few actions.
|
||||
actionUsage "$@"
|
||||
else
|
||||
if [ -t 1 ] ; then # STDOUT is a TTY
|
||||
if which "${PAGER:-less}" >/dev/null 2>&1; then
|
||||
# we have a working PAGER (or less as a default)
|
||||
help | "${PAGER:-less}" && exit 0
|
||||
fi
|
||||
fi
|
||||
help # just in case something failed above, we go ahead and just spew to STDOUT
|
||||
fi
|
||||
help # just in case something failed above, we go ahead and just spew to STDOUT
|
||||
;;
|
||||
|
||||
"shorthelp" )
|
||||
@@ -1099,7 +1234,7 @@ case $action in
|
||||
TOTAL=$( sed -n '$ =' "$TODO_FILE" )
|
||||
PADDING=${#TOTAL}
|
||||
|
||||
post_filter_command="awk -v TOTAL=$TOTAL -v PADDING=$PADDING '{ \$1 = sprintf(\"%\" PADDING \"d\", (\$1 > TOTAL ? 0 : \$1)); print }' "
|
||||
post_filter_command="${post_filter_command:-}${post_filter_command:+ | }awk -v TOTAL=$TOTAL -v PADDING=$PADDING '{ \$1 = sprintf(\"%\" PADDING \"d\", (\$1 > TOTAL ? 0 : \$1)); print }' "
|
||||
cat "$TODO_FILE" "$DONE_FILE" | TODOTXT_VERBOSE=0 _format '' "$PADDING" "$@"
|
||||
|
||||
if [ $TODOTXT_VERBOSE -gt 0 ]; then
|
||||
@@ -1127,19 +1262,20 @@ case $action in
|
||||
;;
|
||||
|
||||
"listcon" | "lsc" )
|
||||
grep -o '[^ ]*@[^ ]\+' "$TODO_FILE" | grep '^@' | sort -u
|
||||
shift
|
||||
listWordsWithSigil '@' "$@"
|
||||
;;
|
||||
|
||||
"listproj" | "lsprj" )
|
||||
shift
|
||||
eval "$(filtercommand 'cat "$TODO_FILE"' '' "$@")" | grep -o '[^ ]*+[^ ]\+' | grep '^+' | sort -u
|
||||
listWordsWithSigil '+' "$@"
|
||||
;;
|
||||
|
||||
"listpri" | "lsp" )
|
||||
shift ## was "listpri", new $1 is priority to list or first TERM
|
||||
|
||||
pri=$(printf "%s\n" "$1" | tr 'a-z' 'A-Z' | grep '^[A-Z]$') && shift || pri="[A-Z]"
|
||||
post_filter_command="grep '^ *[0-9]\+ (${pri}) '"
|
||||
pri=$(printf "%s\n" "$1" | tr 'a-z' 'A-Z' | grep -e '^[A-Z]$' -e '^[A-Z]-[A-Z]$') && shift || pri="A-Z"
|
||||
post_filter_command="${post_filter_command:-}${post_filter_command:+ | }grep '^ *[0-9]\+ ([${pri}]) '"
|
||||
_list "$TODO_FILE" "$@"
|
||||
;;
|
||||
|
||||
@@ -1294,6 +1430,20 @@ note: PRIORITY must be anywhere from A to Z."
|
||||
fi
|
||||
;;
|
||||
|
||||
"listaddons" )
|
||||
if [ -d "$TODO_ACTIONS_DIR" ]; then
|
||||
cd "$TODO_ACTIONS_DIR" || exit $?
|
||||
for action in *
|
||||
do
|
||||
if [ -f "$action" -a -x "$action" ]; then
|
||||
echo "$action"
|
||||
elif [ -d "$action" -a -x "$action/$action" ]; then
|
||||
echo "$action"
|
||||
fi
|
||||
done
|
||||
fi
|
||||
;;
|
||||
|
||||
* )
|
||||
usage;;
|
||||
esac
|
||||
|
||||
@@ -11,32 +11,42 @@ _todo()
|
||||
local -r OPTS="-@ -@@ -+ -++ -d -f -h -p -P -PP -a -n -t -v -vv -V -x"
|
||||
local -r COMMANDS="\
|
||||
add a addto addm append app archive command del \
|
||||
rm depri dp do help list ls listall lsa listcon \
|
||||
rm depri dp do help list ls listaddons listall lsa listcon \
|
||||
lsc listfile lf listpri lsp listproj lsprj move \
|
||||
mv prepend prep pri p replace report shorthelp"
|
||||
local -r MOVE_COMMAND_PATTERN='^(move|mv)$'
|
||||
|
||||
# Add custom commands from add-ons, if installed.
|
||||
# TODO: Filter for executable flag of files found in $TODO_ACTIONS_DIR.
|
||||
local allCommands="$COMMANDS $('ls' "${TODO_ACTIONS_DIR:-$HOME/.todo.actions.d}/" 2>/dev/null)"
|
||||
|
||||
local _todo_sh=${_todo_sh:-todo.sh}
|
||||
local completions
|
||||
if [ $COMP_CWORD -eq 1 ]; then
|
||||
completions="$allCommands $OPTS"
|
||||
completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons) $OPTS"
|
||||
elif [[ $COMP_CWORD -gt 2 && ( \
|
||||
"${COMP_WORDS[COMP_CWORD-2]}" =~ ^(move|mv)$ || \
|
||||
"${COMP_WORDS[COMP_CWORD-3]}" =~ ^(move|mv)$ ) ]]; then
|
||||
"${COMP_WORDS[COMP_CWORD-2]}" =~ $MOVE_COMMAND_PATTERN || \
|
||||
"${COMP_WORDS[COMP_CWORD-3]}" =~ $MOVE_COMMAND_PATTERN ) ]]; then
|
||||
# "move ITEM# DEST [SRC]" has file arguments on positions 2 and 3.
|
||||
completions=$(TODOTXT_VERBOSE=0 todo.sh command listfile)
|
||||
completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listfile)
|
||||
else
|
||||
case "$prev" in
|
||||
command)
|
||||
completions=$COMMANDS;;
|
||||
help)
|
||||
completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons)";;
|
||||
addto|listfile|lf)
|
||||
completions=$(TODOTXT_VERBOSE=0 todo.sh command listfile);;
|
||||
-*) completions="$allCommands $OPTS";;
|
||||
completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listfile);;
|
||||
-*) completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons) $OPTS";;
|
||||
*) case "$cur" in
|
||||
+*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listproj);;
|
||||
@*) completions=$(TODOTXT_VERBOSE=0 todo.sh command listcon);;
|
||||
+*) completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listproj)
|
||||
COMPREPLY=( $( compgen -W "$completions" -- $cur ))
|
||||
[ ${#COMPREPLY[@]} -gt 0 ] && return 0
|
||||
# Fall back to projects extracted from done tasks.
|
||||
completions=$(eval 'TODOTXT_VERBOSE=0 TODOTXT_SOURCEVAR=\$DONE_FILE' $_todo_sh command listproj)
|
||||
;;
|
||||
@*) completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listcon)
|
||||
COMPREPLY=( $( compgen -W "$completions" -- $cur ))
|
||||
[ ${#COMPREPLY[@]} -gt 0 ] && return 0
|
||||
# Fall back to contexts extracted from done tasks.
|
||||
completions=$(eval 'TODOTXT_VERBOSE=0 TODOTXT_SOURCEVAR=\$DONE_FILE' $_todo_sh command listcon)
|
||||
;;
|
||||
*) if [[ "$cur" =~ ^[0-9]+$ ]]; then
|
||||
# Remove the (padded) task number; we prepend the
|
||||
# user-provided $cur instead.
|
||||
@@ -50,9 +60,9 @@ _todo()
|
||||
# Finally, limit the output to a single line just as
|
||||
# a safety check of the ls action output.
|
||||
local todo=$( \
|
||||
TODOTXT_VERBOSE=0 todo.sh -@ -+ -p -x command ls "^ *${cur} " | \
|
||||
sed -e 's/^ *[0-9]\+ //' -e 's/\((.) \)[0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} /\1/' \
|
||||
-e 's/\([xX] \)\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{1,2\}/\1/' \
|
||||
eval TODOTXT_VERBOSE=0 $_todo_sh '-@ -+ -p -x command ls "^ *${cur} "' | \
|
||||
sed -e 's/^ *[0-9]\{1,\} //' -e 's/^\((.) \)\{0,1\}[0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} /\1/' \
|
||||
-e 's/^\([xX] \)\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{1,2\}/\1/' \
|
||||
-e 's/[[:space:]]*$//' \
|
||||
-e '1q' \
|
||||
)
|
||||
@@ -74,6 +84,30 @@ _todo()
|
||||
return 0
|
||||
}
|
||||
complete -F _todo todo.sh
|
||||
|
||||
# If you define an alias (e.g. "t") to todo.sh, you need to explicitly enable
|
||||
# completion for it, too:
|
||||
#complete -F _todo t
|
||||
# It is recommended to put this line next to your alias definition in your
|
||||
# ~/.bashrc (or wherever else you're defining your alias). If you simply
|
||||
# uncomment it here, you will need to redo this on every todo.txt update!
|
||||
|
||||
# If you have renamed the todo.sh executable, or if it is not accessible through
|
||||
# PATH, you need to add and use a wrapper completion function, like this:
|
||||
#_todoElsewhere()
|
||||
#{
|
||||
# local _todo_sh='/path/to/todo2.sh'
|
||||
# _todo "$@"
|
||||
#}
|
||||
#complete -F _todoElsewhere /path/to/todo2.sh
|
||||
|
||||
# If you use aliases to use different configuration(s), you need to add and use
|
||||
# a wrapper completion function for each configuration if you want to complete
|
||||
# from the actual configured task locations:
|
||||
#alias todo2='todo.sh -d "$HOME/todo2.cfg"'
|
||||
#_todo2()
|
||||
#{
|
||||
# local _todo_sh='todo.sh -d "$HOME/todo2.cfg"'
|
||||
# _todo "$@"
|
||||
#}
|
||||
#complete -F _todo2 todo2
|
||||
|
||||
Reference in New Issue
Block a user