toga-js
v1.0.0
Published
A JavaScript inline documentation-block parser.
Downloads
32
Maintainers
Readme
NOTE: This project is under active development. APIs subject to change.
toga-js
Generates a Toga abstract syntax tree for JavaScript files using Tunic.
Install
$ npm install --save-dev toga-js
Usage
var toga = require('toga'),
js = require('toga-js'),
md = require('toga-markdown'),
pura = require('toga-pura'),
config = {
src: './src/assets/**/*.js',
dest: './web/docs'
};
toga
.src(config.src)
.pipe(js.parser())
.pipe(md.formatter())
.pipe(pura.compiler())
.pipe(toga.dest(config.dest));
Contribute
Standards for this project, including tests, code coverage, and semantics are enforced with a build tool. Pull requests must include passing tests with 100% code coverage and no linting errors.
Test
$ npm test
© 2015 Shannon Moeller [email protected]
Licensed under MIT