feat(editor): add initial VS Code syntax highlighting for OrgScript

Author: DKFuH

CHANGELOG.md

@@ -20,6 +20,7 @@ The format is based on Keep a Changelog, and this project follows Semantic Versi
 - Unified CLI diagnostics across `validate`, `lint`, `check`, and `format --check`.
 - Added stable diagnostic code namespaces for syntax, semantic validation, lint, format, and CLI usage errors.
 - Added `format --check --json` and documented JSON diagnostics with real examples.
+- Upgraded the VS Code OrgScript extension from a scaffold to a usable first TextMate-based syntax-highlighting integration.
 
 ## [0.3.0] - 2026-03-29
 

README.md

@@ -183,7 +183,7 @@ npm run demo:generate
 - Golden snapshot tests for AST, canonical model, and formatter output
 - Stable lint severities: `error`, `warning`, `info`
 - Canonical master spec: [`spec/language-spec.md`](spec/language-spec.md)
-- Initial VS Code syntax-highlighting scaffold: [`editors/vscode`](editors/vscode)
+- Initial VS Code syntax-highlighting extension: [`editors/vscode`](editors/vscode)
 - Generated demo artifacts for Mermaid and Markdown summaries under [`docs/demos`](docs/demos)
 
 ## Quick start
@@ -362,13 +362,15 @@ OrgScript currently produces two human-facing output types from the same source
 
 ## Editor support
 
-OrgScript now ships with a first VS Code syntax-highlighting scaffold under [`editors/vscode`](editors/vscode).
+OrgScript now ships with a first usable VS Code syntax-highlighting extension under [`editors/vscode`](editors/vscode).
 
 It currently covers:
 
 - `.orgs` file association
-- top-level blocks and core keywords
-- strings, numbers, and operators
+- top-level blocks and block names
+- core statements and section keywords
+- strings, booleans, numbers, and operators
+- dotted references such as `lead.status` and `lead.created`
 
 See [`editors/vscode/README.md`](editors/vscode/README.md) for local installation and usage notes.
 

docs/roadmaps/v0.4.0.md

@@ -22,7 +22,7 @@ Make OrgScript easier to use in daily development, CI, and editor workflows with
 - JSON diagnostics examples in the README and diagnostics spec
 - stable diagnostic code namespaces and consistent CLI finding output
 - canonical language spec and governance notes
-- initial VS Code syntax-highlighting scaffold
+- initial VS Code syntax-highlighting extension
 - Markdown summary exporter
 - Mermaid demo package with generated Markdown and `.mmd` artifacts
 

editors/vscode/README.md

@@ -1,28 +1,51 @@
-# OrgScript VS Code scaffold
+# OrgScript VS Code
 
-This folder contains a minimal VS Code language contribution for `.orgs` files.
+This folder contains a locally testable VS Code extension for `.orgs` files.
 
 ## What is included
 
-- `package.json` registers the `OrgScript` language and the `.orgs` extension
-- `syntaxes/orgscript.tmLanguage.json` provides TextMate syntax highlighting
-- `language-configuration.json` adds lightweight editor behavior for quotes and brackets
+- `package.json` registers the `OrgScript` language with language id `orgscript`
+- `syntaxes/orgscript.tmLanguage.json` provides TextMate-based syntax highlighting
+- `language-configuration.json` adds lightweight editor behavior for double-quoted strings
 
 ## What is highlighted
 
 - top-level blocks such as `process`, `stateflow`, `rule`, `role`, `policy`, `metric`, and `event`
-- core keywords such as `when`, `if`, `then`, `else`, `assign`, `transition`, `notify`, `create`, `update`, `require`, and `stop`
-- strings, numbers, and operators
-
-OrgScript does not define a comment syntax in the language spec yet, so this scaffold intentionally does not add comment highlighting.
-
-## Use locally
-
-1. Open `editors/vscode/` in VS Code.
-2. Open a `.orgs` file from the repo, or create a new one in that folder.
-3. If needed, select `OrgScript` from the language mode picker in the bottom-right corner.
-
-## Notes
-
-- This is a syntax-highlighting scaffold only.
-- It does not add CLI commands, formatting, linting, or diagnostics.
+- block names such as `LeadQualification` or `OrderLifecycle`
+- section keywords such as `states`, `transitions`, `applies to`, `can`, `cannot`, `formula`, `owner`, and `target`
+- core statements such as `when`, `if`, `else`, `then`, `assign`, `transition`, `notify`, `create`, `update`, `require`, and `stop`
+- operator forms such as `=`, `!=`, `<`, `<=`, `>`, `>=`, and `->`
+- dotted references such as `lead.status` and `lead.created`
+- strings, booleans, and numeric literals
+
+OrgScript does not define an official comment syntax in the language spec yet, so this extension intentionally does not add comment highlighting.
+
+## Local testing in VS Code
+
+1. Open the repository in VS Code.
+2. Open the `editors/vscode/` folder as the extension project if you want to inspect the extension files directly.
+3. Press `F5` in VS Code while `editors/vscode/` is the active extension workspace.
+4. In the Extension Development Host, open one of these files:
+   - `examples/craft-business-lead-to-order.orgs`
+   - `examples/order-approval.orgs`
+   - `examples/service-escalation.orgs`
+5. Confirm that the language mode is `OrgScript` and that blocks, statements, strings, operators, and dotted references are highlighted.
+
+## Good demo files
+
+- `examples/craft-business-lead-to-order.orgs`
+  Good for `process`, `if`, strings, dotted references, operators, and `stateflow`.
+- `examples/order-approval.orgs`
+  Good for `stateflow`, `rule`, `applies to`, and transitions.
+- `examples/service-escalation.orgs`
+  Good for `policy`, `event`, `metric`, and role-oriented language.
+
+## Current scope
+
+- TextMate grammar only
+- no semantic tokens
+- no IntelliSense
+- no snippets
+- no hover provider
+- no diagnostics integration
+- no editor-driven formatting

