Hooks

- Added README describing the hook system.
- Corrected hook interface details regarding exit codes.

scripts/hooks/README

@@ -0,0 +1,26 @@
+Example Hook Scripts
+
+Hooks are supported in Taskwarrior 2.4.0 and later. Hooks require no
+configuration, and simply need to exist, in the expected location, with the
+expected name, with execute permission. If these conditions are met, the hook
+scripts will be run.
+
+Expected Location
+  The hooks scripts all reside in one location, which is in a 'hooks'
+  subdirectory, in your ~/.task (or rc.data.location override) directory.
+
+Expected Name
+  A hook scripts must be named according to which event triggers the script. A
+  script named 'on-add' will be triggered by a task add event. Multiple hook
+  scripts can coexist, and will all be run, in collating sequence. If there are
+  two scripts, named 'on-add-check-for-missing-priority' and 'on-add.x', they
+  are both executed, in the order shown here.
+
+Expected Permissions
+  A hook script must have execute permission for the user running taskwarrior,
+  otherwise it is skipped.
+
+Interface
+  Each hook script has a unique interface. This is documented in the example
+  scripts here.
+

scripts/hooks/on-add

@@ -16,7 +16,7 @@ echo on-add
 # Exit:
 #   0 Means:     - all emitted JSON lines are added/modified
 #                - all emitted non-JSON lines become footnote entries
-#   1 Means: - all emitted JSON lines are ignored
+#   non-0 Means: - all emitted JSON lines are ignored
 #                - all emitted non-JSON lines become error entries
 exit 0
 

scripts/hooks/on-exit

@@ -13,6 +13,6 @@ echo on-exit
 
 # Exit:
 #   0 Means:     - all emitted non-JSON lines become footnote entries
-#   1 Means: - all emitted non-JSON lines become error entries
+#   non-0 Means: - all emitted non-JSON lines become error entries
 exit 0
 

scripts/hooks/on-launch

@@ -15,7 +15,7 @@ echo on-launch
 # Exit:
 #   0 Means:     - all emitted JSON lines are added/modified
 #                - all emitted non-JSON lines become footnote entries
-#   1 Means: - all emitted JSON lines are ignored
+#   non-0 Means: - all emitted JSON lines are ignored
 #                - all emitted non-JSON lines become error entries
 exit 0
 

scripts/hooks/on-modify

@@ -18,7 +18,7 @@ echo on-modify
 # Exit:
 #   0 Means:     - all emitted JSON lines are added/modified
 #                - all emitted non-JSON lines become footnote entries
-#   1 Means: - all emitted JSON lines are ignored
+#   non-0 Means: - all emitted JSON lines are ignored
 #                - all emitted non-JSON lines become error entries
 exit 0