markform 0.1.20 → 0.1.22

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

@@ -1,244 +1,227 @@
 ---
 markform:
-  spec: "MF/0.1"
+  spec: MF/0.1
   title: Simple Test Form
-  description: "Fully interactive demo - no LLM required. Demonstrates all Markform field types."
+  description: Fully interactive demo - no LLM required. Demonstrates all Markform field types.
   roles:
     - user
   role_instructions:
-    user: "Fill in all fields in this form."
+    user: Fill in all fields in this form.
 ---
-{% form id="simple_test" title="Simple Test Form" %}
 
-{% description ref="simple_test" %}
+<!-- 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 %}
+<!-- /description -->
 
-{% group id="basic_fields" title="Basic Fields" %}
+<!-- group id="basic_fields" title="Basic Fields" -->
 
-{% field kind="string" id="name" label="Name" maxLength=50 minLength=2 required=true role="user" placeholder="Enter your name" examples=["John Smith", "Jane Doe"] %}
+<!-- field kind="string" id="name" role="user" examples=["John Smith", "Jane Doe"] label="Name" maxLength=50 minLength=2 placeholder="Enter your name" required=true -->
 ```value
 Test User
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="name" %}
+<!-- instructions ref="name" -->
 Enter your full name (2-50 characters).
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="string" id="email" label="Email" pattern="^[^@]+@[^@]+\\.[^@]+$" required=true role="user" placeholder="email@example.com" examples=["alice@company.com", "bob@example.org"] %}
+<!-- field kind="string" id="email" role="user" examples=["alice@company.com", "bob@example.org"] label="Email" pattern="^[^@]+@[^@]+\\.[^@]+$" placeholder="email@example.com" required=true -->
 ```value
 test@example.com
 ```
-{% /field %}
+<!-- /field -->
 
-{% field kind="number" id="age" integer=true label="Age" max=150 min=0 required=true role="user" placeholder="25" examples=["18", "30", "45"] %}
+<!-- field kind="number" id="age" role="user" examples=["18", "30", "45"] integer=true label="Age" max=150 min=0 placeholder="25" required=true -->
 ```value
 25
 ```
-{% /field %}
+<!-- /field -->
 
-{% field kind="number" id="score" label="Score" max=100 min=0 role="user" state="skipped" placeholder="85.5" examples=["75.0", "90.5", "100.0"] %}
+<!-- field kind="number" id="score" role="user" examples=["75.0", "90.5", "100.0"] label="Score" max=100 min=0 placeholder="85.5" state="skipped" -->
 ```value
 %SKIP% (Not needed for this test)
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="score" %}
+<!-- instructions ref="score" -->
 Enter a score between 0 and 100 (optional).
-{% /instructions %}
+<!-- /instructions -->
 
-{% /group %}
+<!-- /group -->
 
-{% group id="list_fields" title="List Fields" %}
+<!-- group id="list_fields" title="List Fields" -->
 
