Pure JS Drafter built with Emscripten
npm install drafter.js!logo
Snowcrash parser harness
drafter.js is a pure JavaScript version of the drafter library. It
is built from the C++ sources
using emscripten. It's
API compatible
with Protagonist, the
Drafter Node binding.
drafter.js can be installed from NPM, or it can be downloaded from the releases
page.
NOTE: If you're using Node, we recommend that you use the Drafter
NPM package instead of drafter.js
directly. Drafter NPM will attempt to install the pure C++ parser and fallback
to using drafter.js.
``shell`
$ npm install drafter.js
If you've installed drafter.js via NPM and using drafter.js in Node, you can
require it via:
`javascript`
var drafter = require('drafter.js')
Node versions supported: >=4
It works on 0.10 or 0.12 too but without any guarantees and expect it to be
significantly slower.
If instead, you are using drafter.js in a Browser. You can include it via the
HTML script tag.
`html`
Once you've included drafter.js, you can parse an API Blueprint:
`javascript
var res = drafter.parse('# API Blueprint...', {generateSourceMap: true}, function (err, res) {
if (err) {
console.log(err)
}
console.log(res);
});
`
Supported options:
- generateSourceMap: Set to export sourcemap information.json
- : Set to false to disable parsing of the JSON data. You willrequireBlueprintName
instead get a JSON string as the result.
- : Set to generate an error if the blueprint isgenerateMessageBody
missing a title.
- - Enable generation of messageBody from MSON (default: true)generateMessageBodySchema
- - Enable generation of messageBodySchema from MSON (default: true)
Or if you want just to validate it and are interested only in parsing
errors and warnings:
`javascript
var res = drafter.validate('# API Blueprint...', {requireBlueprintname: true}, function (err, res) {
if (err) {
console.log(err)
}
if (res) {
console.log("Document has semantic issues!");
console.log(res);
} else {
console.log("Document is valid with no warnings.");
}
});
`
Supported options:
- json: Set to false to disable parsing of the JSON data. You willrequireBlueprintName
instead get a JSON string as the result.
- : Set to generate an error if the blueprint is
missing a title.
These are not a real async API calls - their presence is merely for API compatibility
with protagonist
#### Synchronous API
Both functions have their synchronous counterpart which instead of callback return the result and in case of error throw exception.
- parseSync(source, options)
-
Unfortunately building drafter.js works only on a *nix environment at the
moment.
1. Building is easy using Docker.
2. Build
`shell`
$ ./scripts/wrap.js
$ docker pull "apiaryio/emcc:1.37"
$ docker run -v $(pwd):/src -t apiaryio/emcc:1.37 emcc/emcbuild.sh
or with
shell`
$ npm run build
3. Check out the ./scripts/test.js and ./scripts/test.html files fornpm install
example usage. You can also use and then npm test to run the
tests.
The resulting stand-alone library drafter.js is in the ./lib directory.drafter.js.mem
Don't forget to serve the file as it is required bydrafter.js. There is also a single-file version in drafter.nomem.js that
can be used, but it may take longer to load in a web browser
environment. It is the default for node.js enviroment.
To get a debug version or version enabled to be used with emrun runemcbuild.sh
the script it with -d or -e respectively.
#### Squeeze the size
If you want to squeeze the size to a minimum install
uglify-js and try running
uglifyjs lib/drafter.js -o drafter.js -c;, this will useuglify-js with compression, beware that this might cause somedrafter.js
errors, if you encounter them try without it to verifyuglify-js` and report it please.
that it is caused by