{"id":22423290,"url":"https://github.com/prantlf/grunt-wuml","last_synced_at":"2025-09-12T18:13:42.264Z","repository":{"id":57256281,"uuid":"49342627","full_name":"prantlf/grunt-wuml","owner":"prantlf","description":"Grunt task to generate images from yuml diagram sources by wuml","archived":false,"fork":false,"pushed_at":"2019-12-28T02:28:53.000Z","size":108,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T09:18:59.603Z","etag":null,"topics":["diagram-sources","grunt-task","uml","yuml"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/prantlf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-09T21:45:51.000Z","updated_at":"2019-09-24T07:29:25.000Z","dependencies_parsed_at":"2022-08-25T02:30:49.706Z","dependency_job_id":null,"html_url":"https://github.com/prantlf/grunt-wuml","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-wuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-wuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-wuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-wuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prantlf","download_url":"https://codeload.github.com/prantlf/grunt-wuml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245791898,"owners_count":20672667,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram-sources","grunt-task","uml","yuml"],"created_at":"2024-12-05T18:09:53.709Z","updated_at":"2025-03-27T05:40:36.178Z","avatar_url":"https://github.com/prantlf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-wuml\n[![NPM version](https://badge.fury.io/js/grunt-wuml.png)](http://badge.fury.io/js/grunt-wuml)\n[![Build Status](https://travis-ci.org/prantlf/grunt-wuml.png)](https://travis-ci.org/prantlf/grunt-wuml)\n[![Coverage Status](https://coveralls.io/repos/prantlf/grunt-wuml/badge.svg)](https://coveralls.io/r/prantlf/grunt-wuml)\n[![Dependency Status](https://david-dm.org/prantlf/grunt-wuml.svg)](https://david-dm.org/prantlf/grunt-wuml)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-wuml/dev-status.svg)](https://david-dm.org/prantlf/grunt-wuml#info=devDependencies)\n[![devDependency Status](https://david-dm.org/prantlf/grunt-wuml/peer-status.svg)](https://david-dm.org/prantlf/grunt-wuml#info=peerDependencies)\n[![Code Climate](https://codeclimate.com/github/prantlf/grunt-wuml/badges/gpa.svg)](https://codeclimate.com/github/prantlf/grunt-wuml)\n[![Codacy Badge](https://www.codacy.com/project/badge/f3896e8dfa5342b8add12d50390edfcd)](https://www.codacy.com/public/prantlf/grunt-wuml)\n[![Built with Grunt](https://cdn.gruntjs.com/builtwith.png)](http://gruntjs.com/)\n\n[![NPM Downloads](https://nodei.co/npm/grunt-wuml.png?downloads=true\u0026stars=true)](https://www.npmjs.com/package/grunt-wuml)\n\nThis module provides a grunt multi-task generating images from [yuml]\ndiagram sources using [wuml].\n    \nIf you generate HTML technical documention from textual sources, you may want\nto maintain only sources of UML diagrams in your repository and generate the\npictures only during the documentation build.  You will be able to do changes\neasily, without committing both diagram sources and pictures and sychronizing\nthem manually.\n\nIf you want to just quickly convert a yuml source file to a picture, you\ncan use the [wuml] command-line tool, which this task is based on.\n\n## Installation\n\nYou need [node \u003e= 0.12][node], [npm] and [grunt \u003e= 0.4][Grunt] installed\nand your project build managed by a [Gruntfile] with the necessary modules\nlisted in [package.json].  If you haven't used Grunt before, be sure to\ncheck out the [Getting Started] guide, as it explains how to create a\nGruntfile as well as install and use Grunt plugins.  Once you're familiar\nwith that process, you may ensure native dependencies of this plugin and\ninstall it:\n\n1. Install [pre-requisites](https://github.com/schoeffm/waggly-uml#prerequisites)\n   of [wuml] depending on your operating system\n\n2. Install the Grunt task:\n\n```shell\n$ npm install grunt-wuml --save-dev\n```\n\n## Configuration\n\nAdd the `wuml` entry with the wuml task configuration to the\noptions of the `grunt.initConfig` method:\n\n```js\ngrunt.initConfig({\n  wuml: {\n    one: {\n      files: {\n        'dist/doc/images/diagram.png': ['doc/images/diagram.yuml']\n      }\n    },\n    all: {\n      src: ['doc/images/*.classses.yuml']\n      dest: 'dist/doc/images'\n    }\n  }\n});\n```\nThe configuration consists of key-value pairs with the output image path\nas a key pointing to the yuml input file.  If you specify more source\nfiles by wildcards, the destination should be a directory; the source file\nextension wil lbe replaced by the output format in the output file name.\n\nThen, load the plugin:\n\n```javascript\ngrunt.loadNpmTasks('grunt-wuml');\n```\n\n## Build\n\nCall the `wuml` task:\n\n```shell\n$ grunt wuml\n```\n\nor integrate it to your build sequence in `Gruntfile.js`:\n\n```js\ngrunt.registerTask('default', ['wuml', ...]);\n```\n\n## Customizing\n\nDefault behaviour of the task can be tweaked by the task options; these\nare the defaults:\n\n```js\ngrunt.initConfig({\n  wuml: {\n    one: {\n      files: {\n        'dist/doc/images/diagram.png': ['doc/images/diagram.yuml']\n      },\n      options: {\n        waggly: false,\n        type: 'class',     // class|sequence|usecase\n        orientation: 'TD', // LR|TD\n        splines: 'ortho',  // ortho|spline\n        format: 'png',     // jpg|png|svg\n        fontFamily: 'Purisa',\n        fontSize: 10\n      }\n    }\n  }\n});\n```\nSee the [documentation of the command-line wuml tool](https://github.com/schoeffm/waggly-uml#cli-tool)\nfor more information.\n\n## Contributing\n\nIn lieu of a formal styleguide, take care to maintain the existing coding\nstyle.  Add unit tests for any new or changed functionality. Lint and test\nyour code using Grunt.\n\n## Release History\n\n * 2018-04-27   v1.0.0   Dropped support of Node.js 4\n * 2017-02-23   v0.2.1   Update dependencies\n * 2016-26-08   v0.2.0   Upgrade to Grunt 1.x\n                         Detect output format from file extension\n * 2016-03-05   v0.1.1   Update dependencies, improve build testing\n * 2016-01-09   v0.1.0   Initial release\n\n## License\n\nCopyright (c) 2016-2019 Ferdinand Prantl\n\nLicensed under the MIT license.\n\n[node]: http://nodejs.org\n[npm]: http://npmjs.org\n[package.json]: https://docs.npmjs.com/files/package.json\n[Grunt]: https://gruntjs.com\n[Gruntfile]: http://gruntjs.com/sample-gruntfile\n[Getting Gtarted]: https://github.com/gruntjs/grunt/wiki/Getting-started\n[wuml]: https://github.com/schoeffm/waggly-uml\n[yuml]: http://yuml.me/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-wuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprantlf%2Fgrunt-wuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-wuml/lists"}