https://github.com/imdone/imdone-echo-plugin
Example plugin for imdone that logs to console using debug
https://github.com/imdone/imdone-echo-plugin
Last synced: 6 months ago
JSON representation
Example plugin for imdone that logs to console using debug
- Host: GitHub
- URL: https://github.com/imdone/imdone-echo-plugin
- Owner: imdone
- License: mit
- Created: 2014-05-06T23:39:38.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-05-08T05:20:38.000Z (about 12 years ago)
- Last Synced: 2025-08-09T08:34:20.755Z (12 months ago)
- Language: JavaScript
- Homepage:
- Size: 152 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
imdone-echo-plugin
==================
Example plugin for iMDone that logs to the console
Getting started with iMDone plugins
----
### Overview
iMDone loads plugins that are mentioned in the `.imdone/config.json` file in your project directory. It looks for them in your project directory under `node_modules` then in your home directory under `node_modules`, then by name. So if you include a `plugin.js` that implements the plugin interface in your project, you can load it directly or install one using `npm install -g`.
### Install
1. `npm install -g imdone-echo-plugin`
2. `cd /my/project/folder` One that already has a `.imdone/config` or create it.
3. `imdone -o`
### Plugin interface
All plugins should expect a config and repo. Take a look at this example config. The plugins hash contains the plugin package name or path with it's config hash as the value. Repo is the [Repository](https://github.com/imdone/imdone-core/blob/master/lib/repository.js) object for the project.
```json
{
"exclude": [
"^(node_modules|bower_components|\\.imdone|target|build)\\/?|\\.(git|svn)|\\~$|\\.(jpg|png|gif|swp|ttf|otf)$"
],
"watcher": true,
"lists": [
{
"name": "TODO",
"hidden": false
},
{
"name": "DOING",
"hidden": false
},
{
"name": "DONE",
"hidden": false
}
],
"marked": {
"gfm": true,
"tables": true,
"breaks": false,
"pedantic": false,
"sanitize": true,
"smartLists": true,
"langPrefix": "language-"
},
"plugins": {
"imdone-echo-plugin": {
"name": "imdone:echo"
}
}
}
```
After starting iMDone and adding a project, you will find the `.imdone/config.json` in the project directory.