Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vbauer/lein-plantuml
A Leiningen plugin for generating UML diagrams using PlantUML
https://github.com/vbauer/lein-plantuml
clj clojure lein leiningen plantuml plantuml-generator uml uml-diagram
Last synced: 4 months ago
JSON representation
A Leiningen plugin for generating UML diagrams using PlantUML
- Host: GitHub
- URL: https://github.com/vbauer/lein-plantuml
- Owner: vbauer
- License: epl-1.0
- Created: 2014-05-10T14:20:45.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2021-08-01T10:30:48.000Z (over 3 years ago)
- Last Synced: 2024-09-28T17:40:53.288Z (4 months ago)
- Topics: clj, clojure, lein, leiningen, plantuml, plantuml-generator, uml, uml-diagram
- Language: Clojure
- Homepage:
- Size: 513 KB
- Stars: 44
- Watchers: 1
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
lein-plantuml
=============
[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.
[lein-plantuml](https://github.com/vbauer/lein-plantuml) is a Leiningen plugin for generating UML diagrams using PlantUML.
[](https://travis-ci.org/vbauer/lein-plantuml)
[](https://clojars.org/lein-plantuml)
Pre-requirements
================
Install [Graphviz](http://www.graphviz.org) to use lein-plantuml plugin. PlantUML should be working with any version of GraphViz, starting with 2.26.3
* [Mac OS X](http://www.graphviz.org/Download_macos.php):
```bash
brew install graphviz
```
* [Ubuntu](http://www.graphviz.org/Download_linux_ubuntu.php):
```bash
sudo apt-get install graphviz
```
* [Fedora](http://www.graphviz.org/Download_linux_fedora.php):
```bash
yum list available 'graphviz*'
yum install 'graphviz*'
```
* [RHEL or CentOS](http://www.graphviz.org/Download_linux_rhel.php)
* [Solaris](http://www.graphviz.org/Download_solaris.php)
* [Windows](http://www.graphviz.org/Download_windows.php)
Installation
============
To enable lein-plantuml for your project, put the following in the :plugins vector of your project.clj file:
```clojure
; Use latest version instead of "X.X.X"
:plugins [[lein-plantuml "X.X.X"]]
```
Configuration
=============
To configure PlantUML generator, you need to setup :plantuml option as a list of triplets:
"glob pattern" ["file format"] ["output directory"]
Description:
- *Glob pattern* is based on wildcard characters, see [Glob](http://en.wikipedia.org/wiki/Glob_(programming)) for additional information.
- *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.
- *Output directory* is an optional parameter, files will be generated in the same directory by default.
File formats:
- :png - Portable Network Graphics format
- :svg - Scalable Vector Graphics format
- :txt, :utxt - Text file format
- :eps, :eps:txt - Encapsulated PostScript format
- :pdf - Portable Document Format
Example configuration:
```clojure
:plantuml [["resources/*.puml" :png "target"]
["presentation/*.txt" "svg"]]
```
Usage
=====
To generate UML image files using configuration from project.clj, you should use:
```bash
lein plantuml
```
To enable this plugin at compile stage, use the following hook:
```clojure
:hooks [lein-plantuml.plugin]
```
To run PlantUML generator using command line interface without configuration in project.clj file, you need to use following command:
```bash
lein plantuml [] []
```
By default, generator will use PNG output format and input directory for output files.
To show help for CLI:
```bash
lein help plantuml
```
Examples
========
Detailed example
----------------
To test the plugin, you can create a simple file and run lein-plantuml:
```
@startuml
User -> (Start)
User --> (Use the application) : A small label
:Main Admin: ---> (Use the application) : This is\nyet another\nlabel
@enduml
```
Output UML diagram should look like this:
Example project
---------------
Just 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.
Useful links
------------
More examples could be found here:
- [Sequence Diagram](http://plantuml.sourceforge.net/sequence.html)
- [Use Case Diagram](http://plantuml.sourceforge.net/usecase.html)
- [Class Diagram](http://plantuml.sourceforge.net/classes.html)
- [Activity Diagram](http://plantuml.sourceforge.net/activity.html) + [(more)](http://plantuml.sourceforge.net/activity2.html)
- [Component Diagram](http://plantuml.sourceforge.net/component.html)
- [State Diagram](http://plantuml.sourceforge.net/state.html)
- [Object Diagram](http://plantuml.sourceforge.net/objects.html)
Unit testing
============
To run unit tests:
```bash
lein test
```
Thanks to
=========
PlantUML developers for the really great project and adding lein-planuml on the [official site](http://plantuml.sourceforge.net/running.html).
Might also like
===============
* [lein-asciidoctor](https://github.com/asciidoctor/asciidoctor-lein-plugin) - a Leiningen plugin for generating documentation using Asciidoctor.
* [lein-jshint](https://github.com/vbauer/lein-jshint) - a Leiningen plugin for running javascript code through JSHint.
* [lein-jslint](https://github.com/vbauer/lein-jslint) - a Leiningen plugin for running javascript code through JSLint.
* [lein-coffeescript](https://github.com/vbauer/lein-coffeescript) - a Leiningen plugin for running CoffeeScript compiler.
* [lein-typescript](https://github.com/vbauer/lein-typescript) - a Leiningen plugin for running TypeScript compiler.
* [jabberjay](https://github.com/vbauer/jabberjay) - a simple framework for creating Jabber bots.
* [coderwall-clj](https://github.com/vbauer/coderwall-clj) - a tiny CoderWall client for Clojure.
License
=======
Copyright © 2014 Vladislav Bauer
Distributed under the Eclipse Public License, the same as Clojure.