kdheepak/taskwarrior-tui
1
0
Fork 0
mirror of https://github.com/kdheepak/taskwarrior-tui.git synced 2025-08-24 05:26:42 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat: prompt on undo ✨

Browse source
This commit is contained in:
Dheepak Krishnamurthy 2023-08-25 00:49:53 -04:00
parent 499894487b
commit 73c7eee3b6
6 changed files with 95 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

41
docs/configuration/advanced.md
View file

@ -1,13 +1,15 @@
# Advanced configuration
`taskwarrior-tui` parses the output of `task show` to get configuration data.
This allows `taskwarrior-tui` to use the same defaults as `taskwarrior` and configure additional options as required.
`taskwarrior-tui` parses the output of `task show` to get configuration data. This allows
`taskwarrior-tui` to use the same defaults as `taskwarrior` and configure additional options as
required.
## `taskrc` config file options:
Other `taskwarrior-tui` configuration options are possible using the user defined attribute feature of `taskwarrior`.
All `taskwarrior-tui` specific configuration options will begin with `uda.taskwarrior-tui.`.
The following is a full list of all the options available and their default values implemented by `taskwarrior-tui` if not defined in your `taskrc` file.
Other `taskwarrior-tui` configuration options are possible using the user defined attribute feature
of `taskwarrior`. All `taskwarrior-tui` specific configuration options will begin with
`uda.taskwarrior-tui.`. The following is a full list of all the options available and their default
values implemented by `taskwarrior-tui` if not defined in your `taskrc` file.
```plaintext
uda.taskwarrior-tui.selection.indicator=•
@ -24,6 +26,7 @@ uda.taskwarrior-tui.calendar.months-per-row=4
uda.taskwarrior-tui.task-report.show-info=true
uda.taskwarrior-tui.task-report.looping=true
uda.taskwarrior-tui.task-report.jump-on-task-add=true
uda.taskwarrior-tui.task-report.prompt-on-undo=false
uda.taskwarrior-tui.task-report.prompt-on-delete=false
uda.taskwarrior-tui.task-report.prompt-on-done=false
uda.taskwarrior-tui.style.report.selection=
@ -42,16 +45,19 @@ uda.taskwarrior-tui.context-menu.select-on-move=false
uda.taskwarrior-tui.tabs.change-focus-rotate=false
```
The `uda.taskwarrior-tui.task-report.next.filter` variable defines the default view at program startup. Set this to any preconfigured report (`task reports`), or create your own report in taskwarrior and specify its name here.
The `uda.taskwarrior-tui.task-report.next.filter` variable defines the default view at program
startup. Set this to any preconfigured report (`task reports`), or create your own report in
taskwarrior and specify its name here.
## commandline options:
`-r`: specify a report to be shown, overrides `uda.taskwarrior-tui.task-report.next.filter` for this instance
`-r`: specify a report to be shown, overrides `uda.taskwarrior-tui.task-report.next.filter` for this
instance
## Configure user defined shortcuts:
You can configure shortcuts to execute custom commands from your `taskwarrior`'s `taskrc` file (default: `~/.taskrc`).
You can do this by mapping a shortcut to an executable file:
You can configure shortcuts to execute custom commands from your `taskwarrior`'s `taskrc` file
(default: `~/.taskrc`). You can do this by mapping a shortcut to an executable file:
```plaintext
uda.taskwarrior-tui.shortcuts.1=~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh
@ -68,21 +74,22 @@ To make a file executable:
By default, keys `1`-`9` are available to run shortcuts.
When you hit the shortcut, the script will be executed with the `selected_tasks_uuid` as an argument:
When you hit the shortcut, the script will be executed with the `selected_tasks_uuid` as an
argument:
```bash
~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh $selected_tasks_uuid
```
For example, you can add the `personal` tag to the currently selected task with the following script in `~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh` :
For example, you can add the `personal` tag to the currently selected task with the following script
in `~/.config/taskwarrior-tui/shortcut-scripts/add-personal-tag.sh` :
```plaintext
task rc.bulk=0 rc.confirmation=off rc.dependency.confirmation=off rc.recurrence.confirmation=off "$@" modify +personal
```
By default, shortcuts are linked to the `1-9` number row keys.
They can be customized as any other keys through `uda.taskwarrior-tui.keyconfig.shortcut1=<key>`.
For example:
By default, shortcuts are linked to the `1-9` number row keys. They can be customized as any other
keys through `uda.taskwarrior-tui.keyconfig.shortcut1=<key>`. For example:
```plaintext
uda.taskwarrior-tui.keyconfig.shortcut1=n
@ -99,4 +106,8 @@ uda.taskwarrior-tui.background_process=task sync
uda.taskwarrior-tui.background_process_period=60
```
This will run `task sync` every 60 seconds. If the `background_process` is an empty string (default), then no process will be run. Only if the `background_process` is defined and if the `background_process` runs successfully, it'll be run every `background_process_period` number of seconds (default: 60 seconds). However, if it fails even once it won't be run again till `taskwarrior-tui` is restarted.
This will run `task sync` every 60 seconds. If the `background_process` is an empty string
(default), then no process will be run. Only if the `background_process` is defined and if the
`background_process` runs successfully, it'll be run every `background_process_period` number of
seconds (default: 60 seconds). However, if it fails even once it won't be run again till
`taskwarrior-tui` is restarted.

2
docs/taskwarrior-tui.1
View file

@ -1,4 +1,4 @@
.\" Automatically generated by Pandoc 2.19.2
.\" Automatically generated by Pandoc 3.1.6
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.