proschi 0.9.0 → 0.11.0

package/grammar/proschi.tmLanguage.json

@@ -12,6 +12,9 @@
     {
       "include": "#section"
     },
+    {
+      "include": "#legend"
+    },
     {
       "include": "#decision-line"
     },
@@ -24,12 +27,18 @@
     {
       "include": "#import"
     },
+    {
+      "include": "#layout-hint"
+    },
     {
       "include": "#keyword"
     },
     {
       "include": "#node-id"
     },
+    {
+      "include": "#style"
+    },
     {
       "include": "#string"
     },
@@ -103,6 +112,24 @@
         }
       }
     },
+    "layout-hint": {
+      "comment": "`direction down|right|up|left` (top level or in a group) and `layout ordered`: layout hints, each a statement of its own. Otherwise the words are node ids.",
+      "match": "^\\s*(?:(direction)\\s+(down|right|up|left)|(layout)\\s+(ordered))(?=\\s*(?:#|$))",
+      "captures": {
+        "1": {
+          "name": "keyword.control.proschi"
+        },
+        "2": {
+          "name": "constant.language.direction.proschi"
+        },
+        "3": {
+          "name": "keyword.control.proschi"
+        },
+        "4": {
+          "name": "constant.language.layout.proschi"
+        }
+      }
+    },
     "keyword": {
       "comment": "Statement keywords start a line, or follow } as in `} alt \"Next\" {`.",
       "match": "^\\s*(?:(\\})\\s*)?(title|group|usecase|par|alt)\\b",
@@ -402,6 +429,92 @@
       "comment": "A number with an optional fraction, magnitude and unit, attached or one space away: 120, 2.5, 50ms, 100k rps, 99.9%, 4xx, 500 MB/s, 0.05 usd/GB.",
       "name": "constant.numeric.proschi",
       "match": "\\b\\d+(?:\\.\\d+)?(?:[A-Za-z]+(?:/[A-Za-z]+)?|%)?(?: (?:rps|rpm|rpd|ms|s|usd/month|usd/GB|MB/s|GB/s)\\b| %)?"
+    },
+    "style": {
+      "comment": "`color <name>|#hex`, `critical`, `rank N|first|last` and `.tag` on nodes, groups and connections. Right after `color` a # is a hex color, not a comment.",
+      "patterns": [
+        {
+          "include": "#color"
+        },
+        {
+          "name": "keyword.other.critical.proschi",
+          "match": "(?<=\\s)critical(?![A-Za-z0-9_])"
+        },
+        {
+          "match": "(?<=\\s)(rank)\\s+(\\d+|first|last)(?![A-Za-z0-9_])",
+          "captures": {
+            "1": {
+              "name": "keyword.other.rank.proschi"
+            },
+            "2": {
+              "name": "constant.numeric.rank.proschi"
+            }
+          }
+        },
+        {
+          "include": "#tag"
+        }
+      ]
+    },
+    "color": {
+      "match": "\\b(color)\\s+(#(?:[0-9a-fA-F]{6}|[0-9a-fA-F]{3})(?![A-Za-z0-9_])|[A-Za-z_][A-Za-z0-9_]*)",
+      "captures": {
+        "1": {
+          "name": "keyword.other.color.proschi"
+        },
+        "2": {
+          "name": "constant.other.color.proschi"
+        }
+      }
+    },
+    "tag": {
+      "name": "entity.other.attribute-name.tag.proschi",
+      "match": "(?<![A-Za-z0-9_])\\.[A-Za-z_][A-Za-z0-9_]*"
+    },
+    "legend": {
+      "comment": "The legend block: one style per line, `id \"Label\" <color> [dashed|dotted]`.",
+      "name": "meta.block.legend.proschi",
+      "begin": "^\\s*(legend)(?=\\s*\\{\\s*(?:#.*)?$)",
+      "end": "^\\s*(\\})",
+      "beginCaptures": {
+        "1": {
+          "name": "keyword.control.proschi"
+        }
+      },
+      "endCaptures": {
+        "1": {
+          "name": "punctuation.section.block.end.proschi"
+        }
+      },
+      "patterns": [
+        {
+          "include": "#color"
+        },
+        {
+          "include": "#comment"
+        },
+        {
+          "include": "#string"
+        },
+        {
+          "include": "#node-id"
+        },
+        {
+          "name": "constant.other.color.proschi",
+          "match": "\\b(?:gray|blue|teal|green|yellow|orange|red|purple|pink)\\b"
+        },
+        {
+          "name": "keyword.other.proschi",
+          "match": "\\b(?:dashed|dotted)\\b"
+        },
+        {
+          "name": "punctuation.section.block.begin.proschi",
+          "match": "\\{"
+        },
+        {
+          "include": "#identifier"
+        }
+      ]
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "proschi",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "Command-line checker and language server for Proschi architecture diagrams",
   "license": "MIT",
   "repository": {

package/schema/proschi-diagram.schema.json

@@ -45,7 +45,8 @@
             "capacity",
             "entity",
             "decision",
-            "test"
+            "test",
+            "legend"
           ]
         },
         "start": {
@@ -222,6 +223,34 @@
             "$ref": "#/$defs/test"
           },
           "description": "`test` blocks of flow assertions."
