markform 0.1.0 → 0.1.2

package/examples/simple/simple-skipped-filled.form.md

@@ -0,0 +1,170 @@
+---
+markform:
+  spec: "MF/0.1"
+  title: Simple Test Form
+  description: "Fully interactive demo - no LLM required. Demonstrates all Markform field types."
+  roles:
+    - user
+  role_instructions:
+    user: "Fill in all fields in this form."
+---
+
+{% form id="simple_test" title="Simple Test Form" %}
+
+{% description ref="simple_test" %}
+A fully interactive form demonstrating all Markform v0.1 field types.
+Fill all fields using interactive prompts - no LLM API key needed.
+{% /description %}
+
+{% field-group id="basic_fields" title="Basic Fields" %}
+
+{% string-field id="name" label="Name" maxLength=50 minLength=2 required=true role="user" %}
+```value
+Test User
+```
+{% /string-field %}
+
+{% instructions ref="name" %}
+Enter your full name (2-50 characters).
+{% /instructions %}
+
+{% string-field id="email" label="Email" pattern="^[^@]+@[^@]+\\.[^@]+$" required=true role="user" %}
+```value
+test@example.com
+```
+{% /string-field %}
+
+{% number-field id="age" integer=true label="Age" max=150 min=0 required=true role="user" %}
+```value
+25
+```
+{% /number-field %}
+
+{% number-field id="score" label="Score" max=100 min=0 role="user" state="skipped" %}
+```value
+%SKIP% (Not needed for this test)
+```
+{% /number-field %}
+
+{% instructions ref="score" %}
+Enter a score between 0 and 100 (optional).
+{% /instructions %}
+
+{% /field-group %}
+
+{% field-group id="list_fields" title="List Fields" %}
+
+{% string-list id="tags" itemMinLength=2 label="Tags" maxItems=5 minItems=1 required=true role="user" uniqueItems=true %}
+```value
+typescript
+testing
+```
+{% /string-list %}
+
+{% instructions ref="tags" %}
+Add 1-5 unique tags (each at least 2 characters).
+{% /instructions %}
+
+{% /field-group %}
+
+{% field-group id="selection_fields" title="Selection Fields" %}
+
+{% single-select id="priority" label="Priority" required=true role="user" %}
+- [ ] Low {% #low %}
+- [ ] Medium {% #medium %}
+- [x] High {% #high %}
+{% /single-select %}
+
+{% multi-select id="categories" label="Categories" maxSelections=3 minSelections=1 required=true role="user" %}
+- [x] Frontend {% #frontend %}
+- [x] Backend {% #backend %}
+- [ ] Database {% #database %}
+- [ ] DevOps {% #devops %}
+{% /multi-select %}
+
+{% /field-group %}
+
+{% field-group id="checkbox_fields" title="Checkbox Fields" %}
+
+{% checkboxes id="tasks_multi" label="Tasks (Multi Mode)" required=true role="user" %}
+- [x] Research {% #research %}
+- [x] Design {% #design %}
+- [x] Implement {% #implement %}
+- [-] Test {% #test %}
+{% /checkboxes %}
+
+{% instructions ref="tasks_multi" %}
+Track task progress. All must reach done or na state to complete.
+{% /instructions %}
+
+{% checkboxes checkboxMode="simple" id="tasks_simple" label="Agreements (Simple Mode)" required=true role="user" %}
+- [x] I have read the guidelines {% #read_guidelines %}
+- [x] I agree to the terms {% #agree_terms %}
+{% /checkboxes %}
+
+{% checkboxes checkboxMode="explicit" id="confirmations" label="Confirmations (Explicit Mode)" required=true role="user" %}
+- [y] Data has been backed up {% #backed_up %}
+- [n] Stakeholders notified {% #notified %}
+{% /checkboxes %}
+
+{% instructions ref="confirmations" %}
+Answer yes or no for each confirmation. All must be explicitly answered.
+{% /instructions %}
+
+{% /field-group %}
+
+{% field-group id="url_fields" title="URL Fields" %}
+
+{% url-field id="website" label="Website" required=true role="user" %}
+```value
+https://test.example.com
+```
+{% /url-field %}
+
+{% instructions ref="website" %}
+Enter your website URL (must be http or https).
+{% /instructions %}
+
+{% url-list id="references" label="References" maxItems=5 minItems=1 role="user" uniqueItems=true %}
+```value
+https://docs.example.com
+```
+{% /url-list %}
+
+{% instructions ref="references" %}
+Add 1-5 unique reference URLs for sources or documentation.
+{% /instructions %}
+
+{% /field-group %}
+
+{% field-group id="optional_fields" title="Optional Fields" %}
+
+{% string-field id="notes" label="Notes" role="user" state="skipped" %}
+```value
+%SKIP% (No notes required)
+```
+{% /string-field %}
+
+{% instructions ref="notes" %}
+Add any relevant notes or observations (optional).
+{% /instructions %}
+
+{% number-field id="optional_number" label="Optional Number" role="user" state="skipped" %}{% /number-field %}
+
+{% url-field id="related_url" label="Related URL" role="user" state="skipped" %}
+```value
+%SKIP% (No related URL needed)
+```
+{% /url-field %}
+
+{% instructions ref="related_url" %}
+Optionally add a URL to related documentation or resources.
+{% /instructions %}
+
+{% /field-group %}
+
+{% note id="note-summary" ref="simple_test" role="user" %}
+All required fields completed successfully. Optional fields skipped.
+{% /note %}
+
+{% /form %}

package/examples/simple/simple-with-skips.session.yaml

@@ -0,0 +1,189 @@
+session_version: 0.1.0
+mode: mock
+form:
+  path: simple.form.md
+mock:
+  completed_mock: simple-skipped-filled.form.md
+harness:
+  max_turns: 100
+  max_patches_per_turn: 20
+  max_issues_per_turn: 10
+  target_roles:
+    - '*'
+  fill_mode: continue
+turns:
+  - turn: 1
+    inspect:
+      issues:
+        - ref: age
+          scope: field
+          reason: required_missing
+          message: Required field "Age" is empty
+          severity: required
+          priority: 1
+        - ref: categories
+          scope: field
+          reason: required_missing
+          message: Required field "Categories" has no selections
+          severity: required
+          priority: 1
+        - ref: confirmations
+          scope: field
+          reason: required_missing
+          message: All items in "Confirmations (Explicit Mode)" must be answered (2 unfilled)
+          severity: required
+          priority: 1
+        - ref: email
+          scope: field
+          reason: required_missing
+          message: Required field "Email" is empty
+          severity: required
+          priority: 1
+        - ref: name
+          scope: field
+          reason: required_missing
+          message: Required field "Name" is empty
+          severity: required
+          priority: 1
+        - ref: priority
+          scope: field
+          reason: required_missing
+          message: Required field "Priority" has no selection
+          severity: required
+          priority: 1
+        - ref: tags
+          scope: field
+          reason: required_missing
+          message: Required field "Tags" is empty
+          severity: required
+          priority: 1
+        - ref: tasks_multi
+          scope: field
+          reason: required_missing
+          message: All items in "Tasks (Multi Mode)" must be completed
+          severity: required
+          priority: 1
+        - ref: tasks_simple
+          scope: field
+          reason: required_missing
+          message: All items in "Agreements (Simple Mode)" must be checked (2 unchecked)
+          severity: required
+          priority: 1
+        - ref: website
+          scope: field
+          reason: required_missing
+          message: Required field "Website" is empty
+          severity: required
+          priority: 1
+    apply:
+      patches:
+        - op: set_number
+          field_id: age
+          value: 25
+        - op: set_multi_select
+          field_id: categories
+          selected:
+            - frontend
+            - backend
+        - op: set_checkboxes
+          field_id: confirmations
+          values:
+            backed_up: yes
+            notified: no
+        - op: set_string
+          field_id: email
+          value: test@example.com
+        - op: set_string
+          field_id: name
+          value: Test User
+        - op: set_single_select
+          field_id: priority
+          selected: high
+        - op: set_string_list
+          field_id: tags
+          items:
+            - typescript
+            - testing
+        - op: set_checkboxes
+          field_id: tasks_multi
+          values:
+            research: done
+            design: done
+            implement: done
+            test: na
+        - op: set_checkboxes
+          field_id: tasks_simple
+          values:
+            read_guidelines: done
+            agree_terms: done
+        - op: set_url
+          field_id: website
+          value: https://test.example.com
+    after:
+      required_issue_count: 0
+      markdown_sha256: 62c9aad095c2ea5c2947c308c5e4b3c4cbc677a7e481971871c5091d5ca27b02
+      answered_field_count: 10
+      skipped_field_count: 0
+  - turn: 2
+    inspect:
+      issues:
+        - ref: notes
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: optional_number
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: references
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: related_url
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: score
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+    apply:
+      patches:
+        - op: skip_field
+          field_id: notes
+          role: agent
+          reason: No value in mock form
+        - op: skip_field
+          field_id: optional_number
+          role: agent
+          reason: No value in mock form
+        - op: set_url_list
+          field_id: references
+          items:
+            - https://docs.example.com
+        - op: skip_field
+          field_id: related_url
+          role: agent
+          reason: No value in mock form
+        - op: skip_field
+          field_id: score
+          role: agent
+          reason: No value in mock form
+    after:
+      required_issue_count: 0
+      markdown_sha256: 5ca306e53bdb0213b0558f6132c7a5af491c40c8765f25bc7047efa0478b7876
+      answered_field_count: 11
+      skipped_field_count: 4
+final:
+  expect_complete: true
+  expected_completed_form: simple-skipped-filled.form.md

package/examples/simple/simple.form.md

@@ -1,19 +1,19 @@
 ---
 markform:
-  markform_version: "0.1.0"
+  spec: MF/0.1
+  title: Simple Test Form
+  description: "Fully interactive demo - no LLM required. Demonstrates all Markform field types."
   roles:
     - user
-    - agent
   role_instructions:
-    user: "Fill in the required fields in this form."
-    agent: "Fill in the optional fields with reasonable test values."
+    user: "Fill in all fields in this form."
 ---
 
 {% form id="simple_test" title="Simple Test Form" %}
 
 {% description ref="simple_test" %}
-A form demonstrating user and agent roles. User fills required fields,
-agent fills optional fields. Demonstrates all Markform v0.1 field types.
+A fully interactive form demonstrating all Markform v0.1 field types.
+Fill all fields using interactive prompts - no LLM API key needed.
 {% /description %}
 
 {% field-group id="basic_fields" title="Basic Fields" %}
@@ -28,10 +28,10 @@ Enter your full name (2-50 characters).
 
 {% number-field id="age" label="Age" role="user" required=true min=0 max=150 integer=true %}{% /number-field %}
 
-{% number-field id="score" label="Score" role="agent" min=0.0 max=100.0 %}{% /number-field %}
+{% number-field id="score" label="Score" role="user" min=0.0 max=100.0 %}{% /number-field %}
 
 {% instructions ref="score" %}
-Assign a score between 0 and 100 based on form completeness.
+Enter a score between 0 and 100 (optional).
 {% /instructions %}
 
 {% /field-group %}
@@ -92,15 +92,37 @@ Answer yes or no for each confirmation. All must be explicitly answered.
 
 {% /field-group %}
 
-{% field-group id="optional_fields" title="Optional Fields (Agent)" %}
+{% field-group id="url_fields" title="URL Fields" %}
 
-{% string-field id="notes" label="Notes" role="agent" %}{% /string-field %}
+{% url-field id="website" label="Website" role="user" required=true %}{% /url-field %}
+
+{% instructions ref="website" %}
+Enter your website URL (must be http or https).
+{% /instructions %}
+
+{% url-list id="references" label="References" role="user" minItems=1 maxItems=5 uniqueItems=true %}{% /url-list %}
+
+{% instructions ref="references" %}
+Add 1-5 unique reference URLs for sources or documentation.
+{% /instructions %}
+
+{% /field-group %}
+
+{% field-group id="optional_fields" title="Optional Fields" %}
+
+{% string-field id="notes" label="Notes" role="user" %}{% /string-field %}
 
 {% instructions ref="notes" %}
-Add any relevant notes or observations about this test form.
+Add any relevant notes or observations (optional).
 {% /instructions %}
 
-{% number-field id="optional_number" label="Optional Number" role="agent" %}{% /number-field %}
+{% number-field id="optional_number" label="Optional Number" role="user" %}{% /number-field %}
+
+{% url-field id="related_url" label="Related URL" role="user" %}{% /url-field %}
+
+{% instructions ref="related_url" %}
+Optionally add a URL to related documentation or resources.
+{% /instructions %}
 
 {% /field-group %}
 

package/examples/simple/simple.session.yaml

@@ -5,12 +5,12 @@ form:
 mock:
   completed_mock: simple-mock-filled.form.md
 harness:
-  max_turns: 50
+  max_turns: 100
   max_patches_per_turn: 20
-  max_issues: 20
+  max_issues_per_turn: 10
   target_roles:
-    - user
-    - agent
+    - '*'
+  fill_mode: continue
 turns:
   - turn: 1
     inspect:
@@ -23,70 +23,58 @@ turns:
           priority: 1
         - ref: categories
           scope: field
-          reason: validation_error
+          reason: required_missing
           message: Required field "Categories" has no selections
           severity: required
-          priority: 2
+          priority: 1
         - ref: confirmations
           scope: field
-          reason: validation_error
+          reason: required_missing
           message: All items in "Confirmations (Explicit Mode)" must be answered (2 unfilled)
           severity: required
-          priority: 3
+          priority: 1
         - ref: email
           scope: field
           reason: required_missing
           message: Required field "Email" is empty
           severity: required
-          priority: 4
+          priority: 1
         - ref: name
           scope: field
           reason: required_missing
           message: Required field "Name" is empty
           severity: required
-          priority: 5
+          priority: 1
         - ref: priority
           scope: field
-          reason: validation_error
+          reason: required_missing
           message: Required field "Priority" has no selection
           severity: required
-          priority: 6
+          priority: 1
         - ref: tags
           scope: field
           reason: required_missing
           message: Required field "Tags" is empty
           severity: required
-          priority: 7
+          priority: 1
         - ref: tasks_multi
           scope: field
-          reason: validation_error
+          reason: required_missing
           message: All items in "Tasks (Multi Mode)" must be completed
           severity: required
-          priority: 8
+          priority: 1
         - ref: tasks_simple
           scope: field
-          reason: validation_error
+          reason: required_missing
           message: All items in "Agreements (Simple Mode)" must be checked (2 unchecked)
           severity: required
-          priority: 9
-        - ref: notes
-          scope: field
-          reason: optional_empty
-          message: Optional field has no value
-          severity: recommended
-          priority: 10
-        - ref: optional_number
-          scope: field
-          reason: optional_empty
-          message: Optional field has no value
-          severity: recommended
-          priority: 11
-        - ref: score
+          priority: 1
+        - ref: website
           scope: field
-          reason: optional_empty
-          message: Optional field has no value
-          severity: recommended
-          priority: 12
+          reason: required_missing
+          message: Required field "Website" is empty
+          severity: required
+          priority: 1
     apply:
       patches:
         - op: set_number
@@ -129,18 +117,73 @@ turns:
           values:
             read_guidelines: done
             agree_terms: done
+        - op: set_url
+          field_id: website
+          value: https://alice.dev
+    after:
+      required_issue_count: 0
+      markdown_sha256: 82ebecc97db1321838d47491c23ab951525e1fa5fd14590cd306565faa00b05f
+      answered_field_count: 10
+      skipped_field_count: 0
+  - turn: 2
+    inspect:
+      issues:
+        - ref: notes
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: optional_number
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: references
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: related_url
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+        - ref: score
+          scope: field
+          reason: optional_empty
+          message: Optional field has no value
+          severity: recommended
+          priority: 3
+    apply:
+      patches:
         - op: set_string
           field_id: notes
           value: This is a test note.
-        - op: set_number
+        - op: skip_field
           field_id: optional_number
-          value: null
+          role: agent
+          reason: No value in mock form
+        - op: set_url_list
+          field_id: references
+          items:
+            - https://docs.example.com/guide
+            - https://github.com/example/project
+            - https://medium.com/article-about-forms
+        - op: set_url
+          field_id: related_url
+          value: https://markform.dev/docs
         - op: set_number
           field_id: score
           value: 87.5
     after:
       required_issue_count: 0
-      markdown_sha256: d633b7eaeb1be08374fd829a9865d476bf16c49292261ab3749b66855f61cdea
+      markdown_sha256: 09ad2c0b12f3b27505ea3fbcfd35e025e94d906c1cb9701322b793b233db54dd
+      answered_field_count: 14
+      skipped_field_count: 1
 final:
   expect_complete: true
   expected_completed_form: simple-mock-filled.form.md