vscode-scenetest 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Michael Snook
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# Scenetest VS Code Extension
+
+Syntax highlighting for Scenetest scene specs (`.spec.md` files).
+
+## Features
+
+- **Syntax highlighting** for the text DSL format
+- **Folding** by scene headings
+- **Comment toggling** with `//`
+
+### Highlighted Elements
+
+| Element | Example | Color |
+|---------|---------|-------|
+| Scene headings | `# group`, `## scene name` | Heading |
+| Actor declarations | `user:`, `admin:` | Variable |
+| Actions | `see`, `click`, `typeInto` | Function |
+| Selectors | `login-form`, `nav-menu` | String |
+| Interpolation | `[user.email]` | Variable interpolation |
+| Aliases | `~modal`, `~nav` | Constant |
+| Aria-labels | `@Close`, `@Submit` | Constant |
+| URLs | `/login`, `https://...` | Link |
+| Numbers | `5000` | Number |
+| Comments | `// log in flow` | Comment |
+| Macros | `login()`, `setup()` | Function |
+| Coordination | `emit`, `waitFor` | Keyword |
+| Conditionals | `if` | Keyword |
+
+## Installation
+
+### From VSIX (local)
+
+```bash
+# Build the VSIX
+cd packages/vscode-scenetest
+npx @vscode/vsce package
+
+# Install
+code --install-extension vscode-scenetest-0.1.0.vsix
+```
+
+### From source (development)
+
+1. Open the `packages/vscode-scenetest` folder in VS Code
+2. Press F5 to launch Extension Development Host
+3. Open a `.spec.md` file to see highlighting
+
+## Example
+
+```markdown
+# User friend requests
+
+## new user signs up and gets a friend request
+new-user:
+- openTo /
+- see welcome-box
+- click continue-button
+
+primary-user:
+- openTo /friends
+- click main-navbar search
+- typeInto search-input [new-user.username]
+- see search-results-section
+- click friend-request-button
+
+new-user:
+- seeToast friend-request
+- see navbar notifications-badge
+- click
+- see notifications-menu-expanded new-friend-request
+- click
+```
+
+## Roadmap
+
+See the [Developer Experience design doc](/docs/public/design/developer-experience.md) for planned features:
+
+- **Phase 2:** Language Server for scope tracking, hover info, go-to-definition
+- **Phase 3:** Selector manifest generation and autocomplete
+- **Phase 4:** ESLint integration for validation

package/language-configuration.json

@@ -0,0 +1,27 @@
+{
+  "comments": {
+    "lineComment": "//"
+  },
+  "brackets": [
+    ["[", "]"],
+    ["(", ")"]
+  ],
+  "autoClosingPairs": [
+    { "open": "[", "close": "]" },
+    { "open": "(", "close": ")" },
+    { "open": "\"", "close": "\"" },
+    { "open": "'", "close": "'" }
+  ],
+  "surroundingPairs": [
+    ["[", "]"],
+    ["(", ")"],
+    ["\"", "\""],
+    ["'", "'"]
+  ],
+  "folding": {
+    "markers": {
+      "start": "^#{1,2}\\s",
+      "end": "^(?=#{1,2}\\s)"
+    }
+  }
+}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "vscode-scenetest",
+  "displayName": "Scenetest",
+  "description": "Syntax highlighting for Scenetest scene specs (.spec.md)",
+  "version": "0.1.0",
+  "publisher": "scenetest",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/scenetest/scenetest-js"
+  },
+  "engines": {
+    "vscode": "^1.80.0"
+  },
+  "categories": [
+    "Programming Languages"
+  ],
+  "keywords": [
+    "scenetest",
+    "e2e",
+    "testing",
+    "spec"
+  ],
+  "contributes": {
+    "languages": [
+      {
+        "id": "scenetest-spec",
+        "aliases": [
+          "Scenetest Spec",
+          "scenetest"
+        ],
+        "extensions": [
+          ".spec.md"
+        ],
+        "configuration": "./language-configuration.json"
+      }
+    ],
+    "grammars": [
+      {
+        "language": "scenetest-spec",
+        "scopeName": "source.scenetest-spec",
+        "path": "./syntaxes/scenetest-spec.tmLanguage.json"
+      }
+    ]
+  }
+}

package/syntaxes/scenetest-spec.tmLanguage.json