+        },
+        "legend": {
+          "type": "array",
+          "items": {
+            "$ref": "#/$defs/legendEntry"
+          },
+          "description": "Entries of the `legend` block, in order."
+        },
+        "layout": {
+          "type": "object",
+          "description": "Top-level layout hints; left out when the document uses none.",
+          "properties": {
+            "direction": {
+              "enum": [
+                "down",
+                "right",
+                "up",
+                "left"
+              ],
+              "description": "`direction right`: where edges flow in the whole diagram."
+            },
+            "ordered": {
+              "type": "boolean",
+              "description": "`layout ordered`: edges follow declaration order."
+            }
+          },
+          "required": [],
+          "additionalProperties": false
         }
       },
       "required": [
@@ -254,6 +283,7 @@
             "database",
             "cache",
             "queue",
+            "broker",
             "storage",
             "cdn",
             "serverless",
@@ -283,6 +313,7 @@
             "NoSQL Database",
             "Cache",
             "Message Queue",
+            "Message Broker",
             "Object Storage",
             "CDN",
             "Load Balancer",
@@ -497,6 +528,7 @@
             "search",
             "analytics",
             "queue",
+            "broker",
             "storage",
             "external",
             "other"
@@ -539,6 +571,45 @@
           "minimum": 1,
           "description": "`x3`: number of replicas; absent means 1."
         },
+        "color": {
+          "type": "string",
+          "description": "`color teal` or `color #3b82f6`, as written."
+        },
+        "tag": {
+          "type": "string",
+          "description": "`.owned`: the legend entry the node or group is styled by."
+        },
+        "critical": {
+          "type": "boolean",
+          "description": "`critical`: drawn with a warning badge."
+        },
+        "rank": {
+          "oneOf": [
+            {
+              "type": "integer",
+              "minimum": 0
+            },
+            {
+              "enum": [
+                "first",
+                "last"
+              ]
+            }
+          ],
+          "description": "`rank 2`, `rank first`, `rank last`: the layout layer among the nodes and groups that share its parent."
+        },
+        "direction": {
+          "enum": [
+            "down",
+            "right",
+            "up",
+            "left"
+          ],
+          "description": "`direction right` inside a group: where edges flow among its members."
+        },
+        "style": {
+          "$ref": "#/$defs/style"
+        },
         "loc": {
           "$ref": "#/$defs/loc"
         }
@@ -553,6 +624,58 @@
       ],
       "additionalProperties": false
     },
+    "style": {
+      "type": "object",
+      "description": "Resolved fill and border (or stroke) from `color` and the tag; an explicit color wins.",
+      "properties": {
+        "color": {
+          "type": "string",
+          "description": "Base color as #rrggbb."
+        },
+        "dash": {
+          "enum": [
+            "dashed",
+            "dotted"
+          ]
+        }
+      },
+      "required": [],
+      "additionalProperties": false
+    },
+    "legendEntry": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "label": {
+          "type": "string"
+        },
+        "colorName": {
+          "type": "string",
+          "description": "The color as written: a palette name or #hex."
+        },
+        "color": {
+          "type": "string",
+          "description": "Base color as #rrggbb."
+        },
+        "dash": {
+          "enum": [
+            "dashed",
+            "dotted"
+          ]
+        },
+        "loc": {
+          "$ref": "#/$defs/loc"
+        }
+      },
+      "required": [
+        "id",
+        "label",
+        "loc"
+      ],
+      "additionalProperties": false
+    },
     "edge": {
       "type": "object",
       "properties": {
@@ -568,6 +691,13 @@
         "label": {
           "type": "string"
         },
+        "tag": {
+          "type": "string",
+          "description": "`a -> b .planned`: the legend entry the edge is styled by."
+        },
+        "style": {
+          "$ref": "#/$defs/style"
+        },
         "loc": {
           "$ref": "#/$defs/loc"
         }
@@ -840,6 +970,7 @@
                 "search",
                 "analytics",
                 "queue",
+                "broker",
                 "storage",
                 "external",
                 "other"