Custom Complete

About

This is an Omni Automation plug-in bundle for OmniFocus that marks a task as complete and performs a series of customisable actions.

Please note that all scripts on my GitHub account (or shared elsewhere) are works in progress. If you encounter any issues or have any suggestions please let me know--and do please make sure you backup your database before running scripts from the internet!)

Known issues

Refer to 'issues' for known issues and planned changes/enhancements.

Installation & Set-Up

Synced Preferences Plug-In

Important note: for this plug-in bundle to work correctly, my Synced Preferences for OmniFocus plug-in is also required and needs to be added to the plug-in folder separately.

Installation

  1. Download the latest release.
  2. Unzip the downloaded file.
  3. Move the .omnifocusjs file to your OmniFocus plug-in library folder (or open it to install).
  4. If desired, add one or more tags to be removed from a task after completion using the 'Preferences' action.

Actions

This plug-in contains the following actions:

Custom Complete

This action runs the onComplete function on one selected task or project, using the other functions in the customCompleteLib (detailed below).

Preferences

This action allows you to configure one or more tags that should be removed from tasks after they have been completed.

Functions

This plug-in contains the following functions within the customCompleteLib library:

loadSyncedPrefs () : SyncedPref

Returns the SyncedPref object for this plug-in.

If the user does not have the plug-in installed correctly, they are alerted.

tagsToRemove () : Array<Tag>

Returns an array of tags to be removed from tasks when they are completed, as configured in the preferences.

onComplete (task: Task)

Marks the given task as complete, and runs each of the functions below (with the task as the only parameter).

checkDependendants (task: Task)

If my Dependency OmniFocus Plug-In is installed, this runs the checkDependantsForTaskAndAncestors function on the task to check whether any dependent tasks should become available.

noteFollowUp (task: Task)

If my Delegation OmniFocus Plug-In is installed, runs the noteFollowUp action. If the task being completed is a 'follow up' task, a note is added to the original task indicating that the task has been followed up at the current time and date.

removeUnwantedTags (task: Task)

Removes any unwanted tags (specified in customCompleteConfig.js) from the task. (This is predominantly intended for repeating tasks where certain tags are intended to be applied to the current instance only.)

removeDueSoonTag (task: Task)

If my 'Tag Tasks Due Today' Plug-In is installed, removes the 'Due Today' tag from the task.

checkWorkOnTask (task: Task)

If my 'Work On...' Plug-In is installed, runs the 'onComplete' action for 'work on...' tasks, prompting the user for whether the base task is completed, should be deferred, etc.

promptIfStalled (task: Task)

If the user is not in the Projects perspective, and an action group or project is stalled as a result of completing the task, prompts the user to confirm whether they would like to review the stalled group/project, or mark it complete.