Separate Railroad Diagram Generation into Scriptable Function

[kevinastone]

It would be handy to generate the railroad diagrams for documentation about my grammar. It seems to only exist in the gh-pages branch for the online documentation. Could you package this up as part of the distro so consuming apps can generate their own documentation?

Thanks (chevrotain has been great!)

[bd82]

I'm glad you are finding Chevrotain to be useful :).
And thanks for the suggestion, looks like a very good idea as this feature would be a "general" feature that could benefit all users.

I'll have a look at it and see what is needed to productize it.

[bd82]

Hi @kevinastone.

Please have a look at version 0.5.21
Specifically the template for generating syntax diagrams locally.
https://github.com/SAP/chevrotain/tree/master/diagrams

There is a limitation that your grammar needs to be executable in the browser.
However because your grammar file Has no dependencies other than chevrotain. it should not be difficult to browserify/webpack/umd it.

I'm unable to make the diagrams generation run in node.js(scriptable) due the railroad-diagrams library used.

However in the future I will try to make the grammar structure itself serialize-able and thus
serialize it in a node.js script and render from the serialized form.
#139

[bd82]

closed by mistake.