editors/vscode/language-configuration.json

@@ -1,36 +1,18 @@
 {
-  "brackets": [
-    ["{", "}"],
-    ["[", "]"],
-    ["(", ")"]
-  ],
   "autoClosingPairs": [
     {
       "open": "\"",
       "close": "\"",
-      "notIn": ["string"]
-    },
-    {
-      "open": "(",
-      "close": ")",
-      "notIn": ["string", "comment"]
-    },
-    {
-      "open": "[",
-      "close": "]",
-      "notIn": ["string", "comment"]
-    },
-    {
-      "open": "{",
-      "close": "}",
-      "notIn": ["string", "comment"]
+      "notIn": [
+        "string"
+      ]
     }
   ],
   "surroundingPairs": [
-    ["\"", "\""],
-    ["(", ")"],
-    ["[", "]"],
-    ["{", "}"]
+    [
+      "\"",
+      "\""
+    ]
   ],
   "wordPattern": "(-?\\d*\\.\\d\\w*)|([^\\s\\[\\]{}()<>=\"'`~!@#$%^&*+,.;:/?|\\\\]+)"
 }

editors/vscode/syntaxes/orgscript.tmLanguage.json

@@ -4,43 +4,97 @@
   "scopeName": "source.orgscript",
   "patterns": [
     {
-      "include": "#top-level-block"
+      "include": "#strings"
     },
     {
-      "include": "#keywords"
+      "include": "#top-level-blocks"
     },
     {
-      "include": "#strings"
+      "include": "#section-keywords"
+    },
+    {
+      "include": "#control-keywords"
+    },
+    {
+      "include": "#statement-keywords"
+    },
+    {
+      "include": "#booleans"
     },
     {
       "include": "#numbers"
     },
     {
       "include": "#operators"
+    },
+    {
+      "include": "#references"
     }
   ],
   "repository": {
-    "top-level-block": {
+    "top-level-blocks": {
       "patterns": [
         {
-          "match": "^(\\s*)(process|stateflow|rule|role|policy|metric|event)\\b(?:\\s+([A-Za-z_][\\w.-]*))?",
-          "name": "meta.block.orgscript",
+          "match": "^(\\s*)(process|stateflow|rule|role|policy|metric|event)(\\s+)([A-Za-z_][A-Za-z0-9_.-]*)\\b",
           "captures": {
             "2": {
-              "name": "keyword.control.orgscript"
+              "name": "storage.type.orgscript"
             },
-            "3": {
+            "4": {
               "name": "entity.name.type.orgscript"
             }
           }
         }
       ]
     },
-    "keywords": {
+    "section-keywords": {
+      "patterns": [
+        {
+          "match": "^(\\s*)(states|transitions|can|cannot|formula|owner|target)\\b",
+          "captures": {
+            "2": {
+              "name": "keyword.declaration.orgscript"
+            }
+          }
+        },
+        {
+          "match": "^(\\s*)(applies)(\\s+)(to)\\b",
+          "captures": {
+            "2": {
+              "name": "keyword.declaration.orgscript"
+            },
+            "4": {
+              "name": "keyword.declaration.orgscript"
+            }
+          }
+        }
+      ]
+    },
+    "control-keywords": {
       "patterns": [
         {
-          "match": "\\b(?:when|if|then|else|assign|transition|notify|create|update|require|stop|applies to|states|transitions|can|cannot|formula|owner|target|with|to|and|or)\\b",
-          "name": "keyword.control.orgscript"
+          "match": "^(\\s*)(if|when|then|else)\\b",
+          "captures": {
+            "2": {
+              "name": "keyword.control.orgscript"
+            }
+          }
+        },
+        {
+          "match": "\\b(with|to|and|or)\\b",
+          "name": "keyword.operator.word.orgscript"
+        }
+      ]
+    },
+    "statement-keywords": {
+      "patterns": [
+        {
+          "match": "^(\\s*)(assign|transition|notify|create|update|require|stop)\\b",
+          "captures": {
+            "2": {
+              "name": "keyword.control.orgscript"
+            }
+          }
         }
       ]
     },
@@ -59,19 +113,35 @@
         }
       ]
     },
+    "booleans": {
+      "patterns": [
+        {
+          "match": "\\b(?:true|false)\\b",
+          "name": "constant.language.boolean.orgscript"
+        }
+      ]
+    },
     "numbers": {
       "patterns": [
         {
-          "name": "constant.numeric.orgscript",
-          "match": "\\b\\d+(?:\\.\\d+)?(?:[smhd])?\\b"
+          "match": "\\b-?\\d+(?:\\.\\d+)?\\b",
+          "name": "constant.numeric.orgscript"
         }
       ]
     },
     "operators": {
       "patterns": [
         {
-          "name": "keyword.operator.orgscript",
-          "match": "(?:!=|<=|>=|->|=|<|>)"
+          "match": "(?:!=|<=|>=|->|=|<|>)",
+          "name": "keyword.operator.orgscript"
+        }
+      ]
+    },
+    "references": {
+      "patterns": [
+        {
+          "match": "\\b[A-Za-z_][A-Za-z0-9_-]*(?:\\.[A-Za-z_][A-Za-z0-9_-]*)+\\b",
+          "name": "variable.other.member.orgscript"
         }
       ]
     }