{"id":22423319,"url":"https://github.com/prantlf/grunt-nomnoml","last_synced_at":"2025-08-01T07:32:11.320Z","repository":{"id":36100866,"uuid":"40402104","full_name":"prantlf/grunt-nomnoml","owner":"prantlf","description":"Grunt task to generate images from nomnoml diagram sources","archived":false,"fork":false,"pushed_at":"2022-01-30T15:13:39.000Z","size":206,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-11-17T09:47:46.950Z","etag":null,"topics":["diagram-sources","grunt-task","nomnoml","uml"],"latest_commit_sha":null,"homepage":"","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":"CHANGELOG.md","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":"2015-08-08T12:24:56.000Z","updated_at":"2022-01-30T14:55:32.000Z","dependencies_parsed_at":"2022-08-31T08:31:42.568Z","dependency_job_id":null,"html_url":"https://github.com/prantlf/grunt-nomnoml","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-nomnoml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-nomnoml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-nomnoml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/prantlf%2Fgrunt-nomnoml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/prantlf","download_url":"https://codeload.github.com/prantlf/grunt-nomnoml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228348371,"owners_count":17905899,"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","nomnoml","uml"],"created_at":"2024-12-05T18:09:59.160Z","updated_at":"2024-12-05T18:09:59.803Z","avatar_url":"https://github.com/prantlf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# grunt-nomnoml\n\n[![Latest version](https://img.shields.io/npm/v/grunt-nomnoml)\n ![Dependency status](https://img.shields.io/librariesio/release/npm/grunt-nomnoml)\n](https://www.npmjs.com/package/grunt-nomnoml)\n[![codecov](https://codecov.io/gh/prantlf/grunt-nomnoml/branch/master/graph/badge.svg)](https://codecov.io/gh/prantlf/grunt-nomnoml)\n[![Code Climate](https://codeclimate.com/github/prantlf/grunt-nomnoml/badges/gpa.svg)](https://codeclimate.com/github/prantlf/grunt-nomnoml)\n\nThis module provides a grunt multi-task generating images from [nomnoml]\ndiagram sources.\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 nomnoml source file to a picture, you\ncan use the [nomnoml-cli] command-line tool, which this task is based on.\n\n## Installation\n\nYou need [node \u003e= 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/Automattic/node-canvas/wiki/_pages)\n   of the [node-canvas](https://github.com/Automattic/node-canvas) module depending\n   on your operating system\n\n2. Install the Grunt task:\n\n```shell\n$ npm install grunt-nomnoml --save-dev\n```\n\n## Configuration\n\nAdd the `nomnoml` entry with the nomnoml task configuration to the\noptions of the `grunt.initConfig` method:\n\n```js\ngrunt.initConfig({\n  nomnoml: {\n    one: {\n      files: {\n        'dist/doc/images/diagram.png': ['doc/images/diagram.nomnoml']\n      }\n    },\n    all: {\n      options: { format: 'svg' },\n      src: ['doc/images/*.nomnoml']\n      dest: 'dist/doc/images'\n    }\n  }\n});\n```\n\nThe configuration consists of key-value pairs with the output image path\nas a key pointing to the nomnoml input file.  If you specify more source\nfiles by wildcards, the destination should be a directory; the source file\nextension will be replaced by \"png\" or other one depending on the format\nin the output file name.\n\nThe `options` can contain one or more options supported by the [nomnoml-cli API].\nFor example, `format` can be `png` (default), `jpg`, `svg` or `pdf`.\n\nThen, load the plugin:\n\n```javascript\ngrunt.loadNpmTasks('grunt-nomnoml');\n```\n\n## Build\n\nCall the `nomnoml` task:\n\n```shell\n$ grunt nomnoml\n```\n\nor integrate it to your build sequence in `Gruntfile.js`:\n\n```js\ngrunt.registerTask('default', ['nomnoml', ...]);\n```\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## License\n\nCopyright (c) 2015-2022 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[nomnoml]: http://www.nomnoml.com/\n[nomnoml-cli]: https://github.com/prantlf/nomnoml-cli\n[nomnoml-cli API]: https://github.com/prantlf/nomnoml-cli#programmatic-usage\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-nomnoml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprantlf%2Fgrunt-nomnoml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprantlf%2Fgrunt-nomnoml/lists"}