@@ -0,0 +1,216 @@
+{
+  "$schema": "https://raw.githubusercontent.com/martinring/tmlanguage/master/tmlanguage.json",
+  "name": "Scenetest Spec",
+  "scopeName": "source.scenetest-spec",
+  "patterns": [
+    { "include": "#heading" },
+    { "include": "#comment" },
+    { "include": "#actor-declaration" },
+    { "include": "#action-line" }
+  ],
+  "repository": {
+    "heading": {
+      "patterns": [
+        {
+          "name": "markup.heading.1.scenetest",
+          "match": "^(#{1,2})\\s+(.*)$",
+          "captures": {
+            "1": { "name": "punctuation.definition.heading.scenetest" },
+            "2": { "name": "entity.name.section.scenetest" }
+          }
+        }
+      ]
+    },
+    "comment": {
+      "name": "comment.line.double-slash.scenetest",
+      "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?//\\s*(.*)$",
+      "captures": {
+        "1": { "name": "comment.line.double-slash.scenetest" }
+      }
+    },
+    "actor-declaration": {
+      "patterns": [
+        {
+          "comment": "Actor cue with inline action: user: openTo /login",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?([a-zA-Z][a-zA-Z0-9_-]*):\\s+(openTo|see|seeInView|notSee|seeText|seeToast|click|typeInto|check|select|wait|emit|waitFor|warnIf|up|prev|scrollToBottom|if)(?:\\s+(.*))?$",
+          "captures": {
+            "1": { "name": "variable.other.actor.scenetest" },
+            "2": { "name": "entity.name.function.action.scenetest" },
+            "3": { "patterns": [{ "include": "#action-arguments" }] }
+          }
+        },
+        {
+          "comment": "Actor cue standalone: user:",
+          "name": "variable.other.actor.scenetest",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?([a-zA-Z][a-zA-Z0-9_-]*):\\s*$",
+          "captures": {
+            "1": { "name": "variable.other.actor.scenetest" }
+          }
+        }
+      ]
+    },
+    "action-line": {
+      "patterns": [
+        {
+          "comment": "Macro invocation: login() or login() args — args are plain values, not selectors",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?([a-zA-Z][a-zA-Z0-9_-]*)\\(\\)(?:\\s+(.*))?$",
+          "captures": {
+            "1": { "name": "entity.name.function.macro.scenetest" },
+            "2": { "patterns": [{ "include": "#value-with-interpolation" }] }
+          }
+        },
+        {
+          "comment": "Conditional if",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(if)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "keyword.control.conditional.scenetest" },
+            "2": { "patterns": [{ "include": "#selector-chain" }] }
+          }
+        },
+        {
+          "comment": "Coordination actions: emit, waitFor — message names are symbolic like selectors",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(emit|waitFor)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "keyword.other.coordination.scenetest" },
+            "2": { "patterns": [{ "include": "#selector-chain" }] }
+          }
+        },
+        {
+          "comment": "Navigation action: openTo",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(openTo)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "name": "string.other.link.scenetest" }
+          }
+        },
+        {
+          "comment": "Wait action with number",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(wait)\\s+(\\d+)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "name": "constant.numeric.scenetest" }
+          }
+        },
+        {
+          "comment": "Input actions: typeInto, select (selector + value)",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(typeInto|select)\\s+(\\S+)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "patterns": [{ "include": "#selector-token" }] },
+            "3": { "patterns": [{ "include": "#value-with-interpolation" }] }
+          }
+        },
+        {
+          "comment": "Warning action: warnIf (selector + message)",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(warnIf)\\s+(\\S+)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "patterns": [{ "include": "#selector-token" }] },
+            "3": { "patterns": [{ "include": "#value-with-interpolation" }] }
+          }
+        },
+        {
+          "comment": "Text assertion: seeText",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(seeText)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "patterns": [{ "include": "#value-with-interpolation" }] }
+          }
+        },
+        {
+          "comment": "Bare scope actions: click, up, prev, scrollToBottom (no arguments)",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(click|up|prev|scrollToBottom)\\s*$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" }
+          }
+        },
+        {
+          "comment": "Selector actions: see, seeInView, notSee, seeToast, click, check, up",
+          "match": "^\\s*(?:-\\s*|\\d+\\.\\s*)?(see|seeInView|notSee|seeToast|click|check|up)\\s+(.*)$",
+          "captures": {
+            "1": { "name": "entity.name.function.action.scenetest" },
+            "2": { "patterns": [{ "include": "#selector-chain" }] }
+          }
+        }
+      ]
+    },
+    "action-arguments": {
+      "patterns": [
+        { "include": "#interpolation" },
+        { "include": "#sigil" },
+        { "include": "#number" },
+        { "include": "#url" },
+        { "include": "#plain-text" }
+      ]
+    },
+    "selector-chain": {
+      "patterns": [
+        { "include": "#interpolation" },
+        { "include": "#sigil" },
+        { "include": "#selector-token" }
+      ]
+    },
+    "selector-token": {
+      "patterns": [
+        {
+          "comment": "Alias sigil: ~modal — same color as selectors, sigil provides distinction",
+          "name": "string.unquoted.selector.scenetest",
+          "match": "~[a-zA-Z][a-zA-Z0-9_-]*"
+        },
+        {
+          "comment": "Aria-label sigil: @Close — same color as selectors, sigil provides distinction",
+          "name": "string.unquoted.selector.scenetest",
+          "match": "@[a-zA-Z][a-zA-Z0-9_-]*"
+        },
+        {
+          "comment": "Interpolation: [actor.field]",
+          "name": "variable.interpolation.scenetest",
+          "match": "\\[[a-zA-Z][a-zA-Z0-9_-]*\\.[a-zA-Z][a-zA-Z0-9_-]*\\]"
+        },
+        {
+          "comment": "Plain selector token",
+          "name": "string.unquoted.selector.scenetest",
+          "match": "[a-zA-Z0-9_-]+"
+        }
+      ]
+    },
+    "value-with-interpolation": {
+      "comment": "Plain text with optional interpolation - only interpolations get highlighted",
+      "patterns": [
+        {
+          "comment": "Interpolation in value: [actor.field]",
+          "name": "variable.interpolation.scenetest",
+          "match": "\\[[a-zA-Z][a-zA-Z0-9_-]*\\.[a-zA-Z][a-zA-Z0-9_-]*\\]"
+        }
+      ]
+    },
+    "interpolation": {
+      "name": "variable.interpolation.scenetest",
+      "match": "\\[[a-zA-Z][a-zA-Z0-9_-]*\\.[a-zA-Z][a-zA-Z0-9_-]*\\]"
+    },
+    "sigil": {
+      "patterns": [
+        {
+          "name": "string.unquoted.selector.scenetest",
+          "match": "~[a-zA-Z][a-zA-Z0-9_-]*"
+        },
+        {
+          "name": "string.unquoted.selector.scenetest",
+          "match": "@[a-zA-Z][a-zA-Z0-9_-]*"
+        }
+      ]
+    },
+    "number": {
+      "name": "constant.numeric.scenetest",
+      "match": "\\b\\d+\\b"
+    },
+    "url": {
+      "name": "string.other.link.scenetest",
+      "match": "(?:https?://[^\\s]+|/[^\\s]*)"
+    },
+    "plain-text": {
+      "name": "string.unquoted.scenetest",
+      "match": "[^\\[\\]~@\\s]+"
+    }
+  }
+}

