igrybkov / alfred-focus-on-work Goto Github PK

Settings

• Add ability to set time interval used for Pomodoro session
• Add ability to set time interval used for a short break
• Add ability to set time interval used for a long break

Time intervals

• Does not show time interval selection since we have time interval already predefined
  • This would require to add a filter between "Choose a task" and "Choose a time" and skip time setting in case a time is set already

Tasks flow

• When time is gone, a pomodoro is logged

Logging

• Each Pomodoro must be logged somewhere to build a report later
  • Think about where and how you're going to log these pomodoros
• Build a report
  • How are you going to build report around Pomodoros?
    • Build a PDF with report?
    • Excel?
    • Small web-server and a page?
    • A page in the PDF?
  • What should report contain?
    • Number of pomodoros accomplished
    • What else?

Related issues

Depends on ability to manipulate with workflow settings (#47)
Pomodoro reminder depends on #1 where reminder functionality should be added
Potentially crosses with task pausing implementation (#48) - at least they should be checked together

The current library has some bugs which are limiting usage of taskpaper format.

Known issues

• Doesn't parse correctly when a tag in the middle of the line:
  Talk to @people(igrybkov) to find a solution
• Colon inside a text block

Links

• https://guide.taskpaper.com/customizing-taskpaper/creating-scripts.html#cross-platform-scripts
  • https://github.com/jessegrosjean/birch-outline

Add ability to pause a task execution and restore time settings from the same point where they've been before a task was paused

Seems like this library has much better API. It is worth to think about migration.

https://github.com/Cloudstek/alfred-hugo

To changes various settings used in the workflow it's nice to a command-line interface since it could be used in the automation scripts.

Add time steps equivalent to 5 minutes for time < 1h

Provide documentation on all possible environment variables to customize the app

Related to #8

• What exactly this workflow doing, which problem tries to solve
• How the flow looks like (gif)
• Which applications supported

The issue is reproducible on version v0.1.1

Add ability to change workflow settings through Alfred interface

Events

This action would require several events:

Used to show menu

• ShowSettingsItems
• ShowSettingOptions

Used to manipulate with settings

• AddConfigurationValueToSet
• RemoveConfigurationValueFromSet
• RemoveConfigurationValue
• SetConfigurationValue

CLI Commands

• menu:settings - prints all settings
• menu:setting-options <settings-menu-item> - prints options for chosen configuration
• settings:set <path> <value> - sets value to the configuration
• settings:add <path> <value> - adds value to the set of values in the configuration
• settings:remove <path> - removes value from the configuration
• settings:remove-from-set <path> <key> - removes value from the configuration

Menu items

For each item:

• Icon of a module which added an item or a default config item icon (TBD)

ShowSettingsItems

Environment variables

• settingPath - a path of the setting

ShowSettingOptions

• settingPath - path of the setting
• settingValue - chosen value
• settingAction - either set, add or remove action. If ommited, add used by default

Improvements

• If possible, route a flow to some point of the next event by adding nextAction environment variable

Add matches to allow quickly jump to the desired value, like '10m', 'pomodoro', 'hour', '1.5h'

https://docs.travis-ci.com/user/open-source-repository-migration/

https://developer.apple.com/library/archive/documentation/AppleApplications/Conceptual/CalendarScriptingGuide/Calendar-LocateanEvent.html#//apple_ref/doc/uid/TP40016646-CH95-SW7

For now, if a task inside a project which is the task itself, the dash sign is shown in the project breadcrumbs (subtitle)

Use "Stop sign" as an icon, use task title as menu title and move action test "Stop current work" to subtitle

Like, last 3 tasks you were working on

Allow overriding configuration settings from environment variables if they're set. This would allow to configure an app through Alfred environment variables without touching command line

The answer "Yes" should be second in menu ;)

Like multiple taskpaper files or several Jira instances.

Allow to use multiple Jira instances

God knows how I hate Makefiles with their weird syntax and irrational behavior like any new line resets the context (workdir, for example), but commands in the same line share the context.
To get rid of makefiles, we need to migrate to another scripting platform. Runjs looks good for this role: https://github.com/pawelgalazka/tasksfile/tree/runjs

Also, when the task started this way, "Continue work" menu still shown instead of "Stop current work"

The goal is to move control logic from the app.js to modules instead. This should give modules some flexibility in making decisions whether to show something or not and in which way.

There are two options to design such behavior:

• add events and make modules subscribe to events
• add soft interface where app.js check for a function and if it present then calls it

Anyway, for each command, all arguments must be passed through event/function arguments and the module decides whether to add anything to output or not.

Links

https://nodejs.org/api/events.html

Caching for a small amount of time (3-10 seconds) would increase performance for menu navigation

Steps to reproduce

1. Start work for 2 minutes
2. Stop it immediately
3. Start a new work for 5 minutes for the same task
4. When 2 minutes after the start of the first work will expire, the task execution would be stopped

Possible solution:

Generate uuid for each process started by Alfred and, when starting a job, persist that process in config.
When execution is finished, if saved uuid is the same as in the session, then stop an execution, otherwise, do nothing.

Authentication

• Use Github token
• Register an app and give it access

For the second case, you could start a web-server which would accept redirect.
This extension doing this: https://github.com/lox/alfred-github-jump

Links

https://developer.github.com/v3/issues/#list-issues
https://github.com/octokit/rest.js

Unlinking happens when application switched between dev-release versions, upgraded or removed.
During this action, alfred-unlink removes a directory which had workflow settings inside.
This behavior really annoying and should be avoided. A possible fix is to inline that module and fix it in place. Another fix is to patch it during install.

Action items

• Copy-paste a code used for linking into the project
• Fix the issue
• Get rid of the dependency on alfred-unlink

Before relying on an app (for example, showing tasks for TaskPaper or starting tracking in Timing) check whether an app is available.

It's nice to have all the tasks listed at the end of the main menu to use search and start work immediately.
Make this option configurable through settings