flo/todo.txt-cli
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

merge upstream/master

Browse Source
This commit is contained in:
Florian Tham
2024-02-29 15:07:09 +01:00
parent 19dde076cf fd753c6c2e
commit e6d80bac04
50 changed files with 851 additions and 345 deletions
Download Patch File Download Diff File Expand all files Collapse all files

0
CODE_OF_CONDUCT.md → .github/CODE_OF_CONDUCT.md vendored
View File

2
CONTRIBUTING.md → .github/CONTRIBUTING.md vendored
View File

@@ -93,5 +93,5 @@ The core team looks at Pull Requests on a regular basis. After feedback has been
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
[Code of Conduct]: ./CODE_OF_CONDUCT.md
[Gitter.im]: https://gitter.im/todotxt/

0
ISSUE_TEMPLATE.md → .github/ISSUE_TEMPLATE.md vendored
View File

2
PULL_REQUEST_TEMPLATE.md → .github/PULL_REQUEST_TEMPLATE.md vendored
View File

@@ -3,7 +3,7 @@
- [ ] Fork [the repository](https://github.com/todotxt/todo.txt-cli) and create your branch from `master`.
- [ ] If you've added code that should be tested, add tests!
- [ ] Ensure the test suite passes.
- [ ] Format your code with [ShellCheck](https://www.shellcheck.net/).
- [ ] Lint your code with [ShellCheck](https://www.shellcheck.net/).
- [ ] Include a human-readable description of what the pull request is trying to accomplish.
- [ ] Steps for the reviewer(s) on how they can manually QA the changes.
- [ ] Have a `fixes #XX` reference to the issue that this pull request fixes.

20
.github/workflows/tests.yml vendored Normal file
View File

@@ -0,0 +1,20 @@
name: CI
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
test:
strategy:
matrix:
platform: [ubuntu-20.04, macos-11]
runs-on: ${{ matrix.platform }}
steps:
- uses: actions/checkout@v2
- run: make
- run: make dist
- run: make test

6
.travis.yml
View File

@@ -1,6 +0,0 @@
# Note: "shell" would be more appropriate
language: python
install: make dist && sudo make install
script: make test

183
CHANGELOG.md
View File

@@ -1,4 +1,5 @@
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
@@ -6,14 +7,38 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
## [2.11.0] - 2018-03-26
### Added
- Added support for `$XDG_CONFIG_HOME` config file/actions location
- Created [CODE_OF_CONDUCT.md](/CODE_OF_CONDUCT.md) ([#217])
- Created [CHANGELOG.md](/CHANGELOG.md) ([#218])
## [2.12.0] - 2020-08-11
### Added
- Added default priority variable `TODOTXT_PRIORITY_ON_ADD` ([#246])
- Added `done` option as alias of `do` ([#169])
- Added macOS 10.15.x support ([#300])
- Highlighting of dates, metadata and item numbers ([#264])
- Minimal config file / default filenames (todo.txt, done.txt, report.txt) ([#289])
- Enable file completion for add-on actions via `_todo_file{1,2,3}_actions` ([#270])
- Allow to customize what can be before / inside / after `+project` and `@context` ([#271])
### Changed
- Read the task's name and uses as default ([#249])
- Updated interpreter reference to use environment variable ([#160])
- Allow setting of bash completion path ([#301])
### Fixes
- Fixed no end-of-line bug. Supports todos with no end-of-line. ([#295])
## [2.11.0] - 2018-03-26
### Added
- Added support for `$XDG_CONFIG_HOME` config file/actions location
- Created [CODE_OF_CONDUCT.md](.github/CODE_OF_CONDUCT.md) ([#217])
- Created [CHANGELOG.md](/CHANGELOG.md) ([#218])
### Changed
- Updated `add` command to accept lowercase priority ([#230])
- Clean tests and version file in Makefile. Don't ignore errors in tests.
- Updated [README.md](/README.md) ([#219])
@@ -21,12 +46,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Set the executable bit when preparing releases ([#156])
### Fixes
- Update links to use https
- Suppress todo.sh error messages when invoked during completion ([#8])
## [2.10.0] - 2013-12-06
### Added
- Enable term filtering for listcon.
- Add make install command.
- Enable use of global config file in `/etc/todo/config`. `make install` installs a global config file.
@@ -39,30 +66,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Place add-ons in subfolders (for easier git clone).
### Changed
- Improve code commenting/documentation.
- Refactor code for speed/better organization.
- Improve test coverage and test library.
### Removed
- Removed add date from line completion, ie, `todo.sh ls 10[tab]`.
### Fixed
- Properly replace date when replacing task with priority and date.
- Handle `-h`, `shorthelp`, and `help` when a Fatal Error happens.
- Fix `todo_completion` problem with Bash 3.1.
## [2.9.0] - 2012-04-08
### Added
- Added tab auto-completion of projects and contexts from `todo.txt` and `done.txt`. Type `@<Tab>` or `+<Tab>` while entering a task.
- Added new listaddons command displays installed addons.
- List priorities within a range using listpri. For example, to see tasks prioritized A-B, use `todo.sh listpri A-B`
### Fixed
- Fixed various cosmetic issues, bugs, and added developer test library enhancements.
## [2.8.0] - 2011-09-13
### Added
- `listpri`/`lsp` now filters by term. For example, `todo.sh lsp A book` will only return tasks prioritized `A` with the word book in them.
- Added support for todo directory paths with spaces in them.
- Tasks with priority included and auto prepend date on (`-t`) get the date where expected.
@@ -70,6 +104,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Made more parameters available to offer more control to custom actions (`-c`, `-A`, `-N`, `-T`)
### Changed
- Improved portability for Dropbox or USB key users. If not specified, todo.sh checks for a config file in its own directory; default todo.txt location is todo.sh's directory.
- Improved script performance thanks to optimized code
- Exposed `cleaninput()` for use in addons
@@ -80,6 +115,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Cleaner, simpler, modernized, optimized code
### Fixed
- Custom action output no longer prefaced by `TODO:` so it's easier to see when the core script vs. addon is performing an action
- `listpri` complains if specified priority is invalid
- Don't abort task listing when items contain certain escape sequences (`\c \033`)
@@ -87,31 +123,37 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Don't delete `|` (pipe) from task input
- `-+` and `-@` no longer break task coloring if context or project appears at the end of the line
## [2.7.0] - 2010-08-03
### Added
- Added generalization of the _PRI_X_ color support to all priorities
- Added highlighting of done, but not yet archived tasks via *COLOR_DONE*
- Added highlighting of done, but not yet archived tasks via _COLOR_DONE_
- Color map (BLACK, ...) now supports spaces in the color definitions, making it possible to override the default ANSI escape codes with e.g. Conky tags (`${color black}`)
### Changed
- Cleanup: help messages, consistent output messages
- Exporting `die()` function for use in custom commands
- `prepend` and `replace` actions keep prepended date, `append` considers sentence delimiters
- Tests: several regression tests added
## [2.6.0] - 2010-05-11
### Added
- Added a case for the fixed replace command.
### Changed
- Changed odd tabs to spaces.
- Faster help/useage document outputs.
- Faster help/usage document outputs.
- Consolidated `TODOTXT_VERBOSE` tests.
- Refactored various add functionality to one function.
- Updated `_list()` output to match updated `addto`.
### Fixed
- Quoting regexp to parse properly.
- Fixed erroneous hide/show comments.
- Correctly fixed regexp quoting issue for bash v3.1.x and v3.2.x.
@@ -120,7 +162,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Fixed bug for replace command.
## [2.5.0] - 2010-05-05
### Added
- Support use of `$HOME/.todo/` for all todo.sh configuration
- Added new multiple do capability to help message
- Added option to disable final filter
@@ -130,9 +174,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Added some additional mappings, plus a project context
### Changed
- Added 'silent' to a bunch of calls
### Fixed
- Fixing prepend and priority issue.
- Replace with `priority` set
- Multiple `do` items
@@ -144,19 +190,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Tasks whose `ID` begins with `0` ought to be ignored.
- Fixed auto-complete function name for contexts
## [2.4.0] - 2009-05-11
### Added
- Added support for `TODOTXT_FINAL_FILTER` to provide a final custom list filter.
- Added support for custom sorting (can set in `todo.cfg`)
- Added parameterize for `.todo.actions.d` directory
### Removed
- Removed annoying trailing space on `pri` tasks
- Don't set colors in default `todo.cfg`.
- Don't set sort command in default `todo.cfg`.
### Fixed
- `listcon` and `listproj` now work correctly on Mac OS X 10.5
- `pri` accepted priorities of more than a single letter
- Support commands combination for `TODOTXT_SORT_COMMAND`; e.g. piped commands can be used: `export TODOTXT_SORT_COMMAND=" env LC_COLLATE=C sort -f -k2 - | grep -m 10 ."`
@@ -165,7 +214,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Now throws an error if you try to prioritize with more than one letter, ie, `todo.sh pri AA` doesn't work any more.
## [2.3.0] - 2009-04-02
### Added
- Added hide priority, context, and projects options now enabled `-P`, `-@` and `-+`
- Enabled recursive call of todo.sh from add-ons
- Exported variables for use in add-ons
@@ -174,34 +225,40 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Added Makefile dist infrastructure for versioned releases in Downloads area on GitHub
### Changed
- Separated `_list` function for reuse by various versions of list command to reduce duplicate code
- Set `ls` as the default action
## [2.2.0] - 2009-03-??
### Fixed
- For awhile here during the GitHub transition, we stripped the version number from todo.sh and updated it kind of willy-nilly, so we're back-versioning all unversioned copies v 2.2.
## [2.1.0] - 2009-02-23
### Added
- Added "pluggability" with `~/.todo.actions.d/` support (via [Tammy and Ed](http://tech.groups.yahoo.com/group/todotxt/message/1739))
- Added `-t` param, off by default. When specified, it automatically prepends the current date to new todo's on add
- Searches for more Unix-y `~/.todo.cfg` if `~/todo.cfg` doesn't exist (via [Ed](http://tech.groups.yahoo.com/group/todotxt/message/1767))
### Fixed
- Corrected "ambiguous redirect" bug with done file (via [Jeff](http://tech.groups.yahoo.com/group/todotxt/message/1764))
- Corrected usage and help message with new params
- Corrected config file miscomment about colors
## [2.0.1] - 2009-02-17
### Fixed
- Restored `-d` parameter functionality broken in 2.0 (d'oh, thanks Jason, you made the changelog! )
## [2.0.0] - 2009-02-17
### Added
- Added `addto [DEST] "Text to add"` will append text to any file in the todo directory, like `ideas.txt` or `maybelater.txt`.
- Added `mv # [DEST]` will move a task from `todo.txt` to another file `[DEST]` in the todo directory, like if you decide your `"Learn French"` task should go into your `maybelater.txt` file.
- `depri #` removes priority from a task.
@@ -212,76 +269,92 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Auto-archive on task completion is now on by default; can be turned off with `-a` parameter.
### Changed
- Separated config file into a non hidden dot file.
### Fixed
- Better error handling throughout for all commands.
- Archive now defrags the file (removes blank lines; see line preservation option.)
- Using `/bin/bash` instead of `/bin/sh`
## [1.7.3] - 2006-07-29
### Added
- Added short action aliases – `add/a`, `list/ls`, `listpri/lsp`, `listall/lsa`, `prepend/prep`, `append/app`, `del/rm`
## [1.7.2] - 2006-07-28
### Added
- `listpri` automatically capitalizes lowercase priorities
- `listpri` now displays friendly error message, and the # of tasks returned in verbose mode
### Changed
- `do` action removes priority from task automatically
Update:
### Fixed
- Actions are now case-insensitive (ie, `todo.sh Add` will work)
## [1.7.1] - 2006-07-21
### Changed
- I'm a big dummy and didn't keep track of what I fixed here. Sorry!
## [1.7.0] - 2006-07-19
### Added
- Interactive `add`, `append`, `prepend`, and `replace` (tx, Ben!)
- Action `listall` displays tasks from both todo.txt and done.txt
- Option `-f` forces delete action and disables interactive input (for todobot.pl)
- Option `-h` displays full help message.
### Deprecated
- Option `-q` deprecated; Use `-v` to turn on verbose mode
### Changed
- A very short version of usage message displays by default instead of the long version.
- Comment in info about `.todo` file being required
### Fixed
- No colors display for done tasks (tx, Tanja!)
- Sort is now case-insensitive (tx, Lonnie!)
## [1.6.3] - 2006-07-06
### Added
- Line numbers now padded, up to 100 characters. (tx, Tanja!)
## [1.6.2] - 2006-07-05
### Fixed
- Windows config files with spaces now work (tx Ron)
## [1.6.1] - 2006-07-05
### Changed
- The default location of your `.todo` file is now `$HOME/.todo`
### Fixed
- No colors mode (`-p`) now works as expected
## [1.6.0] - 2006-07-04
### Added
- Action `prepend` adds text to an item at the beginning of the line.
- Configuration file is now separated from script into `.todo` file
- Specify a config file other than `.todo` using the `-d` option
@@ -289,89 +362,107 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Option `-V` shows version and license information.
### Changed
- The option to turn off colors is now `-p` (no longer `-nc` as in 1.5.2)
## [1.5.2] - 2006-06-26
### Fixed
- Items that start with `x ` (an x with a space after) are archived now to avoid lines that start with a word like `xander` from being archived. (tx, Tannie!)
- Report now only archives items that start with `x ` as well.
## [1.5.1] - 2006-06-26
### Fixed
- Items with an `x` in them at all were being deleted on archive with 1.5; all fixed now.
## [1.5.0] - 2006-06-24
### Added
- Option to turn off colors (to avoid characters in piped text files or IM bot), ie `todo.sh -nc [COMMAND]`
- A date is added to a completed todo, ie `x 2006-06-24` (tx SETH)
- Action `remdup` removes exact duplicate lines from todo.txt (tx Tannie)
- Action `del` removes any blank lines from todo.txt (tx Tannie)
### Changed
- Using `sed -i` instead of copying tmp file (tx Tannie)
### Fixed
- Colors show in OS/X 10.4 (tx SETH & misha)
## [1.4.0] - 2006-06-17
### Added
- Tasks are color-coded by priority in Cygwin (Thanks, Abraham, Manuel and Luis!)
### Changed
- Switched endless `if-then` to a `case` statement, and tightened up `wc -l` regex. (Thanks, Sash!)
### Fixed
- If you `replace`/`do`/`append` to a non-existent task, your todo.txt is no longer overwritten and the error is handled gracefully. (Thanks, Scott!)
## [1.3.0] - 2006-05-29
### Added
- Displays the number of newly added todo (Thanks, Amy!)
- Confirms whether or not you really want to delete a todo
- Displays success messages and confirmations on `append`, `replace`, `do`, etc.
- Added licensing information in comments. GPL, baby!
### Changed
- Alphabetized command workflow in if/then construction
- Tightened up `sed` commands, removed unnecessary `grep`s and `cat`s (Thanks, Sash!)
- Stripped whitespace around number lines from wc results
### Removed
- Removed filenames from `report.txt` format, for easier graphing or Excel imports.
### Fixed
- Todos are now sorted alphabetically when listed by a term. (ie: `todo list flowers)
## [1.2.0] - 2006-05-15
### Added
- `list` is case insenstive. ie, `todo list Mac` will match lines with "mac" and "Mac"
- `list` is case insensitive. ie, `todo list Mac` will match lines with "mac" and "Mac"
### Changed
- `todo list` matches multiple [TERM]s. ie, `todo list mac offline` will match all lines that contain the words "mac" and "offline"
- `repri` and `pri` actions combined into `pri` action (Thanks Mike!)
- Quotes no longer required with `add` and `replace` (Thanks Karl!)
- Any priority added to a todo must be uppercase to preserve sort order, enforced now. ie `todo pri 1 a` will return a usage error.
### Fixed
- File "sanity checks" and cleanup function, test script and various fantastic stylistic improvements added. Extra big thanks to Karl!
## [1.1.0] - 2006-05-12
### Added
- Supports file paths with spaces (ie `C:\Documents and Settings\gina\todo.txt`)
## 1.0.0 - 2006-05-11
### Added
- Consolidated into one master script with usage notes and released.
[Unreleased]: https://github.com/todotxt/todo.txt-cli/compare/v2.11.0...HEAD
[Unreleased]: https://github.com/todotxt/todo.txt-cli/compare/v2.12.0...HEAD
[2.12.0]: https://github.com/todotxt/todo.txt-cli/compare/v2.11.0...v2.12.0
[2.11.0]: https://github.com/todotxt/todo.txt-cli/compare/v2.10.0...v2.11.0
[2.10.0]: https://github.com/todotxt/todo.txt-cli/compare/v2.9.0...v2.10.0
[2.9.0]: https://github.com/todotxt/todo.txt-cli/compare/v2.8.0...v2.9.0
@@ -400,11 +491,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
[1.3.0]: https://github.com/todotxt/todo.txt-cli/compare/v1.2.0...v1.3.0
[1.2.0]: https://github.com/todotxt/todo.txt-cli/compare/v1.1.0...v1.2.0
[1.1.0]: https://github.com/todotxt/todo.txt-cli/compare/v1.0.0...v1.1.0
[#230]: https://github.com/todotxt/todo.txt-cli/pull/230
[#228]: https://github.com/todotxt/todo.txt-cli/pull/228
[#219]: https://github.com/todotxt/todo.txt-cli/pull/219
[#218]: https://github.com/todotxt/todo.txt-cli/pull/218
[#217]: https://github.com/todotxt/todo.txt-cli/pull/217
[#156]: https://github.com/todotxt/todo.txt-cli/pull/156
[#8]: https://github.com/todotxt/todo.txt-cli/pull/8
[#156]: https://github.com/todotxt/todo.txt-cli/pull/156
[#160]: https://github.com/todotxt/todo.txt-cli/pull/160
[#169]: https://github.com/todotxt/todo.txt-cli/pull/169
[#217]: https://github.com/todotxt/todo.txt-cli/pull/217
[#218]: https://github.com/todotxt/todo.txt-cli/pull/218
[#219]: https://github.com/todotxt/todo.txt-cli/pull/219
[#228]: https://github.com/todotxt/todo.txt-cli/pull/228
[#230]: https://github.com/todotxt/todo.txt-cli/pull/230
[#246]: https://github.com/todotxt/todo.txt-cli/pull/246
[#249]: https://github.com/todotxt/todo.txt-cli/pull/249
[#264]: https://github.com/todotxt/todo.txt-cli/pull/264
[#270]: https://github.com/todotxt/todo.txt-cli/pull/270
[#271]: https://github.com/todotxt/todo.txt-cli/pull/271
[#289]: https://github.com/todotxt/todo.txt-cli/pull/289
[#295]: https://github.com/todotxt/todo.txt-cli/pull/295
[#300]: https://github.com/todotxt/todo.txt-cli/pull/300
[#301]: https://github.com/todotxt/todo.txt-cli/pull/301

2
GEN-VERSION-FILE
View File

@@ -34,5 +34,3 @@ test "$VN" = "$VC" || {
echo >&2 "VERSION=$VN"
echo "VERSION=$VN" >$VF
}

34
Makefile
View File

@@ -10,13 +10,28 @@ INSTALL_DATA = $(INSTALL) -m 644
prefix = /usr/local
# ifdef check allows the user to pass custom dirs
# as per the README
# The directory to install todo.sh in.
bindir = $(prefix)/bin
ifdef INSTALL_DIR
bindir = $(INSTALL_DIR)
else
bindir = $(prefix)/bin
endif
# The directory to install the config file in.
sysconfdir = $(prefix)/etc
ifdef CONFIG_DIR
sysconfdir = $(CONFIG_DIR)
else
sysconfdir = $(prefix)/etc
endif
datarootdir = $(prefix)/share
ifdef BASH_COMPLETION
datarootdir = $(BASH_COMPLETION)
else
datarootdir = $(prefix)/share/bash_completion.d
endif
# Dynamically detect/generate version file as necessary
# This file will define a variable called VERSION.
@@ -37,9 +52,9 @@ dist: $(DISTFILES) todo.sh
cp -f $(DISTFILES) $(DISTNAME)/
sed -e 's/@DEV_VERSION@/'$(VERSION)'/' todo.sh > $(DISTNAME)/todo.sh
chmod +x $(DISTNAME)/todo.sh
tar cf $(DISTNAME).tar $(DISTNAME)/
tar cf $(DISTNAME).tar $(DISTNAME)
gzip -f -9 $(DISTNAME).tar
zip -9r $(DISTNAME).zip $(DISTNAME)/
zip -r -9 $(DISTNAME).zip $(DISTNAME)
rm -r $(DISTNAME)
.PHONY: clean
@@ -49,22 +64,22 @@ clean: test-pre-clean
install: installdirs
$(INSTALL_PROGRAM) todo.sh $(DESTDIR)$(bindir)/todo.sh
$(INSTALL_DATA) todo_completion $(DESTDIR)$(datarootdir)/bash_completion.d/todo
$(INSTALL_DATA) todo_completion $(DESTDIR)$(datarootdir)/todo
[ -e $(DESTDIR)$(sysconfdir)/todo/config ] || \
sed "s/^\(export[ \t]*TODO_DIR=\).*/\1~\/.todo/" todo.cfg > $(DESTDIR)$(sysconfdir)/todo/config
uninstall:
rm -f $(DESTDIR)$(bindir)/todo.sh
rm -f $(DESTDIR)$(datarootdir)/bash_completion.d/todo
rm -f $(DESTDIR)$(datarootdir)/todo
rm -f $(DESTDIR)$(sysconfdir)/todo/config
rmdir $(DESTDIR)$(datarootdir)/bash_completion.d
rmdir $(DESTDIR)$(datarootdir)
rmdir $(DESTDIR)$(sysconfdir)/todo
installdirs:
mkdir -p $(DESTDIR)$(bindir) \
$(DESTDIR)$(sysconfdir)/todo \
$(DESTDIR)$(datarootdir)/bash_completion.d
$(DESTDIR)$(datarootdir)
#
# Testing
@@ -86,3 +101,4 @@ test: aggregate-results
# Force tests to get run every time
.PHONY: test test-pre-clean aggregate-results $(TESTS)

26
README.md
View File

@@ -2,7 +2,7 @@
> A simple and extensible shell script for managing your todo.txt file.
[![Build Status](https://travis-ci.org/todotxt/todo.txt-cli.svg?branch=master)](https://travis-ci.org/todotxt/todo.txt-cli)
![CI](https://github.com/todotxt/todo.txt-cli/workflows/CI/badge.svg)
[![GitHub issues](https://img.shields.io/github/issues/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/issues)
[![GitHub forks](https://img.shields.io/github/forks/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/network)
[![GitHub stars](https://img.shields.io/github/stars/todotxt/todo.txt-cli.svg)](https://github.com/todotxt/todo.txt-cli/stargazers)
@@ -11,7 +11,7 @@
![gif](./.github/example.gif)
*Read our [contributing guide](CONTRIBUTING.md) if you're looking to contribute (issues/PRs/etc).*
*Read our [contributing guide][CONTRIBUTING] if you're looking to contribute (issues/PRs/etc).*
## Installation
@@ -23,8 +23,16 @@ Download the latest stable [release][release] for use on your desktop or server.
```shell
brew install todo-txt
# For macOS on x86 CPU
cp -n /usr/local/opt/todo-txt/todo.cfg ~/.todo.cfg
# For macOS on arm CPU
cp -n /opt/homebrew/opt/todo-txt/todo.cfg ~/.todo.cfg
```
**Note**: The `-n` flag for `cp` makes sure you do not overwrite an existing file.
### Linux
#### From command line
@@ -42,12 +50,12 @@ make test
- `BASH_COMPLETION`: PATH for autocompletion scripts (default to /etc/bash_completion.d)
```shell
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION_DIR=/usr/share/bash-completion/completions
make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bash-completion/completions
```
#### Arch Linux (AUR)
https://aur.archlinux.org/packages/todotxt-git/
https://aur.archlinux.org/packages/todotxt/
## Usage
@@ -71,8 +79,8 @@ See [CHANGELOG.md][CHANGELOG]
## Support
- [Github Discussions](https://github.com/todotxt/todo.txt-cli/discussions)
- [Stack Overflow](https://stackoverflow.com/questions/tagged/todotxt)
- [Gitter chat](https://gitter.im/todotxt/todo.txt-cli)
- [Twitter](https://twitter.com/todotxt)
@@ -82,7 +90,7 @@ See [CHANGELOG.md][CHANGELOG]
## Contributing
We welcome all contributations. First read our [Contributor Code of Conduct][CODE_OF_CONDUCT] and then get started [contributing][CONTRIBUTING].
We welcome all contributions. First read our [Contributor Code of Conduct][CODE_OF_CONDUCT] and then get started [contributing][CONTRIBUTING].
## License
@@ -91,9 +99,9 @@ GNU General Public License v3.0 © [todo.txt org][github]
[release]: https://github.com/todotxt/todo.txt-cli/releases
[website]: http://todotxt.org
[website]: http://todotxt.org/
[github]: https://github.com/todotxt
[USAGE]: ./USAGE.md
[CHANGELOG]: ./CHANGELOG.md
[CODE_OF_CONDUCT]: ./CODE_OF_CONDUCT.md
[CONTRIBUTING]: ./CONTRIBUTING.md
[CODE_OF_CONDUCT]: .github/CODE_OF_CONDUCT.md
[CONTRIBUTING]: .github/CONTRIBUTING.md

4
USAGE.md
View File

@@ -104,7 +104,7 @@ todo.sh help [ACTION...]
Displays all tasks that contain TERM(s) sorted by priority with line numbers. Each task must match all TERM(s) (logical AND); to display tasks that contain any TERM (logical OR), use `"TERM1\|TERM2\|..."` (with quotes), or `TERM1\\|TERM2` (unquoted). Hides all tasks that contain TERM(s) preceded by a minus sign (i.e. `-TERM`).
If no TERM specified, lists entire todo.txt.
​
```shell
todo.sh list [TERM...]
todo.sh ls [TERM...]
@@ -221,7 +221,7 @@ Hide project names in list output. Use twice to show project names (default).
Color mode
### `-d CONFIG_FILE`
Use a configuration file other than the default `~/.todo/config`
Use a configuration file other than one of the defaults (e.g. `~/.todo/config`)
### `-f`
Forces actions without confirmation or interactive input.

2
tests/README
View File

@@ -266,7 +266,7 @@ and the dates and timestamps will be artificially fixed.
Then the session can be used to make a unit test thanks to
test_todo_session, see the existing tests as examples.
Be careful to replace all occurences of the full path to the test
Be careful to replace all occurrences of the full path to the test
directory by $HOME as testshell.sh will explain you when you execute it
otherwise the tests will work properly only on your own computer.

2
tests/actions-test-lib.sh
View File

@@ -21,7 +21,7 @@ make_action_in_folder()
{
unset TODO_ACTIONS_DIR
[ -d .todo.actions.d ] || mkdir .todo.actions.d
mkdir .todo.actions.d/$1
mkdir ".todo.actions.d/$1"
cat > ".todo.actions.d/$1/$1" <<EOF
#!/bin/bash
[ "\$1" = "usage" ] && {

12
tests/aggregate-results.sh
View File

@@ -15,7 +15,7 @@ case "$1" in
esac
if test -n "$color"; then
say_color () {
say_color() {
(
export TERM
case "$1" in
@@ -67,15 +67,15 @@ do
'')
continue ;;
fixed)
fixed=$(($fixed + $value)) ;;
fixed=$((fixed + $value)) ;;
success)
success=$(($success + $value)) ;;
success=$((success + $value)) ;;
failed)
failed=$(($failed + $value)) ;;
failed=$((failed + $value)) ;;
broken)
broken=$(($broken + $value)) ;;
broken=$((broken + $value)) ;;
total)
total=$(($total + $value)) ;;
total=$((total + $value)) ;;
esac
done <"$file"
done

18
tests/t0000-config.sh
View File

@@ -20,12 +20,12 @@ test_expect_success 'no config file' '
'
# All the below tests will output the usage message.
cat > expect << EOF
cat > expect <<EOF
Usage: todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]
Try 'todo.sh -h' for more information.
EOF
cat > test.cfg << EOF
cat > test.cfg <<EOF
export TODO_DIR=.
export TODO_FILE="\$TODO_DIR/todo.txt"
export DONE_FILE="\$TODO_DIR/done.txt"
@@ -79,4 +79,18 @@ test_expect_success 'config file (env variable)' '
test_cmp expect output && test -f used_config
'
cat > minimal.cfg <<EOF
export TODO_DIR=.
touch used_config
EOF
rm -f used_config
test_expect_success 'config file (minimal)' '
mkdir .todo
cp minimal.cfg .todo/config
todo.sh > output;
test_cmp expect output && test -f used_config &&
rm -rf .todo
'
test_done

1
tests/t0001-null.sh
View File

@@ -59,7 +59,6 @@ test_expect_success 'null list filter' '
todo.sh listall filter > output && test_cmp expect output
'
#
# lsc|listcon
#

4
tests/t0002-actions.sh
View File

@@ -7,11 +7,11 @@ This test just makes sure that todo.sh can locate custom actions.
. ./test-lib.sh
# All the below tests will output the custom action message
cat > expect << EOF
cat > expect <<EOF
TODO: foo
EOF
cat > foo << EOF
cat > foo <<EOF
echo "TODO: foo"
EOF
chmod +x foo

13
tests/t1000-addlist.sh
View File

@@ -110,4 +110,17 @@ TODO: 1 added.
--
TODO: 1 of 1 tasks shown
EOF
echo -n 'this is a first task without newline' > todo.txt
test_todo_session 'add to file without EOL' <<EOF
>>> todo.sh add "a second task"
2 a second task
TODO: 2 added.
>>> todo.sh list
2 a second task
1 this is a first task without newline
--
TODO: 2 of 2 tasks shown
EOF

4
tests/t1100-replace.sh
View File

@@ -45,7 +45,7 @@ grow some corn
thrash some hay
chase the chickens
EOF
test_todo_session 'replace error' << EOF
test_todo_session 'replace error' <<EOF
>>> todo.sh replace 10 "hej!"
=== 1
TODO: No task 10.
@@ -82,7 +82,7 @@ TODO: Replaced task with:
EOF
echo 'jump on hay' > todo.txt
test_todo_session 'replace with &' << EOF
test_todo_session 'replace with &' <<EOF
>>> todo.sh replace 1 "thrash the hay & thrash the wheat"
1 jump on hay
TODO: Replaced task with:

37
tests/t1200-pri.sh
View File

@@ -6,7 +6,7 @@ test_description='basic priority functionality
test_todo_session 'priority usage' <<EOF
>>> todo.sh pri B B
usage: todo.sh pri ITEM# PRIORITY
usage: todo.sh pri ITEM# PRIORITY[, ITEM# PRIORITY, ...]
note: PRIORITY must be anywhere from A to Z.
=== 1
EOF
@@ -100,4 +100,39 @@ TODO: 2 already prioritized (A).
--
TODO: 3 of 3 tasks shown
EOF
cat > todo.txt <<EOF
smell the uppercase Roses +flowers @outside
notice the sunflowers
stop
EOF
test_todo_session 'multiple priority' <<EOF
>>> todo.sh pri 1 A 2 B
1 (A) smell the uppercase Roses +flowers @outside
TODO: 1 prioritized (A).
2 (B) notice the sunflowers
TODO: 2 prioritized (B).
EOF
test_todo_session 'multiple reprioritize' <<EOF
>>> todo.sh pri 1 Z 2 X
1 (Z) smell the uppercase Roses +flowers @outside
TODO: 1 re-prioritized from (A) to (Z).
2 (X) notice the sunflowers
TODO: 2 re-prioritized from (B) to (X).
EOF
test_todo_session 'multiple prioritize error' <<EOF
>>> todo.sh pri 1 B 4 B
=== 1
1 (B) smell the uppercase Roses +flowers @outside
TODO: 1 re-prioritized from (Z) to (B).
TODO: No task 4.
>>> todo.sh pri 1 C 4 B 3 A
=== 1
1 (C) smell the uppercase Roses +flowers @outside
TODO: 1 re-prioritized from (B) to (C).
TODO: No task 4.
EOF
test_done

2
tests/t1300-ls.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='list functionality
@@ -162,7 +161,6 @@ TODO: 1 of 5 tasks shown
TODO: 1 of 5 tasks shown
EOF
#
# check the x command line option
#

42
tests/t1310-listcon.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='listcon functionality
@@ -65,6 +64,47 @@ test_todo_session 'listcon with project' <<EOF
@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

29
tests/t1320-listproj.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='listproj functionality
@@ -75,6 +74,33 @@ test_todo_session 'listproj with context' <<EOF
+sunflowers
EOF
cat > todo.txt <<EOF
(B) give a +1 to this project
(C) notice the sunflowers +sunflowers [+gardening] [+landscape]
stop
EOF
test_todo_session 'listproj with default configuration' <<EOF
>>> todo.sh listproj
+1
+sunflowers
EOF
test_todo_session 'listproj limiting to alphabetic characters' <<EOF
>>> TODOTXT_SIGIL_VALID_PATTERN='[a-zA-Z]\{1,\}' todo.sh listproj
+sunflowers
EOF
test_todo_session 'listproj allowing brackets around projects' <<EOF
>>> TODOTXT_SIGIL_BEFORE_PATTERN='\[\{0,1\}' TODOTXT_SIGIL_AFTER_PATTERN='\]\{0,1\}' todo.sh listproj
+1
+gardening
+landscape
+sunflowers
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_CUSTOM=todo-custom.cfg
cat todo.cfg > "$TEST_TODO_CUSTOM"
cat >> "$TEST_TODO_CUSTOM" <<'EOF'
@@ -90,7 +116,6 @@ test_todo_session 'listproj with context special cases' <<EOF
+sunflowers
EOF
cat > todo.txt <<EOF
+prj01 -- Some project 1 task
EOF

1
tests/t1330-ls-highlighting.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='list highlighting

1
tests/t1340-listescapes.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='list with escape sequences

1
tests/t1360-ls-project-context-highlighting.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='highlighting projects and contexts

43
tests/t1380-ls-date-number-metadata-highlighting.sh Executable file
View File

@@ -0,0 +1,43 @@
#!/bin/bash
test_description='highlighting date, item numbers and metadata
This test checks the highlighting (with colors) of dates, item numbers and metadata
'
. ./test-lib.sh
# Tasks with dates and metadata
cat > todo.txt <<EOF
2018-11-11 task with date
task with metadata due:2018-12-31
task without date and without metadata
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_DATE='\\\\033[0;31m'" >>"$TEST_TODO_LABEL_COLORS"
echo "export COLOR_META='\\\\033[0;32m'" >>"$TEST_TODO_LABEL_COLORS"
echo "export COLOR_NUMBER='\\\\033[0;34m'" >>"$TEST_TODO_LABEL_COLORS"
test_todo_session 'highlighting for date, item numbers and metadata' <<'EOF'
>>> todo.sh -d "$TEST_TODO_LABEL_COLORS" ls
1 2018-11-11 task with date
2 task with metadata due:2018-12-31
3 task without date and without metadata
--
TODO: 3 of 3 tasks shown
EOF
test_todo_session 'suppressing highlighting for date, item numbers and metadata' <<'EOF'
>>> todo.sh -p -d "$TEST_TODO_LABEL_COLORS" ls
1 2018-11-11 task with date
2 task with metadata due:2018-12-31
3 task without date and without metadata
--
TODO: 3 of 3 tasks shown
EOF
test_done

1
tests/t1500-do.sh
View File

@@ -83,4 +83,5 @@ TODO: 3 marked as done.
>>> todo.sh -a do 3
TODO: 3 is already marked done.
EOF
test_done

2
tests/t1600-append.sh
View File

@@ -17,7 +17,7 @@ test_todo_session 'append usage' <<EOF
usage: todo.sh append ITEM# "TEXT TO APPEND"
EOF
test_todo_session 'append error' << EOF
test_todo_session 'append error' <<EOF
>>> todo.sh append 10 "hej!"
=== 1
TODO: No task 10.

46
tests/t1800-del.sh
View File

@@ -4,6 +4,8 @@ test_description='basic del functionality
'
. ./test-lib.sh
SPACE=' '
test_todo_session 'del usage' <<EOF
>>> todo.sh del B
usage: todo.sh del ITEM# [TERM]
@@ -44,6 +46,50 @@ TODO: 1 deleted.
TODO: 2 of 2 tasks shown
EOF
cat > todo.txt <<EOF
(B) smell the uppercase Roses +flowers @outside
(A) notice the sunflowers
stop
EOF
test_todo_session 'del with confirmation' <<EOF
>>> todo.sh -p list
2 (A) notice the sunflowers
1 (B) smell the uppercase Roses +flowers @outside
3 stop
--
TODO: 3 of 3 tasks shown
>>> printf n | todo.sh del 1
Delete '(B) smell the uppercase Roses +flowers @outside'? (y/n)$SPACE
TODO: No tasks were deleted.
>>> todo.sh -p list
2 (A) notice the sunflowers
1 (B) smell the uppercase Roses +flowers @outside
3 stop
--
TODO: 3 of 3 tasks shown
>>> printf x | todo.sh del 1
Delete '(B) smell the uppercase Roses +flowers @outside'? (y/n)$SPACE
TODO: No tasks were deleted.
>>> echo | todo.sh del 1
Delete '(B) smell the uppercase Roses +flowers @outside'? (y/n)$SPACE
TODO: No tasks were deleted.
>>> printf y | todo.sh del 1
Delete '(B) smell the uppercase Roses +flowers @outside'? (y/n)$SPACE
1 (B) smell the uppercase Roses +flowers @outside
TODO: 1 deleted.
>>> todo.sh -p list
2 (A) notice the sunflowers
3 stop
--
TODO: 2 of 2 tasks shown
EOF
cat > todo.txt <<EOF
(B) smell the uppercase Roses +flowers @outside
(A) notice the sunflowers

102
tests/t1850-move.sh Executable file
View File

@@ -0,0 +1,102 @@
#!/bin/bash
test_description='basic move functionality
'
. ./test-lib.sh
SPACE=' '
cat > todo.txt <<EOF
(B) smell the uppercase Roses +flowers @outside
(A) notice the sunflowers
EOF
cat > done.txt <<EOF
x 2009-02-13 make the coffee +wakeup
x 2009-02-13 smell the coffee +wakeup
EOF
test_todo_session 'basic move with implicit source' <<EOF
>>> todo.sh -f move 1 done.txt | sed "s#'[^']\{1,\}/\([^/']\{1,\}\)'#'\1'#g"
1 (B) smell the uppercase Roses +flowers @outside
TODO: 1 moved from 'todo.txt' to 'done.txt'.
>>> todo.sh -p ls
2 (A) notice the sunflowers
--
TODO: 1 of 1 tasks shown
>>> todo.sh -p listfile done.txt
3 (B) smell the uppercase Roses +flowers @outside
1 x 2009-02-13 make the coffee +wakeup
2 x 2009-02-13 smell the coffee +wakeup
--
DONE: 3 of 3 tasks shown
EOF
cat > todo.txt <<EOF
(B) smell the uppercase Roses +flowers @outside
(A) notice the sunflowers
EOF
cat > done.txt <<EOF
x 2009-02-13 make the coffee +wakeup
x 2009-02-13 smell the coffee +wakeup
EOF
test_todo_session 'basic move with confirmation' <<EOF
>>> printf y | todo.sh move 1 done.txt 2>&1 | sed -e "s#'[^']\{1,\}/\([^/']\{1,\}\)'#'\1'#g" -e 's#from .\{1,\}/\([^/]\{1,\}\) to .\{1,\}/\([^/]\{1,\}\)?#from \1 to \2?#g'
Move '(B) smell the uppercase Roses +flowers @outside' from todo.txt to done.txt? (y/n)$SPACE
1 (B) smell the uppercase Roses +flowers @outside
TODO: 1 moved from 'todo.txt' to 'done.txt'.
>>> todo.sh -p ls
2 (A) notice the sunflowers
--
TODO: 1 of 1 tasks shown
>>> todo.sh -p listfile done.txt
3 (B) smell the uppercase Roses +flowers @outside
1 x 2009-02-13 make the coffee +wakeup
2 x 2009-02-13 smell the coffee +wakeup
--
DONE: 3 of 3 tasks shown
EOF
test_todo_session 'basic move with passed source' <<EOF
>>> todo.sh -f move 2 todo.txt done.txt | sed "s#'[^']\{1,\}/\([^/']\{1,\}\)'#'\1'#g"
2 x 2009-02-13 smell the coffee +wakeup
TODO: 2 moved from 'done.txt' to 'todo.txt'.
>>> todo.sh -p ls
2 (A) notice the sunflowers
3 x 2009-02-13 smell the coffee +wakeup
--
TODO: 2 of 2 tasks shown
>>> todo.sh -p listfile done.txt
3 (B) smell the uppercase Roses +flowers @outside
1 x 2009-02-13 make the coffee +wakeup
--
DONE: 2 of 2 tasks shown
EOF
echo -n 'this is a first task without newline' > todo.txt
cat > done.txt <<EOF
x 2009-02-13 make the coffee +wakeup
x 2009-02-13 smell the coffee +wakeup
EOF
test_todo_session 'move to destination without EOL' <<EOF
>>> todo.sh -f move 2 todo.txt done.txt | sed "s#'[^']\{1,\}/\([^/']\{1,\}\)'#'\1'#g"
2 x 2009-02-13 smell the coffee +wakeup
TODO: 2 moved from 'done.txt' to 'todo.txt'.
>>> todo.sh -p ls
1 this is a first task without newline
2 x 2009-02-13 smell the coffee +wakeup
--
TODO: 2 of 2 tasks shown
>>> todo.sh -p listfile done.txt
1 x 2009-02-13 make the coffee +wakeup
--
DONE: 1 of 1 tasks shown
EOF
test_done

1
tests/t2100-help.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='help functionality

2
tests/t2120-shorthelp.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='shorthelp functionality
@@ -36,7 +35,6 @@ test_todo_session 'shorthelp output with custom action' <<EOF
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".

3
tests/t2200-no-done-report-files.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='todo.sh configuration with a sole todo.txt data file.
@@ -8,7 +7,7 @@ checks that no such empty files are created.
'
. ./test-lib.sh
cat > test.cfg << EOF
cat > test.cfg <<EOF
export TODO_DIR=.
export TODO_FILE="\$TODO_DIR/todo.txt"
export DONE_FILE=/dev/null

1
tests/t6000-completion.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash completion functionality

1
tests/t6010-completion-contexts.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash context completion functionality

1
tests/t6020-completion-projects.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash project completion functionality

1
tests/t6030-completion-tasks.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash task number completion functionality

1
tests/t6040-completion-files.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash todo file completion functionality

1
tests/t6050-completion-addons.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash add-on action completion functionality

27
tests/t6060-completion-addon-files.sh Executable file
View File

@@ -0,0 +1,27 @@
#!/bin/bash
test_description='Bash add-on action file completion functionality
This test checks todo_completion of files for add-on actions that have file argument(s) configured
'
. ./test-lib.sh
readonly FILES='done.txt report.txt todo.txt'
test_todo_completion 'nothing after unconfigured bar' 'todo.sh bar ' ''
_todo_file1_actions='foo|bar'
test_todo_completion 'all files after configured bar' 'todo.sh bar ' "$FILES"
test_todo_completion 'nothing after configured bar ITEM#' 'todo.sh bar 1 ' ''
_todo_file2_actions='baz'
test_todo_completion 'nothing after configured baz' 'todo.sh baz ' ''
test_todo_completion 'all files after configured baz ITEM#' 'todo.sh baz 1 ' "$FILES"
test_todo_completion 'nothing after configured baz ITEM# MORE' 'todo.sh baz 1 more ' ''
_todo_file3_actions='biz'
test_todo_completion 'nothing after configured biz' 'todo.sh biz ' ''
test_todo_completion 'nothing after configured biz ITEM#' 'todo.sh biz 1 ' ''
test_todo_completion 'all files after configured biz ITEM# MORE' 'todo.sh biz 1 more ' "$FILES"
test_todo_completion 'nothing after configured biz ITEM# EVEN MORE' 'todo.sh biz 1 even more ' ''
test_done

3
tests/t6080-completion-path.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash completion with different path functionality
@@ -28,8 +27,6 @@ _todo2()
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:"}

2
tests/t6090-completion-aliases.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash completion with different aliases functionality
@@ -46,7 +45,6 @@ test_todo_session 'todo 1 and 2 contexts' <<EOF
@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

1
tests/t6100-completion-help.sh
View File

@@ -1,5 +1,4 @@
#!/bin/bash
#
test_description='Bash help completion functionality

55
tests/test-lib.sh
View File

@@ -172,12 +172,12 @@ test_set_editor () {
# the text_expect_* functions instead.
test_ok_ () {
test_success=$(($test_success + 1))
test_success=$((test_success + 1))
say_color "" " ok $test_count: $@"
}
test_failure_ () {
test_failure=$(($test_failure + 1))
test_failure=$((test_failure + 1))
say_color error "FAIL $test_count: $1"
shift
echo "$@"
@@ -185,12 +185,12 @@ test_failure_ () {
}
test_known_broken_ok_ () {
test_fixed=$(($test_fixed+1))
test_fixed=$((test_fixed + 1))
say_color "" " FIXED $test_count: $@"
}
test_known_broken_failure_ () {
test_broken=$(($test_broken+1))
test_broken=$((test_broken + 1))
say_color skip " still broken $test_count: $@"
}
@@ -206,7 +206,7 @@ test_run_ () {
}
test_skip () {
test_count=$(($test_count+1))
test_count=$((test_count + 1))
to_skip=
for skp in $SKIP_TESTS
do
@@ -364,7 +364,7 @@ test_external_without_stderr () {
test_ok_ "$descr"
else
if [ "$verbose" = t ]; then
output=`echo; echo Stderr is:; cat "$stderr"`
output=$(echo; echo Stderr is:; cat "$stderr")
else
output=
fi
@@ -414,12 +414,12 @@ test_done () {
mkdir -p "$test_results_dir"
test_results_path="$test_results_dir/${0%.sh}-$$"
echo "total $test_count" >> $test_results_path
echo "success $test_success" >> $test_results_path
echo "fixed $test_fixed" >> $test_results_path
echo "broken $test_broken" >> $test_results_path
echo "failed $test_failure" >> $test_results_path
echo "" >> $test_results_path
echo "total $test_count" >> "$test_results_path"
echo "success $test_success" >> "$test_results_path"
echo "fixed $test_fixed" >> "$test_results_path"
echo "broken $test_broken" >> "$test_results_path"
echo "failed $test_failure" >> "$test_results_path"
echo "" >> "$test_results_path"
if test "$test_fixed" != 0
then
@@ -428,7 +428,7 @@ test_done () {
if test "$test_broken" != 0
then
say_color error "still have $test_broken known breakage(s)"
msg="remaining $(($test_count-$test_broken)) test(s)"
msg="remaining $((test_count - test_broken)) test(s)"
else
msg="$test_count test(s)"
fi
@@ -471,12 +471,12 @@ rm -fr "$test" || {
test_init_todo () {
test "$#" = 1 ||
error "bug in the test script: not 1 parameter to test_init_todo"
owd=`pwd`
owd=$(pwd)
root="$1"
mkdir -p "$root"
cd "$root" || error "Cannot setup todo dir in $root"
# Initialize the configuration file. Carefully quoted.
sed -e 's|TODO_DIR=.*$|TODO_DIR="'"$TEST_DIRECTORY/$test"'"|' $TEST_DIRECTORY/../todo.cfg > todo.cfg
sed -e 's|TODO_DIR=.*$|TODO_DIR="'"$TEST_DIRECTORY/$test"'"|' "$TEST_DIRECTORY/../todo.cfg" > todo.cfg
# Install latest todo.sh
mkdir bin
@@ -499,8 +499,8 @@ test_init_todo () {
#date --version
#date: illegal option -- -
#usage: date [-jnu] [-d dst] [-r seconds] [-t west] [-v[+|-]val[ymwdHMS]] ...
#[-f fmt date | [[[mm]dd]HH]MM[[cc]yy][.ss]] [+format]
elif date --version 2>&1 | grep -q -e "-jnu"; then
# [-f fmt date | [[[mm]dd]HH]MM[[cc]yy][.ss]] [+format]
elif date --version 2>&1 | grep -q -e "-jnR\?u"; then
DATE_STYLE=Mac10.5
# on Mac OS X 10.4:
#date --version
@@ -548,7 +548,7 @@ test_init_todo () {
# Usage: test_tick [increment]
test_tick () {
TODO_TEST_TIME=$(($TODO_TEST_TIME + ${1:-86400}))
TODO_TEST_TIME=$((TODO_TEST_TIME + ${1:-86400}))
}
# Generate and run a series of tests based on a transcript.
@@ -581,14 +581,14 @@ test_todo_session () {
status=${line#=== }
;;
"")
if [ ! -z "$cmd" ]; then
if [ $status = 0 ]; then
if [ -n "$cmd" ]; then
if [ "$status" = 0 ]; then
test_expect_output "$1 $subnum" "$cmd"
else
test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
fi
subnum=$(($subnum + 1))
subnum=$((subnum + 1))
cmd=""
status=0
> expect
@@ -602,8 +602,8 @@ test_todo_session () {
;;
esac
done
if [ ! -z "$cmd" ]; then
if [ $status = 0 ]; then
if [ -n "$cmd" ]; then
if [ "$status" = 0 ]; then
test_expect_output "$1 $subnum" "$cmd"
else
test_expect_code_and_output "$status" "$1 $subnum" "$cmd"
@@ -645,7 +645,7 @@ test_todo_custom_completion () {
SAVEIFS=$IFS
IFS=' ' set -- $2
COMP_WORDS=("$@")
COMP_CWORD=$(($# - $offset))
COMP_CWORD=$(($# - offset))
IFS=' ' eval "set -- $expected"
EXPECT=("$@")
@@ -693,6 +693,13 @@ cd -P "$test" || exit 1
# but use something specified by the framework.
HOME=$(pwd)
export HOME
# Unset XDG_CONFIG_HOME as that is used as a config alternative.
unset XDG_CONFIG_HOME
# User add-ons may override built-in commands; these could have incompatible
# behavior that makes the tests fail. Avoid picking up user add-ons by
# explicitly configuring the first default location (which with the redirected
# HOME lies within the test directory and usually does not exist).
export TODO_ACTIONS_DIR="$HOME/.todo/actions"
this_test=${0##*/}
this_test=${this_test%%-*}

11
todo.cfg
View File

@@ -2,7 +2,7 @@
# 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=${HOME:-$USERPROFILE}
# Your todo/done/report.txt locations
export TODO_FILE="$TODO_DIR/todo.txt"
@@ -62,10 +62,17 @@ export REPORT_FILE="$TODO_DIR/report.txt"
#
# export COLOR_DONE=$LIGHT_GREY
# There is highlighting for projects and contexts.
# There is highlighting for projects, contexts, dates, and item numbers.
#
# export COLOR_PROJECT=$RED
# export COLOR_CONTEXT=$RED
# export COLOR_DATE=$BLUE
# export COLOR_NUMBER=$LIGHT_GREY
# There is highlighting for metadata key:value pairs e.g.
# DUE:2006-08-01 or note:MYNOTE
#
# export COLOR_META=$CYAN
# ... and for date extensions (due:yyyy-mm-dd, t:yyyy-mm-dd and again:X)
#

196
todo.sh
View File

@@ -3,8 +3,8 @@
# === HEAVY LIFTING ===
shopt -s extglob extquote
# NOTE: Todo.sh requires the .todo/config configuration file to run.
# Place the .todo/config file in your home directory or use the -d option for a custom location.
# NOTE: Todo.sh requires a configuration file to run.
# Place it in one of the default locations or use the -d option for a custom location.
[ -f VERSION-FILE ] && . VERSION-FILE || VERSION="@DEV_VERSION@"
version() {
@@ -62,7 +62,7 @@ shorthelp()
listproj|lsprj [TERM...]
move|mv ITEM# DEST [SRC]
prepend|prep ITEM# "TEXT TO PREPEND"
pri|p ITEM# PRIORITY
pri|p ITEM# PRIORITY[, ITEM# PRIORITY, ...]
replace ITEM# "UPDATED TODO"
report
shorthelp
@@ -83,6 +83,8 @@ shorthelp()
help()
{
local indentedJoinedConfigFileLocations
printf -v indentedJoinedConfigFileLocations ' %s\n' "${configFileLocations[@]}"
cat <<-EndOptionsHelp
Usage: $oneline_usage
@@ -96,7 +98,8 @@ help()
-c
Color mode
-d CONFIG_FILE
Use a configuration file other than the default ~/.todo/config
Use a configuration file other than one of the defaults:
$indentedJoinedConfigFileLocations
-f
Forces actions without confirmation or interactive input
-h
@@ -131,7 +134,6 @@ help()
-x
Disables TODOTXT_FINAL_FILTER
EndOptionsHelp
[ "$TODOTXT_VERBOSE" -gt 1 ] && cat <<-'EndVerboseHelp'
@@ -149,7 +151,9 @@ help()
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
TODOTXT_SIGIL_BEFORE_PATTERN="" optionally allow chars preceding +p / @c
TODOTXT_SIGIL_VALID_PATTERN=.* tweak the allowed chars for +p and @c
TODOTXT_SIGIL_AFTER_PATTERN="" optionally allow chars after +p / @c
EndVerboseHelp
actionsHelp
@@ -214,9 +218,13 @@ actionsHelp()
Displays all tasks that contain TERM(s) sorted by priority with line
numbers. Each task must match all TERM(s) (logical AND); to display
tasks that contain any TERM (logical OR), use
"TERM1\|TERM2\|..." (with quotes), or TERM1\\\|TERM2 (unquoted).
'TERM1\|TERM2\|...' (with quotes), or TERM1\\\|TERM2 (unquoted).
Hides all tasks that contain TERM(s) preceded by a
minus sign (i.e. -TERM). If no TERM specified, lists entire todo.txt.
minus sign (i.e. -TERM).
TERM(s) are grep-style basic regular expressions; for literal matching,
put a single backslash before any [ ] \ $ * . ^ and enclose the entire
TERM in single quotes, or use double backslashes and extra shell-quoting.
If no TERM specified, lists entire todo.txt.
listall [TERM...]
lsa [TERM...]
@@ -352,6 +360,20 @@ die()
exit 1
}
confirm()
{
[ $TODOTXT_FORCE = 0 ] || return 0
printf %s "${1:?}? (y/n) "
local readArgs=(-e -r)
[ -n "${BASH_VERSINFO:-}" ] && [ \( ${BASH_VERSINFO[0]} -eq 4 -a ${BASH_VERSINFO[1]} -ge 1 \) -o ${BASH_VERSINFO[0]} -gt 4 ] &&
readArgs+=(-N 1) # Bash 4.1+ supports -N nchars
local answer
read "${readArgs[@]}" answer
echo
[ "$answer" = "y" ]
}
cleaninput()
{
# Parameters: When $1 = "for sed", performs additional escaping for use
@@ -466,6 +488,13 @@ replaceOrPrepend()
fi
}
fixMissingEndOfLine()
{
# Parameters: $1: todo file; empty means $TODO_FILE.
todo_path="${1:-$TODO_FILE}"
[[ -f $todo_path && $(tail -c1 "$todo_path") ]] && echo "" >> "$todo_path"
}
uppercasePriority()
{
# Precondition: $input contains task text for which to uppercase priority.
@@ -603,7 +632,6 @@ shift $((OPTIND - 1))
# defaults if not yet defined
TODOTXT_VERBOSE=${TODOTXT_VERBOSE:-1}
TODOTXT_PLAIN=${TODOTXT_PLAIN:-0}
TODOTXT_CFG_FILE=${TODOTXT_CFG_FILE:-$HOME/.todo/config}
TODOTXT_FORCE=${TODOTXT_FORCE:-0}
TODOTXT_PRESERVE_LINE_NUMBERS=${TODOTXT_PRESERVE_LINE_NUMBERS:-1}
TODOTXT_AUTO_ARCHIVE=${TODOTXT_AUTO_ARCHIVE:-1}
@@ -614,6 +642,9 @@ 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}
TODOTXT_SIGIL_BEFORE_PATTERN=${TODOTXT_SIGIL_BEFORE_PATTERN:-} # Allow any other non-whitespace entity before +project and @context; should be an optional match; example: \(w:\)\{0,1\} to allow w:@context.
TODOTXT_SIGIL_VALID_PATTERN=${TODOTXT_SIGIL_VALID_PATTERN:-.*} # Limit the valid characters (from the default any non-whitespace sequence) for +project and @context; example: [a-zA-Z]\{3,\} to only allow alphabetic ones that are at least three characters long.
TODOTXT_SIGIL_AFTER_PATTERN=${TODOTXT_SIGIL_AFTER_PATTERN:-} # Allow any other non-whitespace entity after +project and @context; should be an optional match; example: )\{0,1\} to allow (with the corresponding TODOTXT_SIGIL_BEFORE_PATTERN) enclosing in parentheses.
# Export all TODOTXT_* variables
export "${!TODOTXT_@}"
@@ -644,10 +675,13 @@ 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, context and dateext colors.
# Default project, context, date, item number, and metadata key:value pairs colors.
export COLOR_PROJECT=$NONE
export COLOR_CONTEXT=$NONE
export COLOR_DATE=$NONE
export COLOR_DATEEXT=$NONE
export COLOR_NUMBER=$NONE
export COLOR_META=$NONE
# Default highlight colors.
export COLOR_DONE=$LIGHT_GREY # color for done (but not yet archived) tasks
@@ -658,51 +692,23 @@ export COLOR_DONE=$LIGHT_GREY # color for done (but not yet archived) tasks
# (todo.sh add 42 ", foo") syntactically correct.
export SENTENCE_DELIMITERS=',.:;'
[ -e "$TODOTXT_CFG_FILE" ] || {
CFG_FILE_ALT="$HOME/todo.cfg"
configFileLocations=(
"$HOME/.todo/config"
"$HOME/todo.cfg"
"$HOME/.todo.cfg"
"${XDG_CONFIG_HOME:-$HOME/.config}/todo/config"
"$(dirname "$0")/todo.cfg"
"$TODOTXT_GLOBAL_CFG_FILE"
)
[ -e "$TODOTXT_CFG_FILE" ] || for CFG_FILE_ALT in "${configFileLocations[@]}"
do
if [ -e "$CFG_FILE_ALT" ]
then
TODOTXT_CFG_FILE="$CFG_FILE_ALT"
break
fi
}
[ -e "$TODOTXT_CFG_FILE" ] || {
CFG_FILE_ALT="$HOME/.todo.cfg"
if [ -e "$CFG_FILE_ALT" ]
then
TODOTXT_CFG_FILE="$CFG_FILE_ALT"
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"
if [ -e "$CFG_FILE_ALT" ]
then
TODOTXT_CFG_FILE="$CFG_FILE_ALT"
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
}
done
if [ -z "$TODO_ACTIONS_DIR" ] || [ ! -d "$TODO_ACTIONS_DIR" ]
then
@@ -710,26 +716,20 @@ then
export TODO_ACTIONS_DIR
fi
[ -d "$TODO_ACTIONS_DIR" ] || {
TODO_ACTIONS_DIR_ALT="$HOME/.todo.actions.d"
[ -d "$TODO_ACTIONS_DIR" ] || for TODO_ACTIONS_DIR_ALT in \
"$HOME/.todo.actions.d" \
"${XDG_CONFIG_HOME:-$HOME/.config}/todo/actions"
do
if [ -d "$TODO_ACTIONS_DIR_ALT" ]
then
TODO_ACTIONS_DIR="$TODO_ACTIONS_DIR_ALT"
break
fi
}
done
[ -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" ] || dieWithHelp "$1" "Fatal Error: Cannot read configuration file $TODOTXT_CFG_FILE"
[ -r "$TODOTXT_CFG_FILE" ] || dieWithHelp "$1" "Fatal Error: Cannot read configuration file ${TODOTXT_CFG_FILE:-${configFileLocations[0]}}"
. "$TODOTXT_CFG_FILE"
@@ -777,19 +777,26 @@ ACTION=${1:-$TODOTXT_DEFAULT_ACTION}
|| echo "$TODOTXT_PRIORITY_ON_ADD" | grep -q "^[A-Z]$" \
|| die "TODOTXT_PRIORITY_ON_ADD should be a capital letter from A to Z (it is now \"$TODOTXT_PRIORITY_ON_ADD\")."
[ -z "$TODO_FILE" ] && TODO_FILE="$TODO_DIR/todo.txt"
[ -z "$DONE_FILE" ] && DONE_FILE="$TODO_DIR/done.txt"
[ -z "$REPORT_FILE" ] && REPORT_FILE="$TODO_DIR/report.txt"
[ -f "$TODO_FILE" ] || [ -c "$TODO_FILE" ] || > "$TODO_FILE"
[ -f "$DONE_FILE" ] || [ -c "$DONE_FILE" ] || > "$DONE_FILE"
[ -f "$REPORT_FILE" ] || [ -c "$REPORT_FILE" ] || > "$REPORT_FILE"
if [ $TODOTXT_PLAIN = 1 ]; then
for clr in ${!PRI_@}; do
export "$clr"=$NONE
export "$clr"="$NONE"
done
PRI_X=$NONE
DEFAULT=$NONE
COLOR_DONE=$NONE
COLOR_PROJECT=$NONE
COLOR_CONTEXT=$NONE
COLOR_DATE=$NONE
COLOR_NUMBER=$NONE
COLOR_META=$NONE
fi
[[ "$HIDE_PROJECTS_SUBSTITUTION" ]] && COLOR_PROJECT="$NONE"
@@ -810,6 +817,7 @@ _addto() {
input=$(echo -n "($TODOTXT_PRIORITY_ON_ADD) " ; echo "$input")
fi
fi
fixMissingEndOfLine "$file"
echo "$input" >> "$file"
if [ "$TODOTXT_VERBOSE" -gt 0 ]; then
TASKNUM=$(sed -n '$ =' "$file")
@@ -968,17 +976,32 @@ _format()
dtx_beg = highlight("COLOR_DATEEXT")
dtx_end = (dtx_beg ? (highlight("DEFAULT") clr) : "")
dat_beg = highlight("COLOR_DATE")
dat_end = (dat_beg ? (highlight("DEFAULT") clr) : "")
num_beg = highlight("COLOR_NUMBER")
num_end = (num_beg ? (highlight("DEFAULT") clr) : "")
met_beg = highlight("COLOR_META")
met_end = (met_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_]$/) {
if (i == 1 && words[i] ~ /^[0-9]+$/ ) {
printf "%s", num_beg words[i] num_end
} else 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 if (words[i] ~ /^(due|t|again):/) {
printf "%s", dtx_beg words[i] dtx_end
} else if (words[i] ~ /^(19|20)[0-9][0-9]-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$/) {
printf "%s", dat_beg words[i] dat_end
} else if (words[i] ~ /^[A-Za-z0-9]+:[^ ]+$/) {
printf "%s", met_beg words[i] met_end
} else {
printf "%s", words[i]
}
@@ -1011,7 +1034,13 @@ listWordsWithSigil()
FILE=$TODO_FILE
[ "$TODOTXT_SOURCEVAR" ] && eval "FILE=$TODOTXT_SOURCEVAR"
eval "$(filtercommand 'cat "${FILE[@]}"' '' "$@")" | grep -o "[^ ]*${sigil}[^ ]\\+" | grep "^$sigil" | sort -u
eval "$(filtercommand 'cat "${FILE[@]}"' '' "$@")" \
| grep -o "[^ ]*${sigil}[^ ]\\+" \
| sed -n \
-e "s#^${TODOTXT_SIGIL_BEFORE_PATTERN//#/\\#}##" \
-e "s#${TODOTXT_SIGIL_AFTER_PATTERN//#/\\#}\$##" \
-e "/^${sigil}${TODOTXT_SIGIL_VALID_PATTERN//\//\\/}$/p" \
| sort -u
}
export -f cleaninput getPrefix getTodo getNewtodo shellquote filtercommand _list listWordsWithSigil getPadding _format die
@@ -1068,7 +1097,7 @@ case $action in
SAVEIFS=$IFS
IFS=$'\n'
# Treat each line seperately
# Treat each line separately
for line in $input ; do
_addto "$TODO_FILE" "$line"
done
@@ -1135,13 +1164,7 @@ case $action in
getTodo "$item"
if [ -z "$3" ]; then
if [ $TODOTXT_FORCE = 0 ]; then
echo "Delete '$todo'? (y/n)"
read -e -r ANSWER
else
ANSWER="y"
fi
if [ "$ANSWER" = "y" ]; then
if confirm "Delete '$todo'"; then
if [ $TODOTXT_PRESERVE_LINE_NUMBERS = 0 ]; then
# delete line (changes line numbers)
sed -i.bak -e "${item}s/^.*//" -e '/./!d' "$TODO_FILE"
@@ -1241,7 +1264,7 @@ case $action in
actionUsage "$@"
else
if [ -t 1 ] ; then # STDOUT is a TTY
if which "${PAGER:-less}" >/dev/null 2>&1; then
if command -v "${PAGER:-less}" >/dev/null 2>&1; then
# we have a working PAGER (or less as a default)
help | "${PAGER:-less}" && exit 0
fi
@@ -1252,7 +1275,7 @@ case $action in
"shorthelp" )
if [ -t 1 ] ; then # STDOUT is a TTY
if which "${PAGER:-less}" >/dev/null 2>&1; then
if command -v "${PAGER:-less}" >/dev/null 2>&1; then
# we have a working PAGER (or less as a default)
shorthelp | "${PAGER:-less}" && exit 0
fi
@@ -1331,13 +1354,7 @@ case $action in
getTodo "$item" "$src"
[ -z "$todo" ] && die "$item: No such item in $src."
if [ $TODOTXT_FORCE = 0 ]; then
echo "Move '$todo' from $src to $dest? (y/n)"
read -e -r ANSWER
else
ANSWER="y"
fi
if [ "$ANSWER" = "y" ]; then
if confirm "Move '$todo' from $src to $dest"; then
if [ $TODOTXT_PRESERVE_LINE_NUMBERS = 0 ]; then
# delete line (changes line numbers)
sed -i.bak -e "${item}s/^.*//" -e '/./!d' "$src"
@@ -1345,6 +1362,7 @@ case $action in
# leave blank line behind (preserves line numbers)
sed -i.bak -e "${item}s/^.*//" "$src"
fi
fixMissingEndOfLine "$dest"
echo "$todo" >> "$dest"
if [ "$TODOTXT_VERBOSE" -gt 0 ]; then
@@ -1362,13 +1380,15 @@ case $action in
;;
"pri" | "p" )
item=$2
newpri=$( printf "%s\n" "$3" | tr '[:lower:]' '[:upper:]' )
shift
while [ "$#" -gt 0 ] ; do
item=$1
newpri=$( printf "%s\n" "$2" | tr '[:lower:]' '[:upper:]' )
errmsg="usage: $TODO_SH pri ITEM# PRIORITY
errmsg="usage: $TODO_SH pri ITEM# PRIORITY[, ITEM# PRIORITY, ...]
note: PRIORITY must be anywhere from A to Z."
[ "$#" -ne 3 ] && die "$errmsg"
[ "$#" -lt 2 ] && die "$errmsg"
[[ "$newpri" = @([A-Z]) ]] || die "$errmsg"
getTodo "$item"
@@ -1394,6 +1414,8 @@ note: PRIORITY must be anywhere from A to Z."
if [ "$oldpri" = "$newpri" ]; then
echo "TODO: $item already prioritized ($newpri)."
fi
shift; shift
done
;;
"replace" )

43
todo_completion
View File

@@ -1,5 +1,7 @@
#!/bin/bash source-this-script
[ "$BASH_VERSION" ] || return
# bash completion for todo.txt-cli
# Check for bash
[ -z "$BASH_VERSION" ] && return
_todo()
{
@@ -14,15 +16,15 @@ _todo()
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)$'
local -r MOVE_COMMAND_PATTERN='move|mv'
local _todo_sh=${_todo_sh:-todo.sh}
local completions
if [ $COMP_CWORD -eq 1 ]; then
if [ "$COMP_CWORD" -eq 1 ]; then
completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons 2>/dev/null) $OPTS"
elif [[ $COMP_CWORD -gt 2 && ( \
"${COMP_WORDS[COMP_CWORD-2]}" =~ $MOVE_COMMAND_PATTERN || \
"${COMP_WORDS[COMP_CWORD-3]}" =~ $MOVE_COMMAND_PATTERN ) ]]; then
"${COMP_WORDS[COMP_CWORD-2]}" =~ ^($MOVE_COMMAND_PATTERN${_todo_file2_actions:+|${_todo_file2_actions}})$ || \
"${COMP_WORDS[COMP_CWORD-3]}" =~ ^($MOVE_COMMAND_PATTERN${_todo_file3_actions:+|${_todo_file3_actions}})$ ) ]]; then
# "move ITEM# DEST [SRC]" has file arguments on positions 2 and 3.
completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listfile 2>/dev/null)
else
@@ -31,10 +33,11 @@ _todo()
completions=$COMMANDS;;
help)
completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons 2>/dev/null)";;
addto|listfile|lf)
completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listfile 2>/dev/null);;
-*) completions="$COMMANDS $(eval TODOTXT_VERBOSE=0 $_todo_sh command listaddons 2>/dev/null) $OPTS";;
*) case "$cur" in
*) if [[ "$prev" =~ ^(addto|listfile|lf${_todo_file1_actions:+|${_todo_file1_actions}})$ ]]; then
completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listfile 2>/dev/null)
else
case "$cur" in
+*) completions=$(eval TODOTXT_VERBOSE=0 $_todo_sh command listproj 2>/dev/null)
COMPREPLY=( $( compgen -W "$completions" -- $cur ))
[ ${#COMPREPLY[@]} -gt 0 ] && return 0
@@ -48,23 +51,28 @@ _todo()
completions=$(eval 'TODOTXT_VERBOSE=0 TODOTXT_SOURCEVAR=\$DONE_FILE' $_todo_sh command listcon 2>/dev/null)
;;
*) if [[ "$cur" =~ ^[0-9]+$ ]]; then
declare -a sedTransformations=(
# Remove the (padded) task number; we prepend the
# user-provided $cur instead.
-e 's/^ *[0-9]\{1,\} //'
# Remove the timestamp prepended by the -t option,
# and the done date (for done tasks); there's no
# todo.txt option for that yet.
# But keep priority and "x"; they're short and may
# provide useful context.
# but keep any priority (as it's short and may
# provide useful context).
-e 's/^\((.) \)\{0,1\}[0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} /\1/'
# Remove the done date and (if there) the timestamp.
# Keep the "x" (as it's short and may provide useful
# context)
-e 's/^\([xX] \)\([0-9]\{2,4\}-[0-9]\{2\}-[0-9]\{2\} \)\{1,2\}/\1/'
# Remove any trailing whitespace; the Bash
# completion inserts a trailing space itself.
-e 's/[[:space:]]*$//'
# Finally, limit the output to a single line just as
# a safety check of the ls action output.
-e '1q'
)
local todo=$( \
eval TODOTXT_VERBOSE=0 $_todo_sh '-@ -+ -p -x command ls "^ *${cur} "' 2>/dev/null | \
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' \
sed "${sedTransformations[@]}" \
)
# Append task text as a shell comment. This
# completion can be a safety check before a
@@ -76,6 +84,7 @@ _todo()
fi
;;
esac
fi
;;
esac
fi