search

imdone / imdone-atom

imdone-atom has been archived
https://imdone.io/docs
MIT License
222 stars 18 forks source link

document events emitted by imdone-core #75

Open jronallo opened 8 years ago

jronallo commented 8 years ago

Is there any documentation for a plugin author to know what events they can hook into. For for https://github.com/jronallo/gfm-todotxt there are a couple events that I'm uncertain whether they're available. For instance is there an event emitted when a particular task changes rather than the whole board changing? Listening for a single task change would make plugins more performant. Also is there an event for when the whole board is initialized or ready? I'd like to run my due date highlighting on startup and not only after the board has been updated in some way.

Having documentation for the events you can listen for and a pared down, very simple example of how to get started could help plugin authors. I already have a couple more ideas for extensions I'd like to make. Once you have all your todos in one place and can filter them, there's a lot more I could see doing to augment views, add new views, or include custom shortcuts.

piascikj commented 8 years ago

@jronallo What your looking for is in the imdone-core library. I'll document those events in the next day and update this ticket when it's ready.

jronallo commented 8 years ago

Ah, OK. Should have known to look there. Also I need to learn not to even attempt to use the github repository search when trying to find something like this. Better to just clone and search.