saffron-ai 0.4.2 → 0.5.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "saffron-ai",
-  "version": "0.4.2",
+  "version": "0.5.1",
   "description": "Gherkin-native AI-fallback test runner: zero-token cached replay, runtime AI healing, honest reports",
   "scripts": {
     "test": "vitest run",
@@ -8,7 +8,7 @@
     "dev": "tsc --watch",
     "e2e": "node scripts/e2e.mjs",
     "prepublishOnly": "npm run build && npm test && npm run bundle",
-    "docs": "node scripts/build-docs.mjs",
+    "docs": "node scripts/build-docs.mjs && node scripts/build-site-docs.mjs",
     "bundle": "esbuild src/cli/index.ts --bundle --platform=node --format=esm --packages=external --minify --legal-comments=none --outfile=dist-pkg/cli.js"
   },
   "keywords": [
@@ -56,7 +56,9 @@
     "dist-pkg",
     "skills",
     "textmate",
+    "templates",
     "README.md",
+    "CHANGELOG.md",
     "LICENSE"
   ]
 }

package/skills/saffron/references/config.md

@@ -59,7 +59,7 @@ your-project/
 | `saffron steps [search] [--json] [--snippets]` | The step vocabulary with recorded/divergent/unrecorded badges |
 | `saffron author <prose-file>` | Draft a `.saffron` file from plain-paragraph requirements using the project vocabulary |
 | `saffron mcp` / `saffron lsp` | Vocabulary for AI assistants / language server for editors |
-| `saffron init` | Install this skill into the project's agent directories and scaffold config |
+| `saffron init [--examples]` | Install this skill into the project's agent directories, register MCP, scaffold config; `--examples` adds the Saucedemo example suite |
 | `saffron report` | Open the latest HTML report |
 
 Exit codes: 0 green/yellow, 1 red (or yellow with `--strict`), 2 usage /

package/templates/saucedemo/.env.example

@@ -0,0 +1,5 @@
+# Saucedemo's public demo credentials. Copy this file to .env (git-ignored)
+# or export the variables in your shell. Saffron resolves {env:VAR} tokens
+# at replay and never writes the values into caches, proposals or reports.
+SAUCE_USER=standard_user
+SAUCE_PASSWORD=secret_sauce

package/templates/saucedemo/features/login.saffron

@@ -0,0 +1,37 @@
+Feature: Login
+
+  # Credentials come from the environment ({env:VAR}); they never land in
+  # caches, proposals or reports. See .env.example.
+
+  @smoke @login
+  Scenario: Successful login
+    Given I am on the login page
+    When I enter "{env:SAUCE_USER}" in the username field
+    And I enter "{env:SAUCE_PASSWORD}" in the password field
+    And I click the "Login" button
+    Then I should see the products page
+
+  @login
+  Scenario Outline: Login errors
+    Given I am on the login page
+    When I enter "<username>" in the username field
+    And I enter "<password>" in the password field
+    And I click the "Login" button
+    Then I should see the error message "<message>"
+
+    Examples:
+      | username        | password     | message                                               |
+      | locked_out_user | secret_sauce | Epic sadface: Sorry, this user has been locked out.  |
+      | standard_user   | wrong        | Epic sadface: Username and password do not match     |
+
+  @login @recover
+  Scenario: Recover from a locked-out login
+    # A StepSet in the middle of a scenario: the set's guard step takes the
+    # browser back to the login page before it logs the standard user in.
+    Given I am on the login page
+    When I enter "locked_out_user" in the username field
+    And I enter "secret_sauce" in the password field
+    And I click the "Login" button
+    Then I should see the error message "Epic sadface: Sorry, this user has been locked out."
+    StepSet Log in as the standard user
+    Then I should see the products page

package/templates/saucedemo/features/shared.steps.saffron

@@ -0,0 +1,25 @@
+Feature: Shared step sets for the Saucedemo example suite
+
+# A sets-only library file: no scenarios, only StepSet definitions. Any
+# .saffron file in the project invokes them with "StepSet <name>", at the
+# start of a scenario or anywhere in the middle. Each set opens with a
+# guard step and closes with an exit assertion, so every invocation checks
+# itself.
+
+StepSet: Log in as the standard user
+    Given I am on the login page
+    When I enter "{env:SAUCE_USER}" in the username field
+    And I enter "{env:SAUCE_PASSWORD}" in the password field
+    And I click the "Login" button
+    Then I should see the products page
+
+StepSet: Proceed to checkout with the standard details
+    Given I am on the products page
+    When I open the cart
+    And I click the "Checkout" button
+    And I enter the following checkout information
+      | firstName  | Ada      |
+      | lastName   | Lovelace |
+      | postalCode | 10117    |
+    And I click the "Continue" button
+    Then I should see the checkout overview

