Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds Command Line Interface for generating PNGs from mermaid description files #69

Merged
merged 5 commits into from
Dec 21, 2014

Conversation

fardog
Copy link
Contributor

@fardog fardog commented Dec 21, 2014

As discussed in #6, the following PR adds a CLI for mermaid which is exposed as a mermaid command when installed globally, via npm install -g mermaid. mermaid will look for the phantomjs command in your PATH and give helpful errors if it's not found, or is too old. Additionally, you can specify the path to phantomjs with the -e switch.

Otherwise, functionality is identical to my mermaid-cli package, which will be deprecated once this PR is accepted and a new version including the CLI is published. Then, we can focus on improvements here!

@fardog
Copy link
Contributor Author

fardog commented Dec 21, 2014

An item that I'd like to dicuss is testing; the test harness that's already included with mermaid isn't suitable for testing a CLI tool, so I added tests that are based on tape a very minimal TAP-producing test harness. However, outside of exposing gulp tape to run these tests, I have not integrated them anywhere; I'd appreciate guidance on how this could be added so Travis can run these tests, or, if you want to go ahead and merge and then integrate them how you see fit, that's good by me!

knsv added a commit that referenced this pull request Dec 21, 2014
Adds Command Line Interface for generating PNGs from mermaid description files
@knsv knsv merged commit a83639a into mermaid-js:master Dec 21, 2014
@knsv
Copy link
Collaborator

knsv commented Dec 21, 2014

Great work! Nice to soon be able to close Issue #6.

I will add a new gulp task 'test' which depends on both the jasmine tests and the tape tests. Then I will let travis run this new task.

Thanks! This is a highly requested feature!

@fardog
Copy link
Contributor Author

fardog commented Dec 21, 2014

Excellent! Feel free to mention me on any bugs and enhancements that come in for the CLI, and I can help you keep it maintained.

@knsv
Copy link
Collaborator

knsv commented Dec 22, 2014

Sounds like a plan! Thanks again for your help!

Knut Sveidqvist
Sent with Sparrow (http://www.sparrowmailapp.com/?sig)

On Monday 22 December 2014 at 00:31, Nathan Wittstock wrote:

Excellent! Feel free to mention me on any bugs and enhancements that come in for the CLI, and I can help you keep it maintained.


Reply to this email directly or view it on GitHub (#69 (comment)).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants