https://github.com/nicojs/node-sdedit

A wrapper to use sdedit with nodejs
https://github.com/nicojs/node-sdedit

Last synced: 29 days ago
JSON representation

A wrapper to use sdedit with nodejs

• Host: GitHub
• URL: https://github.com/nicojs/node-sdedit
• Owner: nicojs
• License: apache-2.0
• Created: 2017-11-20T16:33:58.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T17:24:27.000Z (almost 2 years ago)
• Last Synced: 2024-09-24T06:45:35.091Z (about 2 months ago)
• Language: TypeScript
• Size: 754 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/nicojs/node-sdedit.svg?branch=master)](https://travis-ci.org/nicojs/node-sdedit)

[![Mutation testing badge](https://badge.stryker-mutator.io/github.com/nicojs/node-sdedit/master)](https://stryker-mutator.github.io) 

sdedit

===

Generate sequence diagrams from clear text using sdedit, created by Markus Strauch, [http://sdedit.sourceforge.net/](http://sdedit.sourceforge.net/).

## Install

Install using

```

$ npm install sdedit

```

The sdedit.jar file is automatically installed in a post install step, but if that fails you can download it yourself using `sdedit update`.

## Dependencies

This package **requires java** to be installed and put on your PATH environment variable, as this package is just a wrapper around the sdedit java application.

## Usage

To learn more about the awesome sdedit application, including the sdedit domain specific language (DSL), see [http://sdedit.sourceforge.net/](http://sdedit.sourceforge.net/).

This package can be used from the command line as well as programmatically. When installing this package, `sdedit update` is called automatically, which in turn downloads the `sdedit.jar` file, used to create your sequence diagrams. If that command failed for some reason, you can retry it yourself by running `sdedit update` (`./node_modules/.bin/sdedit update`).

### Command line interface (CLI)

```

Usage:

 sdedit update

 sdedit run

 sdedit run [arguments]

Download and run the sdedit jar.

Options:

 -h, --help     Output this help

 [arguments]    Any of the arguments documented here: http://sdedit.sourceforge.net/command_line/index.html

Examples:

 sdedit update

   Installs the sdedit.jar

 sdedit run

   Run the sdedit UI

 sdedit run -o /tmp/sequence.png -t png /tmp/examples/sequence.sd

   Creates /tmp/sequence.png based on the sequence diagram in /tmp/examples/sequence.sd.

```

### Programmatically

You can use both the `SdEdit` class and `SdEditDownloader` classes to perform both `run` and `update` respectively:

```javascript

const SdEdit = require('sdedit').SdEdit;

const SdEditDownloader = require('sdedit').SdEditDownloader;

new SdEditDownloader(/*force*/ false)

  .update()

  .then(() => console.log('Done'))

// Executes synchronously

new SdEdit(['-o', '/tmp/sequence.png', '-t', 'png', '/tmp/examples/sequence.sd'])

  .run();

```

## TypeScript

This wrapper is created with TypeScript. Type definitions are included in the package.

### License

This package is licensed under Apache-2. The sdedit java application is created by Markus Strauch under the [BSD license](http://sdedit.sourceforge.net/copyright/index.html).