A simple to-do plugin for Adobe Brackets IDE
JavaScript HTML CSS
Latest commit b051e02 Mar 8, 2015 @ovk Increase version number

README.md

Brackets Simple To-Do

An Adobe Brackets extension to create and manage simple to-do list.

Features:

  • Flat and categorized to-do list support
  • To-do list can be stored in human-readable text file with configurable format
  • Alternatively, to-do list can be stored in Trello

Extension demo:

demo

Flat to-do list (without categories):

todo

Mixed to-do list (two uncategorized tasks, and two collapsed categories):

todo

Installation

The easiest way to install the extension is using Brackets Extension Manager:

  1. Select File > Extension Manager... or click Extension Manager icon (extmgr) in the toolbar
  2. Search for 'Simple To-Do'
  3. Click the Install button

Usage

Click the Simple To-Do icon (todoicon) to show/hide to-do panel.

Simple To-Do Panel:

panel

There are six icons in the panel header (left-to-right):

  1. Refresh to-do list
  2. Add new uncategorized task
  3. Add new category
  4. Toggle completed tasks and categories categories visibility
  5. Open Simple To-Do settings dialog
  6. Close simple to-do panel

To edit any task or category simply click on its name. While task/category in edit mode, there are three buttons on the right side:

taskedit

These buttons are (left-to-right):

  1. Accept changes and save task/category.
  2. Decline changes. If task/category is being added this button means 'do not add'.
  3. Associate this task with currently opened file in the Brackets editor.
  4. Delete task/category. This button is only available when editing existing task/category.

To add task to any category, click on the 'plus' icon near the category name.

General Settings

generalsettings

Show/Hide Panel Hotkey

You can select a key combination to show/hide Simple To-Do panel. The default value is Ctrl-Shift-T.

Add Task Hotkey

You can select a key combination to add a new not catecorized task. The default value is Ctrl-Shift-A.

To-Do Items Storage

Here you can select where to store your to-do list. Two options are available in the current release - Text File (default) and Trello. Only one storage can be selected, but you can switch between them any time.

Delete Completed

On checking this option all of your existing completed tasks will be permanently deleted. While this option is checked, each task will be deleted as soon as it is marked as completed.

Text File Storage

This is the default storage for your tasks. When it is selected, to-do list will be stored by default in text file inside the root folder of the active Brackets project. Simple To-Do will automatically switch to different file when active Brackets project is changed (i.e. by default to-do list files are 'per-project'). The default file name is {PROJECT}/todo.txt (the {PROJECT} variable is replaced with the actual full path of the current project). To make a to-do list file global, just set file name to some absolute path, for instance C:\todo.txt.

The default file format looks like this:

- Some task
- Another task
+ This task is completed

# Some Category
- Task in 'Some Category'

Settings

textfilesettings

To-Do File Name

Name of the file where to-do list will be stored. Name is relative to active project root folder. Default name is todo.txt.

Category Prefix

String prefix which will be used to mark category name. Default value is #.

Completed Item Prefix

String prefix which will be used to mark completed tasks. Default value is +.

Incomplete Item Prefix

String prefix which will be used to mark incomplete tasks. Default value is -.

Important: backup your to-do file before changing any prefixes. Simple To-Do won't understand file with old prefixes and therefore will erase it.

Trello Storage

You can connect Simple To-Do to your Trello account and store your to-do list as a Trello list. Thus, you can access it from different computers or via Trello website.

Note: Trello storage doesn't support uncategorized tasks, i.e. each task should be within some category.

Note: Trello storage doesn't support associating task with a file.

To use Trello storage you should provide your Trello API Key and Token (so Simple To-Do can authenticate to Trello) and select board and list where to store your to-do list.

Settings

trellosettings

Trello Authentication

To get your Trello API Key click on the link Click Here To Get Trello API Key. A web page should appear with your key:

apikey

Copy your API Key to settings dialog and then click on the link Click Here To Get Trello Token. A web page should appear asking whether you allow Simple To-Do to use your account, and after clicking on Allow you should see your token. Please copy your token to settings dialog.

Note: you can revoke permissions granted to Simple To-Do in your Trello account settngs, under the Applications section

Important: Your Trello API Key and Token are stored in Brackets settings as plain text, so anyone with access to your computer could see and use them.

Select Trello List

When both Trello API Key and Token are filled, you can click on Refresh link to load your Trello boards and lists.

trelloboards

Here you can select existing Trello board and list, where you to-do items will be stored.

Note: inside Trello list, each card represents a category, and checklist inside this card used to store to-do items. However, if any of your cards already have more than one checklist - Simple To-Do may not work correctly (only one checklist per card is supported).