haar/README.md

Cli tool for building and displaying plant-uml diagrams

# Haar

Haar is a command line tool to help you write diagrams with plant uml and then surface and expose those diagrams to the people on your team.

> In meteorology, haar is a cold sea fog. It usually occurs on the east coast of England or Scotland between April and September, when warm air passes over the cold North Sea.

[![npm](https://img.shields.io/npm/v/haar.svg)](https://www.npmjs.com/package/haar)
[![npm](https://img.shields.io/npm/dm/haar.svg)](https://www.npmjs.com/package/haar)

### Setup
For the best experience of developing diagrams using Haar in Linux
#### Linux (Debian-likes)
Install Haar:
```
npm i -g haar
```
Install [Graphviz](http://www.graphviz.org/) to be able to generate all diagram types.
```
sudo apt-get remove libpathplan4
sudo apt-get install graphviz
```

Install [Plant-UML Viewer](https://atom.io/packages/plantuml-viewer) (Atom package)
```
apm install plantuml-viewer
```

### Instructions

```
Usage:  [options] [command]

 Commands:

   init    Initialise a new haar project
   add     Add a new diagram to an existing project or create a new project
   build   Build diagrams in project directories listed in .haar.yml
   serve   Run a local webserver to serve the diagrams

 Options:

   -h, --help     output usage information
   -V, --version  output the version number
```

### To do

- [x] Init
  - [x] Create folder structure based on a template folder
  - [x] Create a yaml file with some defaults at the root of repo

- [x] Build
  - [x] Iterate and find all puml files based on yaml config
  - [x] Run puml files through the module for building them
  - [x] Build high level readme's with descriptions and images for github viewing
  - [x] Option for SVG or PNG or both
  - [x] Delete orphaned files
  - [x] Create 'add' command to add new diagrams to projects without manual editing of the `.haar.yml` file

- [ ] Pre-Flight-Check
  - [ ] Check for locally installed dependencies (graphviz, java) and give good error messages

- [x] Serve
  - [x] Simple site under Express to serve a presentation of the stuff
  - [x] Navigation for folders of diagrams
  - [x] Fix bug with views directory when installing globally
  - [x] Directories metadata (i.e display name, display in web)

- [x] CI
  - [x] Dockerfile
  - [x] Usher to run tests under docker
  - [x] Usher to publish NPM module under docker