Releases: apiaryio/protagonist
Maintenance Release: Inheritance fixes
This update now uses Drafter 2.1.1. Please see Drafter 2.1.1 for the list of changes.
Renaming exportSourcemap to generateSourceMap
This release renames the exportSourcemap
option available in protagonist.parse
API to generateSourceMap
to standardise it according to the industry standards.
Please note that we also support exportSourcemap
to keep the library backward compatible.
JSON Schema
This update now uses Drafter 2.1.0. Please see Drafter 2.1.0 for the list of changes.
We also support Node.js version 5.
Parse Result Release
This update now uses Drafter 2.0.0. Please see Drafter 2.0.0 for the list of changes.
Packaging Fix
This release fixes a packaging problem causing the previous release to be un-installable.
Packaging Fix
This release fixes a packaging problem causing the previous release to be un-installable
Source Maps
Enhancements
- Protagonist is now capable of generating source maps when using the refract output structure type.
Bug Fixes
- Various bugs while rendering JSON from MSON have been addressed by upstream changes to Drafter.
drafter#117
drafter#136
drafter#137
drafter#141
Known Issues
- There is a known memory leak while generating source maps.
Packaging Fix
This release is identical to the 1.1.0 release with Node.js 3 and 4 support, but fixes a packaging bug that caused installation to fail.
Node 3 and 4 Support
Enhancements
- Node 3 and 4 are now supported.
Bug Fixes
- Errors produced by internal components such as Drafter are now caught and shown as parse results.
Refract Release
This release updates drafter and changes the default output format to use Refract elements via the Parse Result Namespace without the Annotation and Source Map.
- Update to drafter 1.0.0
- Add a new
type
option to theparse
andparseSync
methods, which defaults to'refract'
but can also be set to'ast'
to get API Blueprint AST Parse Result returned.
This major release is backward-incompatible, but the old behavior can be accessed via:
var protagonist = require('protagonist');
protagonist.parse('# My API', {type: 'ast'}, function (err, result) {
// The `result` here is an API Blueprint AST Parse Result, just like before!
});
Drafter v1.0.0