-{% field kind="string_list" id="tags" itemMinLength=2 label="Tags" maxItems=5 minItems=1 required=true role="user" uniqueItems=true %}
+<!-- field kind="string_list" id="tags" role="user" itemMinLength=2 label="Tags" maxItems=5 minItems=1 required=true uniqueItems=true -->
 ```value
 typescript
 testing
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="tags" %}
+<!-- instructions ref="tags" -->
 Add 1-5 unique tags (each at least 2 characters).
-{% /instructions %}
-
-{% /group %}
-
-{% group id="selection_fields" title="Selection Fields" %}
-
-{% field kind="single_select" id="priority" label="Priority" required=true role="user" %}
-
-- [ ] Low {% #low %}
-- [ ] Medium {% #medium %}
-- [x] High {% #high %}
+<!-- /instructions -->
 
-{% /field %}
+<!-- /group -->
 
-{% field kind="multi_select" id="categories" label="Categories" maxSelections=3 minSelections=1 required=true role="user" %}
+<!-- group id="selection_fields" title="Selection Fields" -->
 
-- [x] Frontend {% #frontend %}
-- [x] Backend {% #backend %}
-- [ ] Database {% #database %}
-- [ ] DevOps {% #devops %}
+<!-- field kind="single_select" id="priority" role="user" label="Priority" required=true -->
+- [ ] Low <!-- #low -->
+- [ ] Medium <!-- #medium -->
+- [x] High <!-- #high -->
+<!-- /field -->
 
-{% /field %}
+<!-- field kind="multi_select" id="categories" role="user" label="Categories" maxSelections=3 minSelections=1 required=true -->
+- [x] Frontend <!-- #frontend -->
+- [x] Backend <!-- #backend -->
+- [ ] Database <!-- #database -->
+- [ ] DevOps <!-- #devops -->
+<!-- /field -->
 
-{% /group %}
+<!-- /group -->
 
-{% group id="checkbox_fields" title="Checkbox Fields" %}
+<!-- group id="checkbox_fields" title="Checkbox Fields" -->
 
-{% field kind="checkboxes" id="tasks_multi" label="Tasks (Multi Mode)" required=true role="user" %}
+<!-- field kind="checkboxes" id="tasks_multi" role="user" label="Tasks (Multi Mode)" required=true -->
+- [x] Research <!-- #research -->
+- [x] Design <!-- #design -->
+- [x] Implement <!-- #implement -->
+- [-] Test <!-- #test -->
+<!-- /field -->
 
-- [x] Research {% #research %}
-- [x] Design {% #design %}
-- [x] Implement {% #implement %}
-- [-] Test {% #test %}
-
-{% /field %}
-
-{% instructions ref="tasks_multi" %}
+<!-- instructions ref="tasks_multi" -->
 Track task progress.
 All must reach done or na state to complete.
-{% /instructions %}
-
-{% field kind="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 %}
+<!-- /instructions -->
 
-{% /field %}
+<!-- field kind="checkboxes" id="tasks_simple" role="user" checkboxMode="simple" label="Agreements (Simple Mode)" required=true -->
+- [x] I have read the guidelines <!-- #read_guidelines -->
+- [x] I agree to the terms <!-- #agree_terms -->
+<!-- /field -->
 
-{% field kind="checkboxes" checkboxMode="explicit" id="confirmations" label="Confirmations (Explicit Mode)" required=true role="user" %}
+<!-- field kind="checkboxes" id="confirmations" role="user" checkboxMode="explicit" label="Confirmations (Explicit Mode)" required=true -->
+- [y] Data has been backed up <!-- #backed_up -->
+- [n] Stakeholders notified <!-- #notified -->
+<!-- /field -->
 
-- [y] Data has been backed up {% #backed_up %}
-- [n] Stakeholders notified {% #notified %}
-
-{% /field %}
-
-{% instructions ref="confirmations" %}
+<!-- instructions ref="confirmations" -->
 Answer yes or no for each confirmation.
 All must be explicitly answered.
-{% /instructions %}
+<!-- /instructions -->
 
-{% /group %}
+<!-- /group -->
 
-{% group id="url_fields" title="URL Fields" %}
+<!-- group id="url_fields" title="URL Fields" -->
 
-{% field kind="url" id="website" label="Website" required=true role="user" placeholder="https://example.com" examples=["https://github.com/user/repo", "https://company.com"] %}
+<!-- field kind="url" id="website" role="user" examples=["https://github.com/user/repo", "https://company.com"] label="Website" placeholder="https://example.com" required=true -->
 ```value
 https://test.example.com
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="website" %}
+<!-- instructions ref="website" -->
 Enter your website URL (must be http or https).
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="url_list" id="references" label="References" maxItems=5 minItems=1 role="user" uniqueItems=true placeholder="https://docs.example.com" examples=["https://wikipedia.org/wiki/Example", "https://docs.github.com/en"] %}
+<!-- field kind="url_list" id="references" role="user" examples=["https://wikipedia.org/wiki/Example", "https://docs.github.com/en"] label="References" maxItems=5 minItems=1 placeholder="https://docs.example.com" uniqueItems=true -->
 ```value
 https://docs.example.com
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="references" %}
+<!-- instructions ref="references" -->
 Add 1-5 unique reference URLs for sources or documentation.
-{% /instructions %}
+<!-- /instructions -->
 
-{% /group %}
+<!-- /group -->
 
-{% group id="date_fields" title="Date and Year Fields" %}
+<!-- group id="date_fields" title="Date and Year Fields" -->
 
-{% field kind="date" id="event_date" label="Event Date" max="2030-12-31" min="2020-01-01" required=true role="user" %}
+<!-- field kind="date" id="event_date" role="user" label="Event Date" max="2030-12-31" min="2020-01-01" required=true -->
 ```value
 2025-03-15
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="event_date" %}
+<!-- instructions ref="event_date" -->
 Enter the event date (YYYY-MM-DD format, between 2020 and 2030).
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="year" id="founded_year" label="Founded Year" max=2030 min=1900 required=true role="user" %}
+<!-- field kind="year" id="founded_year" role="user" label="Founded Year" max=2030 min=1900 required=true -->
 ```value
 2021
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="founded_year" %}
+<!-- instructions ref="founded_year" -->
 Enter the year the company was founded (1900-2030).
-{% /instructions %}
-
-{% /group %}
+<!-- /instructions -->
 
-{% group id="table_fields" title="Table Fields" %}
+<!-- /group -->
 
-{% field kind="table" id="team_members" label="Team Members" role="user" minRows=0 maxRows=5 state="skipped" columnIds=["name", "role", "start_date"] columnTypes=[{type: "string", required: true}, "string", "date"] %}
+<!-- group id="table_fields" title="Table Fields" -->
 
-| Name | Role | Start Date |
-|------|------|------------|
+<!-- field kind="table" id="team_members" role="user" columnIds=["name", "role", "start_date"] columnLabels=["Name", "Role", "Start Date"] columnTypes=[{type: "string", required: true}, "string", "date"] label="Team Members" maxRows=5 minRows=0 state="skipped" --><!-- /field -->
 
-{% /field %}
-
-{% instructions ref="team_members" %}
+<!-- instructions ref="team_members" -->
 Add team members with their name (required), role, and start date.
-{% /instructions %}
-
-{% field kind="table" id="project_tasks" label="Project Tasks" role="user" minRows=0 maxRows=10 state="skipped" columnIds=["task", "estimate_hrs", "link"] columnTypes=[{type: "string", required: true}, "number", "url"] %}
+<!-- /instructions -->
 
-| Task | Estimate (hrs) | Link |
-|------|----------------|------|
+<!-- field kind="table" id="project_tasks" role="user" columnIds=["task", "estimate_hrs", "link"] columnLabels=["Task", "Estimate (hrs)", "Link"] columnTypes=[{type: "string", required: true}, "number", "url"] label="Project Tasks" maxRows=10 minRows=0 state="skipped" --><!-- /field -->
 
-{% /field %}
-
-{% instructions ref="project_tasks" %}
+<!-- instructions ref="project_tasks" -->
 Optionally add project tasks with estimated hours and reference links.
-{% /instructions %}
+<!-- /instructions -->
 
-{% /group %}
+<!-- /group -->
 
-{% group id="optional_fields" title="Optional Fields" %}
+<!-- group id="optional_fields" title="Optional Fields" -->
 
-{% field kind="string" id="notes" label="Notes" role="user" state="skipped" %}
+<!-- field kind="string" id="notes" role="user" label="Notes" state="skipped" -->
 ```value
 %SKIP% (No notes required)
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="notes" %}
+<!-- instructions ref="notes" -->
 Add any relevant notes or observations (optional).
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="number" id="optional_number" label="Optional Number" role="user" state="skipped" %}{% /field %}
+<!-- field kind="number" id="optional_number" role="user" label="Optional Number" state="skipped" --><!-- /field -->
 