package/templates/saucedemo/features/shopping.saffron

@@ -0,0 +1,20 @@
+Feature: Shopping
+
+  # .saffron is Gherkin plus the StepSet keyword. The flows below are
+  # defined once in shared.steps.saffron; their steps are inlined at parse
+  # time, so they record once and replay everywhere.
+
+  @smoke @cart
+  Scenario: Add a product to the cart
+    StepSet Log in as the standard user
+    When I add "Sauce Labs Backpack" to the cart
+    Then the cart badge should show 1
+
+  @checkout
+  Scenario: Complete a checkout
+    StepSet Log in as the standard user
+    When I add "Sauce Labs Bike Light" to the cart
+    StepSet Proceed to checkout with the standard details
+    Then the overview should list "Sauce Labs Bike Light"
+    When I click the "Finish" button
+    Then I should see "Thank you for your order!"

package/templates/saucedemo/saffron.config.json

@@ -0,0 +1,6 @@
+{
+  "baseURL": "https://www.saucedemo.com",
+  "features": "features",
+  "retries": 1,
+  "strict": false
+}

package/textmate/saffron/syntaxes/saffron.tmLanguage.json

@@ -72,56 +72,78 @@
           "name": "keyword.control.stepset.saffron"
         },
         "2": {
-          "name": "entity.name.function.stepset.saffron"
-        }
-      }
-    },
-    "step": {
-      "match": "^\\s*(Given|When|Then|And|But|\\*)\\s(.*)$",
-      "captures": {
-        "1": {
-          "name": "keyword.other.step.saffron"
-        },
-        "2": {
-          "name": "string.unquoted.step-text.saffron",
+          "name": "entity.name.function.stepset.saffron",
           "patterns": [
             {
-              "match": "\"[^\"]*\"",
-              "name": "string.quoted.double.saffron"
+              "include": "#argument"
+            },
+            {
+              "include": "#placeholder"
             },
             {
-              "match": "<[^<>]+>",
-              "name": "variable.parameter.saffron"
+              "include": "#token"
             }
           ]
         }
       }
     },
+    "step": {
+      "begin": "^\\s*(Given|When|Then|And|But|\\*)\\b",
+      "beginCaptures": {
+        "1": {
+          "name": "keyword.other.step.saffron"
+        }
+      },
+      "end": "$",
+      "name": "meta.step.saffron",
+      "patterns": [
+        {
+          "include": "#argument"
+        },
+        {
+          "include": "#placeholder"
+        },
+        {
+          "include": "#token"
+        }
+      ]
+    },
     "docstring": {
       "begin": "^\\s*\"\"\"",
       "end": "^\\s*\"\"\"",
       "name": "string.quoted.docstring.saffron"
     },
     "table": {
-      "match": "^\\s*\\|.*\\|\\s*$",
+      "begin": "^\\s*(?=\\|)",
+      "end": "$",
       "name": "meta.table.saffron",
-      "captures": {
-        "0": {
-          "patterns": [
-            {
-              "match": "\\|",
-              "name": "punctuation.separator.table.saffron"
-            },
-            {
-              "match": "<[^<>]+>",
-              "name": "variable.parameter.saffron"
-            }
-          ]
+      "patterns": [
+        {
+          "match": "\\|",
+          "name": "punctuation.separator.table.saffron"
+        },
+        {
+          "include": "#placeholder"
+        },
+        {
+          "include": "#token"
         }
-      }
+      ]
+    },
+    "argument": {
+      "match": "\"[^\"]*\"",
+      "name": "string.quoted.double.argument.saffron"
+    },
+    "placeholder": {
+      "match": "<[^<>\\s]+>",
+      "name": "variable.parameter.placeholder.saffron"
+    },
+    "token": {
+      "match": "\\{(env:[A-Za-z_][A-Za-z0-9_]*|date(?:[+-]\\d+)?(?::[^}]+)?)\\}",
+      "name": "constant.other.token.saffron"
     }
   },
   "fileTypes": [
     "saffron"
   ]
-}
+}