0.1.0 • Published 9 years ago
opine.js v0.1.0
opine.js
This converts Javascript inline comments by way of YAML into regularized data that can be used to generate automatic documentation.
Any block comment that starts with ---
will be parsed as YAML, with
the result added as vars
to a result.
For example, given
spec/fixtures/sample-1.js
/*---
comment: 123
*/
function fn_name() { }
/*---
trying: something
*/
var x
then running
var opine = require('opine')
opine.rip_file('./spec/fixtures/sample-1.js')
returns something like this:
[ { type: 'function',
name: 'fn_name',
source: "./spec/fixtures/sample-1.js",
line: 2,
vars: { comment: 123 } },
{ type: 'var',
name: 'x',
source: "./spec/fixtures/sample-1.js"
line: 8,
vars: { trying: 'something' } }
]
0.1.0
9 years ago