gulp-notes
Quickly scan your files for specially formatted comments and dump them to a file.
Options
fileName: 'notes.md' formats: '/*' '*/' '//' '\n' '<!--' '-->' templates: header: '# Notes\n' label: '\n## <%= label %>\n' note: '* <%= note %> - <%= fileName %>:<%= lineNumber %>\n' empty: '\nYou have literally nothing to do.\n' footer: '\nGenerated: **<%= dateCreated %>**'
How Do I Use It?
var gulp = notes= ; gulp;
Quick Example
/* BILL: Don't use a regular expression here, .indexOf is plenty idiot! */var index = file; /* FIXME: Extra plus dumb dumb */var durr = 'Hello +' + World; // TODO: Make some useful examples.var example = true;
Then we gulp
and get this beautiful thang.
# Notes ## BILLDon't use a regular expression here, .indexOf is plenty idiot! - **js/file.js:1** ## FIXME* This is broken - **js/file.js:4** ## TODO* Make some useful examples. - **js/file.js:7** Generated: **Saturday, March 1st, 2014, 1:20:35 PM**