Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sverweij/mscgen_js

text => sequence charts
https://github.com/sverweij/mscgen_js

mscgen mscgen-js sequence-chart sequence-diagram

Last synced: about 1 month ago
JSON representation

text => sequence charts

Awesome Lists containing this project

README 

        
# mscgen_js

*Turns text into sequence charts.*



[![Build Status](https://github.com/sverweij/mscgen_js/workflows/linting%20&%20test%20coverage%20-%20linux/badge.svg)][github.actions]

[![mscgen.js.org](https://img.shields.io/badge/js.org-mscgen-ffb400.svg?style=flat-squared)](https://mscgen.js.org)

- Implementation of the super easy [MscGen][mscgen] in JavaScript.

- [Embeddable][mscgenjs.embed] in your HTML.

- Try it in the [on line interactive interpreter][mscgenjs.interpreter].

- Or in [Atom][atom] with the [atom mscgen-preview package][mscgen-preview].

- Also:

  - talks a [simplified subset of MscGen][mscgenjs.wikum.msgenny] for lazy bastards.

  - speaks a [superset of MscGen][mscgenjs.wikum.xu] for the feature hungry.

  - runs in all modern browsers (and in _node.js_).

  - animates your chart.



## Sample

This sequence chart ...



![a sample sequence chart, rendered as png](wikum/readme.png)



was made with this *MscGen* source:



```mscgen

    msc {

      a [ label="Entity A", textbgcolor="red", textcolor="white" ],

      b [ label="Entity B", textbgcolor="yellow" ],

      c [ label="Entity C", textbgcolor="blue", textcolor="yellow" ];



      a->b [ label = "ab()" ] ;

      b->c [ label = "bc(TRUE)"];

      c=>>c [ label = "process(1)" ];

      b<<=c [ label = "callback()", arcskip="1"];

      |||;

      ---  [ label = "If more to run", ID="*" ];

      a->a [ label = "next()"];

      a=>c [ label = "ac1()"];

      b<b [ label = "stalled(...)"];

      a< As a special exception to the GPL, any HTML file which merely makes

function calls to mscgen-inpage.js, and for that purpose includes

it by reference shall be deemed a separate work for copyright law

purposes. In addition, the copyright holders of this code give you

permission to combine this code with free software libraries that

are released under the GNU LGPL. You may copy and distribute such

a system following the terms of the GNU GPL for this code and the

LGPL for the libraries. If you modify this code, you may extend

this exception to your version of the code, but you are not obligated

to do so. If you do not wish to do so, delete this exception statement

from your version.



### Dependencies and their licenses

mscgen_js is built on various libraries, each of which have their own

license (incidentally all MIT style):

- [requirejs][requirejs.license] is used for modularization.

- The bare (embedding only) mscgen_js is packaged using requirejs and

  [almond][almond] to be able to run as a stand alone, dependency-less

  package.

- Parsers are generated with [pegjs][pegjs.license].

- The on line interpreter additionally uses [codemirror][codemirror.license].

- The command line interface uses [phantomjs][phantomjs],

  [amdefine][amdefine.license] and [commander][commander.license]

- To run automated tests in node mscgen_js uses [jsdom][jsdom.license],

  [amdefine][amdefine.license], [node-localstorage][36] and

  [commander][commander.license].



Icons are courtesy of Dmitry Baranovskiy [license][15].



- Icons in the animation, were created with the [IcoMoon App][icomoon].

At the time the font was created it was licensed [GPLv3][license.gpl-3.0] or

[CC BY 4.0][license.ccby4]



It uses [mocha][21], [chai][39],

[istanbul][28], [eslint][22] and [dependency-cruiser][41] to 

maintain some modicum of verifiable code quality.

You can see the build history in [GitHub actions][github.actions].



## Thanks

- [Mike McTernan][mscgen.author] for creating the wonderful MscGen language,

  the accompanying c implementation and for releasing both to the public

  domain (the last one under a [GPLv2][mscgen.license] license to be precise).

- [David Majda][pegjs.author] for cooking and maintaining the fantastic

  and lightning fast [PEG.js][pegjs] parser generator.

- [Marijn Haverbeke][codemirror.author] for the snazzy

  [CodeMirror][codemirror] editor component.

- [Elijah Insua][jsdom.author] for [jsdom][jsdom], which makes it possible

  to render vector graphics in node.js.

- Audrey M. Roy for the excellent

  ["painfully obsessive cheat sheet to favicon sizes/types."][favicon].

- [Joshua Chaitin-Pollak][mscgenjs.publish], for suggesting

   to publish mscgen_js as a package.



[almond]: https://github.com/jrburke/almond

[amdefine.license]: wikum/licenses/license.amdefine.md

[atom]: https://atom.io

[codemirror]: http://codemirror.net

[codemirror.author]: http://marijnhaverbeke.nl

[codemirror.license]: wikum/licenses/license.codemirror.md

[commander.license]: wikum/licenses/license.commander.md

[favicon]: https://github.com/audreyr/favicon-cheat-sheet

[github.actions]: https://github.com/sverweij/mscgen_js/actions?query=workflow%3A%22linting+%26+test+coverage+-+linux%22

[icomoon]: https://icomoon.io/app/

[jsdom]: https://github.com/tmpvar/jsdom

[jsdom.author]: http://tmpvar.com/

[jsdom.license]: wikum/licenses/license.jsdom.md

[license.gpl-3.0]: http://www.gnu.org/licenses/gpl.html

[license.ccby4]: https://creativecommons.org/licenses/by/4.0/

[mscgen]: http://www.mcternan.me.uk/mscgen

[mscgen.author]: http://www.mcternan.me.uk/mscgen

[mscgen.license]: http://code.google.com/p/mscgen/source/browse/trunk/COPYING

[mscgen-preview]: https://atom.io/packages/mscgen-preview

[mscgenjs.docbuild]: wikum/build.md

[mscgenjs.docsource]: src/script

[mscgenjs.embed]: https://sverweij.github.io/mscgen_js/embed.html

[mscgenjs.embedpackage]: https://sverweij.github.io/mscgen_js/embed.html#package

[mscgenjs.interpreter]: https://sverweij.github.io/mscgen_js

[mscgenjs.issues.compliance]: https://github.com/sverweij/mscgen_js/labels/compliance

[mscgenjs.license]: wikum/licenses/license.mscgen_js.md

[mscgenjs.wikum.msgenny]: wikum/msgenny.md

[mscgenjs.wikum.xu]: wikum/xu.md

[mscgenjs.core]: https://github.com/sverweij/mscgenjs-core

[mscgenjs.inpage]: https://github.com/sverweij/mscgenjs-inpage

[mscgenjs.cli]: https://github.com/sverweij/mscgenjs-cli

[mscgenjs.atom.preview]: https://github.com/sverweij/atom-mscgen-preview

[mscgenjs.publish]: https://github.com/jbcpollak

[pegjs]: https://pegjs.org/

[pegjs.author]: http://majda.cz/

[pegjs.license]: wikum/licenses/license.pegjs.md

[phantomjs]: https://www.npmjs.com/package/phantomjs

[requirejs.license]: wikum/licenses/license.requirejs.md

[15]: wikum/licenses/license.icons.md

[21]: wikum/licenses/license.mocha.md

[22]: wikum/licenses/license.eslint.md

[28]: wikum/licenses/license.istanbul.md

[36]: wikum/licenses/license.node-localstorage.md

[39]: https://github.com/chaijs/chai

[40]: https://github.com/sverweij/dependency-cruiser