prantlf/grunt-scruffy

Grunt task to generate images from yuml diagram sources by scruffy

grunt-scruffy

This module provides a grunt multi-task generating images from yuml diagram sources using scruffy.

If you generate HTML technical documention from textual sources, you may want to maintain only sources of UML diagrams in your repository and generate the pictures only during the documentation build. You will be able to do changes easily, without committing both diagram sources and pictures and sychronizing them manually.

If you want to just quickly convert a yuml source file to a picture, you can use the scruffy command-line tool, which this task is based on.

Installation

You need node >= 4, npm and grunt >= 0.4 installed and your project build managed by a Gruntfile with the necessary modules listed in package.json. If you haven't used Grunt before, be sure to check out the [Getting Started] guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may ensure native dependencies of this plugin and install it:

1. Install pre-requisites of scruffy depending on your operating system (Python 2.7, OSX and Ubuntu tested):

$ sudo apt install graphviz plotutils imagemagick librsvg2-bin \
                   python2.7 python-pip
$ pip install --user -U pip
$ pip install --user 'django<2.0'
$ pip install --user image scruffy

2. Install the Grunt task:

$ npm install grunt-scruffy --save-dev

Configuration

Add the scruffy entry with the scruffy task configuration to the options of the grunt.initConfig method:

grunt.initConfig({
  scruffy: {
    one: {
      files: {
        'dist/doc/images/diagram.png': ['doc/images/diagram.yuml']
      }
    },
    all: {
      src: ['doc/images/*.classses.yuml']
      dest: 'dist/doc/images'
    }
  }
});

The configuration consists of key-value pairs with the output image path as a key pointing to the yuml input file. If you specify more source files by wildcards, the destination should be a directory; the source file extension wil lbe replaced by the output format in the output file name.

Then, load the plugin:

grunt.loadNpmTasks('grunt-scruffy');

Build

Call the scruffy task:

$ grunt scruffy

or integrate it to your build sequence in Gruntfile.js:

grunt.registerTask('default', ['scruffy', ...]);

Customizing

Default behaviour of the task can be tweaked by the task options; these are the defaults:

grunt.initConfig({
  scruffy: {
    one: {
      files: {
        'dist/doc/images/diagram.png': ['doc/images/diagram.yuml']
      },
      options: {
        scruffy: true,
        shadow: false,
        type: 'class',       // class|sequence
        format: 'png',       // png|svg
        fontFamily: 'Purisa'
      }
    }
  }
});

See the parameters of the command-line scruffy tool or run suml --help for more information.

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• 2018-04-27 v1.0.0 Dropped support of Node.js 4
• 2017-02-23 v0.2.1 Update dependencies
• 2016-26-08 v0.2.0 Upgrade to Grunt 1.x
• 2016-03-05 v0.1.1 Update dependencies, improve build testing
• 2016-01-10 v0.1.0 Initial release

License

Copyright (c) 2016-2019 Ferdinand Prantl

Licensed under the MIT license.

grunt-scruffy's Issues

An in-range update of semantic-release is breaking the build 🚨

Version 15.5.4 of semantic-release was just published.

Branch	Build failing 🚨
Dependency	[semantic-release](https://github.com/semantic-release/semantic-release)
Current Version	15.5.3
Type	devDependency

This version is covered by your current version range and after updating it in your project the build failed.

semantic-release is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

• ❌ continuous-integration/travis-ci/push The Travis CI build could not complete due to an error Details

---

Release Notes

v15.5.4

15.5.4 (2018-06-15)

Bug Fixes

• use git ls-remote to verify if the remote branch is ahead (2b6378f)

Commits

The new version differs by 2 commits.

• 2b6378f fix: use git ls-remote to verify if the remote branch is ahead
• 24a8052 refactor: simply EGITNOPERMISSION error parameters

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

---

Your Greenkeeper Bot 🌴

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