@miragon/wardley-dsl 0.0.0 → 0.2.0

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.
Files changed (2) hide show
  1. package/README.md +31 -0
  2. package/package.json +13 -3
package/README.md ADDED
@@ -0,0 +1,31 @@
1
+ # @miragon/wardley-dsl
2
+
3
+ [![npm](https://img.shields.io/npm/v/@miragon/wardley-dsl)](https://www.npmjs.com/package/@miragon/wardley-dsl)
4
+ [![License: MIT](https://img.shields.io/github/license/Miragon/wardley-maps-modeler)](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
package/package.json CHANGED
@@ -1,8 +1,15 @@
1
1
  {
2
2
  "name": "@miragon/wardley-dsl",
3
- "version": "0.0.0",
4
- "description": "DOM-free bridge: Online-Wardley-Maps text DSL <-> WardleyMap model and JSON bridge.",
3
+ "version": "0.2.0",
4
+ "description": "Convert between the Online Wardley Maps text format and the Wardley map model, with lossless round-trips.",
5
5
  "license": "MIT",
6
+ "repository": {
7
+ "type": "git",
8
+ "url": "git+https://github.com/Miragon/wardley-maps-modeler.git",
9
+ "directory": "packages/dsl"
10
+ },
11
+ "homepage": "https://github.com/Miragon/wardley-maps-modeler/tree/main/packages/dsl#readme",
12
+ "bugs": "https://github.com/Miragon/wardley-maps-modeler/issues",
6
13
  "type": "module",
7
14
  "sideEffects": false,
8
15
  "exports": {
@@ -18,12 +25,15 @@
18
25
  "files": [
19
26
  "dist"
20
27
  ],
28
+ "publishConfig": {
29
+ "access": "public"
30
+ },
21
31
  "scripts": {
22
32
  "build": "tsup",
23
33
  "test": "vitest run"
24
34
  },
25
35
  "dependencies": {
26
- "@miragon/wardley-schema-model": "0.0.0"
36
+ "@miragon/wardley-schema-model": "0.2.0"
27
37
  },
28
38
  "devDependencies": {
29
39
  "tsup": "8.5.1",