broccoli-leasot
A broccoli plugin and an ember addon for the leasot module to parse and output markers like TODOs and FIXMEs from comments
Repo health & stats
Installation
npm install --save-dev broccoli-leasot
Screenshot
Usage
var broccoliLeasot = require('broccoli-leasot');
var tree = broccoliLeasot(someTree, options);As a Ember CLI Addon, simply npm install --save-dev broccoli-leasot and supply the options you would like:
var app = new EmberApp({
markers: {
enabled: true,
kinds: [ 'TODO', 'FIXME', 'CUSTOM']
}
});Documentation
broccoliLeasot(inputTree, options)
options.enabled {true|false}
This will eliminate processing altogether.
Default: false
options.extensions Array of file types to scan
This indicates the files with specific extensions to be scanned. The complete list can be seen at the leasot repo
Default: ['js', 'css', 'less', 'scss', 'hbs', 'handlebars']
options.kinds Array of markers
These are the markers looked up in the comments of the files which are scanned.
Default: ['TODO', 'FIXME']
options.groupBy file|kind
The broccoli plugin prints the analysis of leasot on the console. Users can choose between grouping markers by file name or kind of marker.
Default: file
Development
This plugin is all about productivity so its written in es6/2015 with the help of babel.js. The plugin code is at src/index.js. To see the compiled code run npm run compile and look at the content of lib\index.js
Interested in using babel for your next npm module, read this excellent article on this.
Tests
Running the tests:
npm install
npm test