Skip to content

Commit

Permalink
Prepare for new feature work.
Browse files Browse the repository at this point in the history
  • Loading branch information
piascikj committed Feb 22, 2018
1 parent 3b9f4a4 commit 657ce9e
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .imdone/sort.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"BACKLOG":[null,"7","13","6"],"TODO":["28","29","27","22","20","23","19","14","2","12","9","16","15","3","10","1","7","5","0","18","13"],"DOING":["28","26","22","21","20","23","27"],"DONE":["21","17"],"Doing":["6e0b990633752e6b32e135ba687b0186d3462d1c"],"Todo":["20","23"],"never":["20"],"Never":["20"]}
{"BACKLOG":[null,"7","13","6"],"TODO":["17f49b83456211740656484f402f526959b85d04","bb876a3eec5c634e9792060646f1a13c773f96d5","af1302ed31005e0b2fdf550cc9542f99879f3796","1fde288f5d877b3558829570f17ccb8d34422499","28","29","27","22","20","23","19","14","2","12","9","16","15","3","10","1","7","5","0","18","13"],"DOING":["28","17f49b83456211740656484f402f526959b85d04","26","22","21","20","23","27","ad74537729bd8997494a46b143fc20d41248bb4a","435f35a4d93c52c2256e8ab3d48b86ce397a3d9d","4180db6aab53d03c27b7ea4f32ef8a8393d3505b"],"DONE":["21","17"],"Doing":["6e0b990633752e6b32e135ba687b0186d3462d1c"],"Todo":["20","23"],"never":["20"],"Never":["20"]}
12 changes: 12 additions & 0 deletions .imdone/templates/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: feature
directory: features
type: file
workflow: # Array of lists like config.json
template: |
#BACKLOG: Feature name
## Business Benefit
## Acceptance Criteria
- [ ] criteria description
Stories
----
2 changes: 2 additions & 0 deletions .imdoneignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
!lib/**/*
!test
!test/**/*
!docs
!docs/**/*
!DoD.md
!README.md
test/repos
Expand Down
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Task descriptions are captured from the lines that follow a task. In code files
}
```
<!--
#DOING: Add Node.js API SECTION id:28 gh:129 ic:gh
#TODO: Add Node.js API SECTION id:28 gh:129 ic:gh
## Node.js API
### Generated Docs
- use [jsdoc3/jsdoc: An API documentation generator for JavaScript.](https://github.com/jsdoc3/jsdoc)
Expand All @@ -146,6 +146,16 @@ Task descriptions are captured from the lines that follow a task. In code files

Resources
----
- [I Still Use Plain Text for Everything, and I Love It](https://lifehacker.com/i-still-use-plain-text-for-everything-and-i-love-it-1758380840)
- [Why Geeks Love Plain Text (And Why You Should Too)](http://www.lifehack.org/articles/technology/why-geeks-love-plain-text-and-why-you-should-too.html)
- [The Benefits of Using Plain Text | Terminally Incoherent](http://www.terminally-incoherent.com/blog/2007/07/18/the-benefits-of-using-plain-text/)
- [The future of education is plain text · Simply Statistics](https://simplystatistics.org/2017/06/13/the-future-of-education-is-plain-text/)
- [The future of education is plain text | Hacker News](https://news.ycombinator.com/item?id=14545250)
- [Derry Birkett › Plain text is the best UX](http://derrybirkett.com/comment/plain-text-is-the-best-ux/)
- [Tools – The Plain Text Project](https://plaintextproject.online/tools.html)
- [The Plain Text Workflow · Richard A. Lent, Ph.D.](https://richardlent.github.io/post/the-plain-text-workflow/)
- [My Plain Text Workflow – Doyce Testerman](http://doycetesterman.com/index.php/2014/12/my-plain-text-workflow/)
- [Word Processors: Stupid and Inefficient](http://ricardo.ecn.wfu.edu/~cottrell/wp.html)
- [Is the keyboard faster than the mouse? | Hacker News](https://news.ycombinator.com/item?id=14544571)
- [Blog | Personal Kanban](http://personalkanban.com/pk/blog/)
- [Do TODO comments make sense? - Software Engineering Stack Exchange](https://softwareengineering.stackexchange.com/questions/125320/do-todo-comments-make-sense)
Expand All @@ -161,3 +171,8 @@ License
[downloads-url]: https://npmjs.org/package/imdone-core
[travis-image]: https://img.shields.io/travis/imdone/imdone-core/master.svg?label=linux
[travis-url]: https://travis-ci.org/imdone/imdone-core

<!--
- #TODO: As a vscode user I would like to see the imdone board in vscode so I can get shit done!
-->
File renamed without changes.
14 changes: 14 additions & 0 deletions docs/features/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#DOING: As a user I would like to create new files in my project from templates I define, so I can save time creating files and content +story
- [ ] Use dropdown on alt+p and alt+j to show templates
#TODO: As a user I would like to create a TODO in a readme.md file, and have a link created to the issue created on imdone.io
- [ ] Create link outside of comment
#TODO: As a user I would like to add content to my TODO descriptions from markdown templates stored in my project
- [ ] Append templates to tasks with `t:<type>` metadata in them. (e.g. `t:story`)
- [ ] if TODO appears in a single line comment, append template with single line comment prefix and the same indentation as the TODO comment
- [ ] If TODO appears in a multiline comment, just append template at the same indentation as the TODO comment
- [ ] Remove `t:story` after the template has been appended to the description
- [ ] templates.md will contain templates in the format...
```
# <type>
Any markdown for your template
```
2 changes: 2 additions & 0 deletions lib/file.js
Original file line number Diff line number Diff line change
Expand Up @@ -503,6 +503,8 @@ File.prototype.extractTasksInCodeFile = function(config) {
};

File.prototype.extractTasksInNonCodeFile = function(config) {
// TODO: As a user I would like imdone to recognize code style tasks in markdown file comments
// - If the file type has a block attribute, then search for code style tasks in comments
this.extractHashStyleTasks(config, 0, this.getContent());
this.extractLinkStyleTasks(config, 0, this.getContent());
};
Expand Down
5 changes: 5 additions & 0 deletions lib/mixins/repo-fs-store.js
Original file line number Diff line number Diff line change
Expand Up @@ -364,5 +364,10 @@ function mixin(repo, fs) {
} else cb("Unable to delete:" + path);
};

repo.getTemplates = function(qry, cb) {
// DOING: Implement getTemplates
// - [ ] Test
};

return repo;
}
18 changes: 18 additions & 0 deletions lib/repository.js
Original file line number Diff line number Diff line change
Expand Up @@ -1124,4 +1124,22 @@ Repository.prototype.usingImdoneioForPriority = function() {
return File.usingImdoneioForPriority(this.config);
};

Repository.prototype.getTemplates = function(cb) {
inMixinsNoop(cb);
};

Repository.prototype.saveWorkflow = function(name, cb) {
if (!this.config.workflows) this.config.workflows = {};
this.config.workflows[name] = _.cloneDeep(this.getLists());
// DOING: saveConfig
};

Repository.prototype.deleteWorkflow = function(name, cb) {
// TODO: implement deleteWorkflow
};

Repository.prototype.applyWorkflow = function(name) {
// TODO: implement applyWorkflow
};

module.exports = Repository;

0 comments on commit 657ce9e

Please sign in to comment.