package/test/example.spec.md

@@ -0,0 +1,71 @@
+# User Authentication
+
+## new user signs up
+new-user:
+- openTo /signup
+- see signup-form
+- typeInto email-input [new-user.email]
+- typeInto password-input secretpassword123
+- click submit-button
+- see ~modal confirmation-dialog
+- click @Confirm
+- seeToast success-toast
+- see dashboard
+
+## existing user logs in
+primary-user:
+- openTo /login
+// Enter credentials
+- see login-form
+- typeInto email [primary-user.email]
+- typeInto password [primary-user.password]
+- click submit
+- wait 1000
+- see dashboard main-content
+
+# Multi-Actor Scenarios
+
+## sender and receiver exchange messages
+sender:
+- openTo /compose
+- see compose-form
+- typeInto body Hello from sender!
+- click send
+- emit message-sent
+
+receiver:
+- waitFor message-sent
+- openTo /inbox
+- seeText New message
+- click inbox-item 12345
+- see message-detail
+- seeInView reply-button
+
+# Edge Cases
+
+## modal navigation
+user:
+- see ~modal form-container
+- click nested-button
+- prev
+- up
+- scrollToBottom
+- click
+
+## conditional flow
+admin:
+- openTo /admin
+- if error-banner
+  - click dismiss
+  - notSee error-banner
+- see admin-dashboard
+
+## macro usage
+test-user:
+- login() alice@test.com secret123
+- see dashboard
+
+## warning action
+user:
+- warnIf slow-query Performance issue detected
+- see results