{"id":15010626,"url":"https://github.com/vbauer/lein-plantuml","last_synced_at":"2025-04-09T18:33:51.111Z","repository":{"id":16882577,"uuid":"19643134","full_name":"vbauer/lein-plantuml","owner":"vbauer","description":"A Leiningen plugin for generating UML diagrams using PlantUML","archived":false,"fork":false,"pushed_at":"2021-08-01T10:30:48.000Z","size":525,"stargazers_count":44,"open_issues_count":2,"forks_count":7,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-21T14:08:24.294Z","etag":null,"topics":["clj","clojure","lein","leiningen","plantuml","plantuml-generator","uml","uml-diagram"],"latest_commit_sha":null,"homepage":"","language":"Clojure","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"BlackrockDigital/startbootstrap-sb-admin-2","license":"epl-1.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vbauer.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":"2014-05-10T14:20:45.000Z","updated_at":"2024-05-31T07:54:52.000Z","dependencies_parsed_at":"2022-08-04T20:00:19.727Z","dependency_job_id":null,"html_url":"https://github.com/vbauer/lein-plantuml","commit_stats":null,"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-plantuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-plantuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-plantuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vbauer%2Flein-plantuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vbauer","download_url":"https://codeload.github.com/vbauer/lein-plantuml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248088185,"owners_count":21045662,"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":["clj","clojure","lein","leiningen","plantuml","plantuml-generator","uml","uml-diagram"],"created_at":"2024-09-24T19:35:08.170Z","updated_at":"2025-04-09T18:33:51.093Z","avatar_url":"https://github.com/vbauer.png","language":"Clojure","funding_links":[],"categories":[],"sub_categories":[],"readme":"lein-plantuml\n=============\n\n[PlantUML](http://plantuml.sourceforge.net) is an open-source tool that uses simple textual descriptions to draw UML diagrams. Diagrams are defined using a simple and intuitive language.\n\n[lein-plantuml](https://github.com/vbauer/lein-plantuml) is a Leiningen plugin for generating UML diagrams using PlantUML.\n\n[![Build Status](https://travis-ci.org/vbauer/lein-plantuml.svg?branch=master)](https://travis-ci.org/vbauer/lein-plantuml)\n[![Clojars Project](https://img.shields.io/clojars/v/lein-plantuml.svg)](https://clojars.org/lein-plantuml)\n\n\nPre-requirements\n================\n\nInstall [Graphviz](http://www.graphviz.org) to use lein-plantuml plugin. PlantUML should be working with any version of GraphViz, starting with 2.26.3\n\n* [Mac OS X](http://www.graphviz.org/Download_macos.php):\n```bash\nbrew install graphviz\n```\n* [Ubuntu](http://www.graphviz.org/Download_linux_ubuntu.php):\n```bash\nsudo apt-get install graphviz\n```\n* [Fedora](http://www.graphviz.org/Download_linux_fedora.php):\n```bash\nyum list available 'graphviz*'\nyum install 'graphviz*'\n```\n* [RHEL or CentOS](http://www.graphviz.org/Download_linux_rhel.php)\n* [Solaris](http://www.graphviz.org/Download_solaris.php)\n* [Windows](http://www.graphviz.org/Download_windows.php)\n\n\nInstallation\n============\n\nTo enable lein-plantuml for your project, put the following in the :plugins vector of your project.clj file:\n\n```clojure\n; Use latest version instead of \"X.X.X\"\n:plugins [[lein-plantuml \"X.X.X\"]]\n```\n\n\nConfiguration\n=============\n\nTo configure PlantUML generator, you need to setup :plantuml option as a list of triplets:\n\"glob pattern\" [\"file format\"] [\"output directory\"]\n\nDescription:\n- *Glob pattern* is based on wildcard characters, see [Glob](http://en.wikipedia.org/wiki/Glob_(programming)) for additional information.\n- *Files format* is an image file format for output data (optional parameter, default value is :png). You could use both variants (keywords and text values) to configure file format.\n- *Output directory* is an optional parameter, files will be generated in the same directory by default.\n\nFile formats:\n- :png - Portable Network Graphics format\n- :svg - Scalable Vector Graphics format\n- :txt, :utxt - Text file format\n- :eps, :eps:txt - Encapsulated PostScript format\n- :pdf - Portable Document Format\n\n\u003c!---\n- :html, :html5 - HTML documents\n- :mjpeg - MJPEG format\n--\u003e\n\nExample configuration:\n\n```clojure\n  :plantuml [[\"resources/*.puml\" :png \"target\"]\n             [\"presentation/*.txt\" \"svg\"]]\n```\n\n\nUsage\n=====\n\nTo generate UML image files using configuration from project.clj, you should use:\n\n```bash\nlein plantuml\n```\n\nTo enable this plugin at compile stage, use the following hook:\n```clojure\n:hooks [lein-plantuml.plugin]\n```\n\nTo run PlantUML generator using command line interface without configuration in project.clj file, you need to use following command:\n```bash\nlein plantuml \u003csource folder\u003e [\u003cfile format\u003e] [\u003coutput folder\u003e]\n```\nBy default, generator will use PNG output format and input directory for output files.\n\nTo show help for CLI:\n```bash\n lein help plantuml\n```\n\n\nExamples\n========\n\nDetailed example\n----------------\n\nTo test the plugin, you can create a simple file and run lein-plantuml:\n```\n@startuml\n\nUser -\u003e (Start)\nUser --\u003e (Use the application) : A small label\n\n:Main Admin: ---\u003e (Use the application) : This is\\nyet another\\nlabel\n\n@enduml\n```\nOutput UML diagram should look like this:\n\n![uml-example](http://plantuml.sourceforge.net/imgp/usecase_003.png)\n\n\nExample project\n---------------\n\nJust clone current repository and try to play with [example project](https://github.com/vbauer/lein-plantuml/tree/master/example) for better understanding how to use lein-planuml.\n\n\nUseful links\n------------\n\nMore examples could be found here:\n- [Sequence Diagram](http://plantuml.sourceforge.net/sequence.html)\n- [Use Case Diagram](http://plantuml.sourceforge.net/usecase.html)\n- [Class Diagram](http://plantuml.sourceforge.net/classes.html)\n- [Activity Diagram](http://plantuml.sourceforge.net/activity.html) + [(more)](http://plantuml.sourceforge.net/activity2.html)\n- [Component Diagram](http://plantuml.sourceforge.net/component.html)\n- [State Diagram](http://plantuml.sourceforge.net/state.html)\n- [Object Diagram](http://plantuml.sourceforge.net/objects.html)\n\n\nUnit testing\n============\n\nTo run unit tests:\n\n```bash\nlein test\n```\n\n\nThanks to\n=========\nPlantUML developers for the really great project and adding lein-planuml on the [official site](http://plantuml.sourceforge.net/running.html).\n\n\nMight also like\n===============\n\n* [lein-asciidoctor](https://github.com/asciidoctor/asciidoctor-lein-plugin) - a Leiningen plugin for generating documentation using Asciidoctor.\n* [lein-jshint](https://github.com/vbauer/lein-jshint) - a Leiningen plugin for running javascript code through JSHint.\n* [lein-jslint](https://github.com/vbauer/lein-jslint) - a Leiningen plugin for running javascript code through JSLint.\n* [lein-coffeescript](https://github.com/vbauer/lein-coffeescript) - a Leiningen plugin for running CoffeeScript compiler.\n* [lein-typescript](https://github.com/vbauer/lein-typescript) - a Leiningen plugin for running TypeScript compiler.\n* [jabberjay](https://github.com/vbauer/jabberjay) - a simple framework for creating Jabber bots.\n* [coderwall-clj](https://github.com/vbauer/coderwall-clj) - a tiny CoderWall client for Clojure.\n\nLicense\n=======\n\nCopyright © 2014 Vladislav Bauer\n\nDistributed under the Eclipse Public License, the same as Clojure.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbauer%2Flein-plantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvbauer%2Flein-plantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvbauer%2Flein-plantuml/lists"}