This repository has been archived on 2022-05-13. You can view files and clone it, but cannot push or open issues or pull requests.
chronometrist/TODO.org

111 lines
9.0 KiB
Org Mode
Raw Normal View History

2019-08-09 02:05:47 +00:00
1. [-] Move time operations into a chronometrist-time file
2. -report - highlight the current day
2019-08-04 19:20:13 +00:00
2019-10-25 07:45:55 +00:00
* v0.3.0 [100%]
1. [X] +Release or+ bundle plist-pp.el
2. [X] -report - error opening when clocked in
2019-08-09 18:06:48 +00:00
* Chronometrist
** Bugs [50%]
1. [X] fix -current-task to return correct results if the last one crosses a midnight
2. [ ] Clocking-in/out doesn't result in updated display, sometimes (2019-09-12)
** Features
1. Create chronometrist-unused-projects-list + chronometrist-projects-list.
2. New commands
* *Kill/discard* (bind to 'k') - which will delete the interval currently being recorded.
- Most conservative option - it will only operate on the project at point, and will only kill for a clocked-in project.
- Somewhat less conservative option - it will operate on the currently clocked-in project, no matter where point is.
- It _should_ ask for confirmation.
- Alternatively, or as a complement - an *undo command*, which will undo your last action (clock in or clock out).
2019-09-20 05:56:21 +00:00
- Undo and redo seem like the best bets.
* *Convert* - change the currently clocked-in project to a different task. Tags and key-values may be re-queried. Clock-in hook functions will be run again with the new task as the argument.
* *Rename* a project (updating all records)
* *Delete* a project (erasing all records)
* *Hide* a project (don't show it in any Chronometrist-* buffer, effectively deleting it non-destructively)
3. Hook enhancement - can we supply the whole plist (including tags and key-values) to the task-start hooks, so users can have even smarter hook functions?
* That would mean ensuring that -kv-read runs before other hooks.
* Actually, it should be trivial to access the last expression in the file, so maybe this is unnecessary.
2019-09-20 05:56:21 +00:00
4. [ ] key-values and tags should work regardless of what hook they're called from, to give users the option to modify behaviour (does clock in start after you've finished adding details, or before?)
5. [ ] Expandable items - show intervals for task today
* [ ] Switch between intervals and tag-combination breakdown
*** Key-values [50%]
2019-09-20 05:56:21 +00:00
1. [X] bug - value-history appears in chronological rather than reverse chronological order
2. [X] generate history hash table from chronometrist-file.
* [X] generate value history hash table from chronometrist-file
* [X] change "press X to quit" in prompt to suggest keys for ido, helm, and ivy
3. [ ] *create custom variable to allow a quick exit from key-value entry* - if the user provides blank input on the first key and there are no existing key-values, quit the prompt loop and run -kv-reject automatically.
2019-09-20 05:56:21 +00:00
* [ ] and if the user enters valid key-values and quits the key prompt with a blank input, auto-accept
* [ ] enh - this will allow using initial-input in value prompts
4. [ ] create text button to add key-values to last entry (whether clocked in or out)
5. [X] insert value as string if it contains spaces and isn't a list
* Sometimes you want single-word values to be converted to a string, too. Maybe check for capital letters too?
* Preserve type in history?
* Might create inconsistency in prompts? We don't want to expect Lisp knowledge from users.
* Ask user to define types for keys, and handle the syntax for them behind the scenes?
6. [ ] when reading values, add quit keybinding (consistent with output of ~chronometrist-kv-completion-quit-key~) by passing MAP to ~read-from-minibuffer~
7. [X] bug - missing values in history
8. [X] enh - remove key-values from suggestions which have already been added
2019-09-20 05:56:21 +00:00
9. [ ] enh - create custom variable to auto-insert key-values used in previous task of same :name in the key-value buffer.
2019-09-21 05:20:13 +00:00
10. [X] bug - incorrect indenting in -kv-buffer
2019-09-20 05:56:21 +00:00
11. [X] bug - I think -append-to-last-expr is eating key-values
* to reproduce - clock-in, add tags, add key-values, clock-out, keep tags - kv-add buffer has (), whereas it should have the earlier key-values.
12. bug - key-values from clock-in expression not displayed, shows () instead
* cause - if -kv-add is run after chronometrist-out, ~chronometrist-current-task~ will return nil
2019-09-21 05:20:13 +00:00
13. [ ] observe interaction of -kv-add with next function in hook which modifies window configuration
* code which deletes the window, or switches to a new buffer, interferes with the key-value addition flow
2019-09-21 05:20:13 +00:00
* [ ] add a kv-finished-hook? (run after kv-accept/reject)
14. how do we handle a blank string as a plist value?
2019-09-20 05:56:21 +00:00
* some way to require the user to enter a non-empty value (e.g. like the 'require-match' argument to completing-read, except read-from-minibuffer doesn't have that...)
* discard last-entered key?
15. [ ] bug - it is possible to add a key twice (should replace the existing key instead)
16. [ ] bug - if you use the same key for >1 task, values from other tasks may be suggested
* This is because we're only using values as the key in the `chronometrist-value-history` hash table.
17. [ ] optimize - going through key (?) and value histories (M-p/M-n) takes a while. Is this because we're using lists?
*** Tags [100%]
2019-09-20 05:56:21 +00:00
1. [X] generate history from chronometrist-file
* [X] narrow it down to the :name
2. [X] write tags to last expression
3. [X] show task name in prompt
4. [X] bug - tags being added twice
2019-08-13 10:00:23 +00:00
** UX
1. don't suggest nil when asking for first project on first run
2. when starting a project with time of "-" (i.e. not worked on today until now), immediately set time to 0 instead of waiting for the first timer refresh
3. Mouse commands should work only on buttons.
4. Button actions should accept prefix arguments and behave exactly like their keyboard counterparts.
5. mouse-3 should clock-out without asking for reason.
2019-09-08 17:24:13 +00:00
6. Some way to ask for the reason just before starting a project. Even when clocking out, the reason is asked /before/ clocking out, which adds time to the project.
2019-09-09 20:37:28 +00:00
7. Allow calling chronometrist-in/out from anywhere-within-Emacs (a la timeclock) as well as from the chronometrist buffer.
2019-09-08 17:24:13 +00:00
*** Optimization
2019-09-20 05:56:21 +00:00
* ~chronometrist~ takes close to a second to start (as of 2019-09-14; chronometrist.sexp is 11,329 lines with 2318 expressions). Can we speed that up?
* File size should affect only the first start, but in our case even later starts are slow.
* Unless we are re-reading the whole file on each start?
2019-09-14 19:50:02 +00:00
**** Ideas to make -refresh-file faster
2019-09-15 17:30:19 +00:00
1. Support multiple files, so we read and process lesser data when one of them changes.
2. Make file writing async
3. Don't refresh from file when clocking in.
4. Only write to the file when Emacs is idle or being killed, and store data in memory (in the events hash table) in the meantime
5. What if commands both write to the file /and/ add to the hash table, so we don't have to re-read the file and re-populate the table for commands? The expensive reading+parsing could be avoided for commands, and only take place for the user changing the file.
* jonasw - store length and hash of previous file, see if the new file has the same hash until old-length bytes.
* Rather than storing and hashing the full length, we could do it until (before) the last s-expression (or last N s-expressions?). That way, we know if the last expression (or last N expressions) have changed.
* Or even the first expression of the current date. That way, we just re-read the events for today. Because chronometrist-events uses dates as keys, it's easy to work on the basis of dates.
** Code [0%]
2019-08-30 17:09:30 +00:00
1. use variables instead of hardcoded numbers to determine spacing
2. refactor repetitive calls to (format "%04d-%02d-%02d" (elt seq a) (elt seq b) (elt seq c))
3. Use buttercup instead of ert
4. See if it is possible to store buttons in a variable, so *-print-non-tabular functions can be made shorter and less imperative. (see ~make-text-button~)
5. Merge all event-querying functions so that they always operate on an entire hash table (so no 'day' variants),
6. [ ] Use ~substitute-command-keys~ instead of ~chronometrist-format-keybinds~
7. [ ] See if using iteration constructs (especially ~loop~) can lead to nicer code than nested maps
8. [ ] recreate -events-clean, remove splitting code from -events-populate
* How should we deal with the active event?
* Earlier, we would add a closing entry and update that on a timer.
+6. Timeclock already _has_ hooks! :| Why do we re-implement them?+
2019-08-30 17:09:30 +00:00
- I don't know of a way to know the project being clocked into using timeclock hooks.
- With v0.2.0 Chronometrist also has a before-project-stop-functions, which runs before the project is stopped, and can control whether the project actually is stopped.
2019-09-18 06:13:45 +00:00
* chronometrist-report
** Features
1. [ ] Expandable items - show tag-combination-based breakdown
2019-09-18 06:13:45 +00:00
** Migration [100%]
1. [X] next/previous weeks
2019-10-25 07:45:55 +00:00
* Documentation [0%]
1. [ ] Make Texinfo documentation