@miragon/wardley-dsl 0.0.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +31 -0
- package/dist/index.cjs +554 -111
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +16 -1
- package/dist/index.d.ts +16 -1
- package/dist/index.js +554 -112
- package/dist/index.js.map +1 -1
- package/package.json +13 -3
package/README.md
ADDED
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
# @miragon/wardley-dsl
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@miragon/wardley-dsl)
|
|
4
|
+
[](https://github.com/Miragon/wardley-maps-modeler/blob/main/LICENSE)
|
|
5
|
+
|
|
6
|
+
DOM-free bridge between the [Online-Wardley-Maps](https://docs.onlinewardleymaps.com/) text DSL and
|
|
7
|
+
the `WardleyMap` model — a lossless round-trip.
|
|
8
|
+
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
npm install @miragon/wardley-dsl
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { parseDSL, serializeDSL } from '@miragon/wardley-dsl';
|
|
19
|
+
|
|
20
|
+
const map = parseDSL(`title Tea Shop
|
|
21
|
+
component Kettle [0.43, 0.35]
|
|
22
|
+
evolve Kettle 0.62`);
|
|
23
|
+
|
|
24
|
+
const text = serializeDSL(map); // back to OWM text, losslessly
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Part of the [Wardley Maps](https://github.com/Miragon/wardley-maps-modeler) monorepo.
|
|
28
|
+
|
|
29
|
+
## License
|
|
30
|
+
|
|
31
|
+
MIT
|