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

gruntfile documentation does not work #1

Closed
chrono opened this issue Nov 11, 2014 · 1 comment
Closed

gruntfile documentation does not work #1

chrono opened this issue Nov 11, 2014 · 1 comment

Comments

@chrono
Copy link

chrono commented Nov 11, 2014

I had to use a gruntfile like this to get things working:

'use strict';

module.exports = function(grunt) {
  grunt.initConfig({
    websequencediagrams: {
      options: {
        style: 'qsd',
      },
      foo: {
        files: {
          'foo.png': ['foo.txt'],
        },
      },
    },
  });
  grunt.loadNpmTasks('grunt-websequencediagrams');

  grunt.registerTask('default', ['websequencediagrams']);
};

notice how this differs from the current documentation which has an example like this:

grunt.initConfig({
  websequencediagrams: {
    options: {
      outputType: 'svg',
      style: 'napkin'
    },
    files: {
      'doc/default.svg': ['doc/sequence.uml'],
    },
  },
});

the files property needs to be nested in an object representing a target, such as foo.

versions:

$ grunt -V
grunt-cli v0.1.13
grunt v0.4.5
$ npm ls |grep websequence
└─┬ grunt-websequencediagrams@0.2.1
  └─┬ websequencediagrams@0.0.2
@markbirbeck
Copy link
Owner

Thanks Martin. Well spotted.

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

No branches or pull requests

2 participants