# suml

> Parser and dumper of SUML: Simple & Unambiguous Markup Language

Latest version **0.2.3** (published 2024-08-21) · LicenseRef-OQL-1.0 license · 0 weekly downloads

## Install

```sh
npm install suml
pnpm add suml
yarn add suml
bun add suml
```

## 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.2.3 |
| Published | 2024-08-21 |
| First published | 2020-04-08 |
| Weekly downloads | 0 |
| License | LicenseRef-OQL-1.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 36.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andrea Vos |
| Maintainers | avris |
| Keywords | suml, markup, parser, dumper, yaml |

## Links

- npm: https://www.npmjs.com/package/suml
- Repository: https://gitlab.com/Avris/SUML-JS
- Homepage: https://avris.it
- Issues: https://gitlab.com/Avris/SUML-JS/issues
- npm.io page: https://npm.io/package/suml

## Alternatives

- [monaco-yaml](https://npm.io/package/monaco-yaml.md) — 420.1K weekly downloads
- [@crewx/workflow](https://npm.io/package/@crewx/workflow.md) — 3.1K weekly downloads
- [yaml-cat](https://npm.io/package/yaml-cat.md) — 38 weekly downloads
- [nunjucks-in-yaml](https://npm.io/package/nunjucks-in-yaml.md) — 9 weekly downloads
- [shopify-symlinks](https://npm.io/package/shopify-symlinks.md) — 3 weekly downloads

## Recent versions

- 0.2.3 (latest) — 2024-08-21
- 0.2.2 — 2023-05-10
- 0.2.1 — 2020-04-08
- 0.2.0 — 2020-04-08
- 0.1.1 — 2020-04-08
- 0.1.0 — 2020-04-08

## README

# SUML for JavaScript

![SUML logo](logo.png)

This is a JavaScript implementation of a parser and a dumper of SUML: Simple & Unambiguous Markup Language.
You can check out its specification at [gitlab.com/Avris/SUML](https://gitlab.com/Avris/SUML)

## Installation

    yarn add suml

## Usage

    import Suml from 'suml';
    
    const suml = new Suml();
    
    const parsed = suml.parse("'input'");
    const dump = suml.dump({foo: 'bar', lorem: true})

## Development

    make install
    make test

## Webpack loader

See: [gitlab.com/Avris/SUML-Loader](https://gitlab.com/Avris/SUML-Loader)

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