-{% field kind="url" id="related_url" label="Related URL" role="user" state="skipped" %}
+<!-- field kind="url" id="related_url" role="user" label="Related URL" state="skipped" -->
 ```value
 %SKIP% (No related URL needed)
 ```
-{% /field %}
+<!-- /field -->
 
-{% instructions ref="related_url" %}
+<!-- instructions ref="related_url" -->
 Optionally add a URL to related documentation or resources.
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="date" id="optional_date" label="Optional Date" role="user" state="skipped" %}{% /field %}
+<!-- field kind="date" id="optional_date" role="user" label="Optional Date" state="skipped" --><!-- /field -->
 
-{% instructions ref="optional_date" %}
+<!-- instructions ref="optional_date" -->
 Optionally add a date (YYYY-MM-DD format).
-{% /instructions %}
+<!-- /instructions -->
 
-{% field kind="year" id="optional_year" label="Optional Year" role="user" state="skipped" %}{% /field %}
+<!-- field kind="year" id="optional_year" role="user" label="Optional Year" state="skipped" --><!-- /field -->
 
-{% instructions ref="optional_year" %}
+<!-- instructions ref="optional_year" -->
 Optionally add a year.
-{% /instructions %}
+<!-- /instructions -->
+
+<!-- /group -->
+
+<!-- note id="note-summary" role="user" ref="simple_test" -->
+All required fields completed successfully.Optional fields skipped.
+<!-- /note -->
+
+<!-- /form -->
 
