# puml-to-png

> Small script to convert puml to png in same folder.

Latest version **0.0.3** (published 2022-12-22) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install puml-to-png
pnpm add puml-to-png
yarn add puml-to-png
bun add puml-to-png
```

Provides the command `puml-to-png`.

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2022-12-22 |
| First published | 2021-07-28 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | jessebluemr |

## Links

- npm: https://www.npmjs.com/package/puml-to-png
- npm.io page: https://npm.io/package/puml-to-png

## Dependencies (2)

- [fast-glob](https://npm.io/package/fast-glob.md) 3.2.5
- [plantuml-encoder](https://npm.io/package/plantuml-encoder.md) 1.4.0

## Recent versions

- 0.0.3 (latest) — 2022-12-22
- 0.0.2 — 2021-07-28
- 0.0.1 — 2021-07-28

## README

# pumlToPng

Small script to convert puml to png in same folder.

All `.puml` files inside the working directory and all sub folders are converted into `.png` files, by requesting a plantuml server.

By default the <http://www.plantuml.com/plantuml> is requested for conversion.

## Usage

Install as global tool with:

```sh
npm install -g puml-to-png
```

Now in any folder with ".puml" files execute:

```sh
puml-to-png
```

Or if you have a custom plantuml server running:

```sh
puml-to-png --url http://mylocalplantumlserver
```

## Integration in Build Tools

You an use something like:

```js
const { transform } = require("puml-to-png/transform");

const server = "http://mylocalplantumlserver";
const directory = "/path/to/plantumlfiles";

transform(server, directory);
```

To integrate the transformation into your build process.

## License

Licensed as [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0)

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