# nomnoml-watch

> Automatically watch and compile nomnoml files.

Latest version **1.5.1** (published 2020-04-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install nomnoml-watch
pnpm add nomnoml-watch
yarn add nomnoml-watch
bun add nomnoml-watch
```

Provides the command `nomnoml-watch`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.1 |
| Published | 2020-04-30 |
| First published | 2020-04-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 29.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Semmu |
| Maintainers | semmu |

## Links

- npm: https://www.npmjs.com/package/nomnoml-watch
- Repository: https://github.com/Semmu/nomnoml-watch
- Homepage: https://github.com/Semmu/nomnoml-watch#readme
- Issues: https://github.com/Semmu/nomnoml-watch/issues
- npm.io page: https://npm.io/package/nomnoml-watch

## Dependencies (5)

- [glob](https://npm.io/package/glob.md) ^7.1.6
- [colors](https://npm.io/package/colors.md) ^1.4.0
- [nomnoml](https://npm.io/package/nomnoml.md) ^0.6.2
- [chokidar](https://npm.io/package/chokidar.md) ^3.3.1
- [commander](https://npm.io/package/commander.md) ^5.1.0

## Recent versions

- 1.5.1 (latest) — 2020-04-30
- 1.5.0 — 2020-04-30
- 1.3.0 — 2020-04-28
- 1.2.0 — 2020-04-26
- 1.1.1 — 2020-04-26
- 1.1.0 — 2020-04-26
- 1.0.1 — 2020-04-25
- 1.0.0 — 2020-04-25
- 0.0.1 — 2020-04-25

## README

# nomnoml-watch

[![published npm version](https://img.shields.io/npm/v/nomnoml-watch?style=plastic)](https://www.npmjs.com/package/nomnoml-watch)

`npx` package to watch and automatically compile [`nomnoml`](http://www.nomnoml.com/) diagram files in the current directory.

![usage flow](./flow.svg)


## Description

`nomnoml` is a really cool tool to describe (UML) diagrams in a simple text format and then generate images from them for visual representation.

* Check out the online, client-side tool here: http://www.nomnoml.com/
* It is also open-source! https://github.com/skanaar/nomnoml
* And available as an `npm` package: https://www.npmjs.com/package/nomnoml

`nomnoml-watch` is a very simple program that watches `*.nomnoml` files in the current directory and automatically compiles them to SVG images on every change.


## Quick usage

* Have some `*.nomnoml` files in your current directory.
* Run `npx nomnoml-watch`!


## Command line arguments

```
Usage: nomnoml-watch [options]

Options:
  -V, --version              output the version number
  -1, --once                 run only once and then exit (default: false)
  -d, --import-depth <type>  maximum depth allowed when importing external files (default: 20)
  -h, --help                 display help for command
```


## TODO / Planned features

- [x] add CLI argument parsing
- [x] then add `--import-depth` argument
- [x] then add `--once` flag for one-off runs
- [ ] build dependency/import graph of files
- [ ] automatically re-compile files when imported files change


## Troubleshooting

If you encounter issues, watch the command line output while `nomnoml-watch` is running.

If you have import issues, you may have reached the import depth limit, resulting in an orange "end" visual, or the imported file is not found, resulting in a red "end" visual. Check the [`tests/`](tests/) folder for some examples.

Other rendering issues should be reported to the original nomnoml project here: https://github.com/skanaar/nomnoml/issues


## License

MIT

---
_Source: https://npm.io/package/nomnoml-watch · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._