-{% /group %}
 
-{% note id="note-summary" ref="simple_test" role="user" %}
-All required fields completed successfully.
-Optional fields skipped.
-{% /note %}
 
-{% /form %}

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

@@ -19,7 +19,7 @@ test@example.com
 
 **Score:**
 
-_(empty)_
+_(skipped: Not needed for this test)_
 
 ## List Fields
 
@@ -84,30 +84,30 @@ High
 
 **Team Members:**
 
-_(empty)_
+_(skipped)_
 
 **Project Tasks:**
 
-_(empty)_
+_(skipped)_
 
 ## Optional Fields
 
 **Notes:**
 
-_(empty)_
+_(skipped: No notes required)_
 
 **Optional Number:**
 
-_(empty)_
+_(skipped)_
 
 **Related URL:**
 
-_(empty)_
+_(skipped: No related URL needed)_
 
 **Optional Date:**
 
-_(empty)_
+_(skipped)_
 
 **Optional Year:**
 
-_(empty)_
+_(skipped)_

package/examples/simple/simple-skipped-filled.schema.json

@@ -387,10 +387,9 @@
   ],
   "x-markform": {
     "spec": "MF/0.1",
-    "roles": ["user", "agent"],
+    "roles": ["user"],
     "roleInstructions": {
-      "user": "Fill in the fields you have direct knowledge of.",
-      "agent": "Complete the remaining fields based on the provided context."
+      "user": "Fill in all fields in this form."
     },
     "groups": [
       {

package/examples/simple/simple-tags-syntax.form.md

@@ -0,0 +1,32 @@
+---
+markform:
+  spec: MF/0.1
+  title: Simple Form (Tags Syntax)
+  description: "Same as simple.form.md but using Markdoc tag syntax for testing purposes."
+  run_mode: interactive
+  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 simple form demonstrating Markdoc tag syntax.
+This file is used for testing the --syntax=tags validation option.
+{% /description %}
+
+{% group id="basic_fields" title="Basic Fields" %}
+
+{% field kind="string" id="name" role="user" examples=["John Smith", "Jane Doe"] label="Name" maxLength=50 minLength=2 placeholder="Enter your name" required=true %}{% /field %}
+
+{% instructions ref="name" %}
+Enter your full name as you want it to appear.
+{% /instructions %}
+
+{% field kind="string" id="email" role="user" label="Email" pattern="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$" placeholder="user@example.com" required=true %}{% /field %}
+
+{% /group %}
+
+{% /form %}