apiaryio / blueprint-parser

Deprecated PEG.js-based parser for parsing legacy Apiary Blueprint Format

Deprecated Apiary Blueprint Parser

You are propably looking for Snow Crash or one of its bindings (API Blueprint parser).

This repository has now become a part of fury-adapter-apiary-blueprint-parser in API Elements: JS

Apiary Blueprint Parser

A JavaScript parser of Apiary API blueprints.

Deprecation warning

The Apiary Blueprint Parser is currently frozen. No future development planned.

Please check the new API Blueprint which supersedes the Apiary Blueprint and is completely open-sourced including its parser, tools and bindings.

blueprint-parser's Issues

Empty blueprint is said to be valid

However, at least API name is required.

Guide to upgrading blueprint formats?

Is there a tutorial, guide, or automated tool to assist in upgrading a large .api file(s) using this legacy blueprint format into the new 1A format?

Looking to see if there's anything specific to assisting in format upgrades, rather than just the generic tutorial at https://apiblueprint.org/documentation/tutorial.html

Update commander to 2.19.0

Please update dependency

scope

# Represents an Apiary blueprint.
class Blueprint
  @fromJSON: (json) ->
    new this

will not result in creating new class, unless this === Blueprint

# Represents an Apiary blueprint.
class Blueprint
  self = @
  @fromJSON: (json) ->
    new self

# Represents an Apiary blueprint.
class Blueprint
  @fromJSON: (json) ->
    new Blueprint

npm install does not work

npm install does not work for this package

on ubuntu, cloning git, make and npm install works. On windows, make fails

made it work on windows by just copying the ubuntu build

README example results in error

FWIW, the README example does not show parsing of a valid Apiary Blueprint.

throw new SyntaxError(
            ^
SyntaxError: Expected "---", "HOST:" or empty line but "R" found.

Instead, there should be something like this:

var blueprint = ApiaryBlueprintParser.parse([
  "--- Sample API ---",
  "Root resource",
  "GET /",
  "< 200"
].join("\n"));

install from hash

Given the current setup, it's impossible to install from a git hash.
Unless I'm wrong, that means that whoever forks this repo needs to npm publish or git clone inside node_modules, etc