Link Search Menu Expand Document

Avoid repitition with reusable snippets

If you have a series of tasks that are often repeated between Bunches, you can separate them into their own “snippet” file and include them in any Bunch.

A snippet file can be named with any extension other than .bunch, and can be stored in the same folder as your Bunches or in a subfolder.

To include a snippet in a bunch, use < on a line in the Bunch.

Snippet Variables

To make snippets flexible, Bunch handles variables defined in the containing Bunch and replaced within the snippet. These are defined like files on the lines following the < line.

< generic.snippet
- proj_path=~/Code/MyProject

Now you can use ${proj_path} anywhere in your snippet file, allowing you to use the same snippet for different projects.

- ${proj_path}/todo.taskpaper
- ${proj_path}

Default Variable Values

If a snippet has variable placeholders but no values are provided when it’s called, the placeholders will be removed. You can instead provide default values that will be used if no matching key/value pair is provided. To do this, just use a colon followed by the default within the placeholder:


Referencing partial snippets (fragments)

You can define multiple snippets together in one file and label the sections with a hash and square brackets:

#[Section Label]

#[Another Section]

Then you can reference the snippet with a fragment identifier, like this:

<MySnippet.snippet#Section Label

If you load a snippet containing sections without using a fragment id, i.e. just <MySnippet.snippet, it will run all of the sections in the snippet.

Optional Snippets With Dialog

You can have Bunch ask whether a snippet should be loaded when opening a Bunch by adding a query at the end of it. The format for the query is a question mark (?) immediately followed by a double-quoted string. The string within the quotes will be used as the text of the dialog, with buttons “Yes” and “No”.

< MySnippet.snippet ?"Load My Snippet?"

When the Bunch is launched, a dialog will ask “Load My Snippet?” and request user interaction. Clicking “Yes” will load the referenced snippet, clicking “No” will skip loading it. This can be used with variables and fragments, as well:

<General.snippets#Spotify ?"Play some music while you work?"
- url=spotify:playlist:3cSpIL4Q0H3uqdBMbT6c9x
- autoplay=true

You can include multiple optional snippets, but — due to the asynchronous way Bunches are launched — the questions may not be asked in file order. Be sure to make the queries descriptive!

Also, options only apply to regular snippets, not snippets specified for “on close” with !. If you apply a query to an “on close snippet,” the question will still be asked on launch.