imdone-atom-harbour

A TODO comment task-board that does your issue tracking so you can stay in the zone.
hernad
2.0.18 579
Flag as spam or malicious

The TODO comment task board

Turn your TODO comments into a task-board and let imdone.io do your issue tracking so you can stay in the zone.
Just use alt+t while editing a file to see your projects board.

Static imdone image

apm apm

You live in the code, your tasks should too!

Developers are creative people and the text editor is their canvas. For decades they've used TODO style code comments to track issues that almost never end up in issue tracking software. imdone is a plugin for your favorite text editor that turns code comments into trackable issues that you can update from your code. It collects all TODO style comments in your project and organizes them in a drag and drop task-board that integrates with any web based issue tracking system.

imdone works best with todo.txt and markdown syntax. See the syntax guide at imdone-core for details.

Whats new!

  • Stay in the zone! Track Github issues with TODO comments in your code. Sign up at imdone.io!
  • Zoom your board. See the commands bellow.

And more!

  • :notebook_with_decorative_cover: Todays's Journal - Open today's journal file as configured in settings. Great for people who like to keep plain text notes.
  • :zap: Open all files for visible tasks!
  • Open task links in intellij family of products with imdone-atom and imdone intellij plugin!
  • How To Write Plugins for imdone-atom
  • Link your TODO comments to github issues. Try the imdone-atom-github plugin!

Install

$ apm install imdone-atom

or open Atom and go to Preferences > Install and search for imdone-atom

Commands

Command Palette Key Mapping Description
Imdone Atom: Tasks Alt+T Open task board
Imdone Atom: Todays Journal Alt+J Open todays journal file
Imdone Atom: Board Zoom In Alt+. Zoom in board
Imdone Atom: Board Zoom Out Alt+, Zoom out board

Settings

Name Type Default Description
Exclude Vcs Ignored Paths boolean false Exclude files that are ignored by your version control system
File Opener Port integer 9799 Port the file opener communicates on
Max Files Prompt integer 2500 How many files is too many to parse without prompting to add ignores?
Open in Intellij string '' Glob pattern for files that should open in Intellij.
Show Notifications boolean false Show notifications upon clicking task source link.
Show Tags Inline boolean false Display inline tag and context links in task text?
Today's Journal Date Format string YYYY-MM-DD How would you like your date variable formatted?
Today's Journal Directory string $HOME/notes Where do you want your journal files to live? (Their project directory)
Today's Journal File Name Template string ${date}.md How do you want your journal files to be named?
Today's Journal Month Format string YYYY-MM How would you like your month variable formatted for use in directory or file name template?
Use Alternate File Watcher boolean false If your board won't update when you edit files, then try the alternate file watcher
Zoom Level Number 1 Set the default zoom level on startup. min: .2, max: 2.5

Ignoring files

  • Configuration setting
    You can ignore files with the "Exclude Vcs Ignored Paths" setting

  • .imdoneignore
    .imdoneignore is implemented using the ignore package. Each file in your projects path is tested against the rules in .imdoneignore.
    To ignore all but some subdirectories, see this Stack Overflow question. git - .gitignore exclude folder but include specific subfolder - Stack Overflow

  • .imdone/config.json
    imdone will also ignore files and folders that match a regex in the .imdone/config.json, exclude array. The array is seeded with some common excludes on first run.

IMPORTANT: If your project is large (#files > 1000) consider adding an .imdoneignore file.

How To Link Code And Github Issues

Using todo.txt metadata in your tasks and a minor change to .imdone/config.json, you can link to external resources like github issues and profiles.

  • Add a meta attribute to .imdone/config.json 
"meta": {
  "issue": {
    "urlTemplate": "https://github.com/imdone/imdone-core/issues/%s",
    "titleTemplate": "github issue #%s"
  }
}
  • Use issue:[gh issue id] as metadata in your tasks.
  • Your issue is linked to the comment!
    gh-issue-imdone

Look at imdone/imdone-core#metadata for more info.