@agentshouse/mdmodel 0.1.0-alpha.1 → 0.1.0-alpha.10

package/fixtures/division.json

@@ -0,0 +1,415 @@
+{
+  "definitions": {
+    "task": "---\ntype: definition\nfields:\n  name: { kind: text }\n  status: { kind: enum, values: [open, done], required: true }\nsections:\n  Description: { kind: text, required: true }\n  Acceptance: { kind: list, of: reference, to: person }\n---\n",
+    "unreadable-task": "---\ntype: definition\nsections:\n  Description: { kind: prose }\n---\n"
+  },
+  "cases": [
+    {
+      "name": "a Document whose whole input fits the budget is one Span carrying its projection",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Acceptance\n\n- people/ana.md\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 4096,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Ship the release\n\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n",
+            "source": "Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "an input over the budget descends to whole heading nodes and packs adjacent siblings",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Notes\n\nNotes prose.\n\n## Acceptance\n\n- people/ana.md\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 45,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Ship the release\n\n\nPreamble prose.\n\n",
+            "source": "Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n"
+          },
+          {
+            "text": "## Description\n\nBody of the description.\n\n",
+            "source": "## Description\n\nBody of the description.\n\n"
+          },
+          {
+            "text": "## Notes\n\nNotes prose.\n\n",
+            "source": "## Notes\n\nNotes prose.\n\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a heading node over the budget divides into adjacent blocks carrying its own heading",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nFirst paragraph of the overview.\n\nSecond paragraph of the overview.\n\n## Notes\n\nShort note.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 50,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\nFirst paragraph of the overview.\n\n",
+            "source": "## Overview\n\nFirst paragraph of the overview.\n\n"
+          },
+          {
+            "text": "## Overview\n\nSecond paragraph of the overview.\n\n",
+            "source": "Second paragraph of the overview.\n\n"
+          },
+          {
+            "text": "## Notes\n\nShort note.\n",
+            "source": "## Notes\n\nShort note.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a node continuation and the next whole sibling stay in their own Spans",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nFirst paragraph of the overview.\n\nSecond paragraph of the overview.\n\n## Notes\n\nShort note.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 75,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\nFirst paragraph of the overview.\n\n",
+            "source": "## Overview\n\nFirst paragraph of the overview.\n\n"
+          },
+          {
+            "text": "## Overview\n\nSecond paragraph of the overview.\n\n",
+            "source": "Second paragraph of the overview.\n\n"
+          },
+          {
+            "text": "## Notes\n\nShort note.\n",
+            "source": "## Notes\n\nShort note.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a continuation Span carries its own node heading and never an ancestor heading",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nIntro line.\n\n### Detail\n\nDetail paragraph one.\n\nDetail paragraph two.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 40,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\nIntro line.\n\n",
+            "source": "## Overview\n\nIntro line.\n\n"
+          },
+          {
+            "text": "### Detail\n\nDetail paragraph one.\n\n",
+            "source": "### Detail\n\nDetail paragraph one.\n\n"
+          },
+          {
+            "text": "### Detail\n\nDetail paragraph two.\n",
+            "source": "Detail paragraph two.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a block over the budget divides into sentences that repeat their predecessor",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nOne. Two. Three. Four.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 30,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\nOne. Two. Three. ",
+            "source": "## Overview\n\nOne. Two. Three. "
+          },
+          {
+            "text": "## Overview\n\nThree. Four.\n",
+            "source": "Three. Four.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a single sentence over the budget divides at a bound cut inside it",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\naaaa bbbb cccc dddd eeee\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 20,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\naaaa",
+            "source": "## Overview\n\naaaa"
+          },
+          {
+            "text": "## Overview\n\n bbbb",
+            "source": " bbbb"
+          },
+          {
+            "text": "## Overview\n\n cccc",
+            "source": " cccc"
+          },
+          {
+            "text": "## Overview\n\n dddd",
+            "source": " dddd"
+          },
+          {
+            "text": "## Overview\n\n eeee\n",
+            "source": " eeee\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "an untyped input with no definition descends the same ladder",
+      "file": "notes/one.md",
+      "source": "# Title\n\nIntro paragraph about the whole thing.\n\n## Alpha\n\nAlpha one. Alpha two.\n\n### Deep\n\nDeep prose here.\n\n## Beta\n\nBeta prose.\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 60,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "# Title\n\nIntro paragraph about the whole thing.\n\n",
+            "source": "# Title\n\nIntro paragraph about the whole thing.\n\n"
+          },
+          {
+            "text": "## Alpha\n\nAlpha one. Alpha two.\n\n",
+            "source": "## Alpha\n\nAlpha one. Alpha two.\n\n"
+          },
+          {
+            "text": "### Deep\n\nDeep prose here.\n\n",
+            "source": "### Deep\n\nDeep prose here.\n\n"
+          },
+          {
+            "text": "## Beta\n\nBeta prose.\n",
+            "source": "## Beta\n\nBeta prose.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a Document that declares the built-in any type divides its body after the fence",
+      "file": "notes/two.md",
+      "source": "---\ntype: any\ntitle: Note\n---\n\n## Notes\n\nRead it.\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 4096,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "\n## Notes\n\nRead it.\n",
+            "source": "\n## Notes\n\nRead it.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "an internal link embeds its label and addresses the destination the author wrote",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\n## Overview\n\nRead [the plan](../plans/q3.md) before starting.\n\n## Notes\n\nShort note.\n",
+      "documentTargets": [
+        "plans/q3.md"
+      ],
+      "definition": "task",
+      "budget": 50,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\n",
+            "source": "Task\nstatus: open\n---\n\n"
+          },
+          {
+            "text": "## Overview\n\nRead the plan before starting.\n\n",
+            "source": "## Overview\n\nRead [the plan](../plans/q3.md) before starting.\n\n"
+          },
+          {
+            "text": "## Notes\n\nShort note.\n",
+            "source": "## Notes\n\nShort note.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a declared structured section stays outside the text and inside the extent",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Task\nstatus: open\n---\n\nPreamble prose.\n\n## Acceptance\n\n- people/ana.md\n\n## Notes\n\nShort note.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 4096,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Task\n\n\nPreamble prose.\n\n## Notes\n\nShort note.\n",
+            "source": "Task\nstatus: open\n---\n\nPreamble prose.\n\n## Acceptance\n\n- people/ana.md\n\n## Notes\n\nShort note.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a Document that declares a type the caller supplies no definition for is refused",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Acceptance\n\n- people/ana.md\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 4096,
+      "expected": {
+        "ok": false,
+        "refusal": {
+          "file": "tasks/one.md",
+          "rule": "unknown-type",
+          "version": "<package-version>",
+          "location": "type"
+        }
+      }
+    },
+    {
+      "name": "a definition the model cannot read is refused at that definition",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: Ship the release\nstatus: open\n---\n\nPreamble prose.\n\n## Description\n\nBody of the description.\n\n## Acceptance\n\n- people/ana.md\n",
+      "documentTargets": [],
+      "definition": "unreadable-task",
+      "budget": 4096,
+      "expected": {
+        "ok": false,
+        "refusal": {
+          "file": "types/task.md",
+          "rule": "definition-section-kind",
+          "version": "<package-version>",
+          "location": "Description"
+        }
+      }
+    },
+    {
+      "name": "a free-text value the author quoted embeds bare and addresses the quotes it was written with",
+      "file": "tasks/one.md",
+      "source": "---\ntype: task\nname: \"Ship: the release\"\nstatus: open\n---\n\nBody prose.\n",
+      "documentTargets": [],
+      "definition": "task",
+      "budget": 4096,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "Ship: the release\n\n\nBody prose.\n",
+            "source": "\"Ship: the release\"\nstatus: open\n---\n\nBody prose.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "sentence division reads every terminator and closer and drops a carry the budget cannot hold",
+      "file": "notes/three.md",
+      "source": "## Ask\n\nReady? Go! He said \"no.\" Then (silence.) Done.\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 30,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "## Ask\n\nReady? Go! ",
+            "source": "## Ask\n\nReady? Go! "
+          },
+          {
+            "text": "## Ask\n\nGo! He said \"no.\" ",
+            "source": "Go! He said \"no.\" "
+          },
+          {
+            "text": "## Ask\n\nThen (silence.) Done.\n",
+            "source": "Then (silence.) Done.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a heading with no body of its own leads the first child node instead of standing alone",
+      "file": "notes/four.md",
+      "source": "## Part\n\n### Alpha\n\nAlpha prose that is long enough to matter.\n\n### Beta\n\nBeta prose.\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 70,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "## Part\n\n### Alpha\n\nAlpha prose that is long enough to matter.\n\n",
+            "source": "## Part\n\n### Alpha\n\nAlpha prose that is long enough to matter.\n\n"
+          },
+          {
+            "text": "### Beta\n\nBeta prose.\n",
+            "source": "### Beta\n\nBeta prose.\n"
+          }
+        ]
+      }
+    },
+    {
+      "name": "a heading the budget cannot hold beside any text is not repeated",
+      "file": "notes/five.md",
+      "source": "## An overview of the release\n\nFirst paragraph here.\n\nSecond paragraph here.\n",
+      "documentTargets": [],
+      "definition": null,
+      "budget": 25,
+      "expected": {
+        "ok": true,
+        "spans": [
+          {
+            "text": "## An overview of the",
+            "source": "## An overview of the"
+          },
+          {
+            "text": " release\n\nFirst paragraph",
+            "source": " release\n\nFirst paragraph"
+          },
+          {
+            "text": " here.\n\n",
+            "source": " here.\n\n"
+          },
+          {
+            "text": "Second paragraph here.\n",
+            "source": "Second paragraph here.\n"
+          }
+        ]
+      }
+    }
+  ]
+}

package/fixtures/preamble.json

@@ -0,0 +1,107 @@
+[
+  {
+    "name": "CRLF frontmatter and H2 closing syntax",
+    "source": "---\r\ntype: note\r\ntitle: \"Kept\" # syntax\r\n---\r\n\r\n# Title\r\nIntro.\r\n\r\n## Body ###\r\nKept.\r\n",
+    "preamble": "\r\n# Title\r\nIntro.\r\n\r\n",
+    "value": "\r\nNew intro.\r\n\r\n",
+    "expected": "---\r\ntype: note\r\ntitle: \"Kept\" # syntax\r\n---\r\n\r\nNew intro.\r\n\r\n## Body ###\r\nKept.\r\n"
+  },
+  {
+    "name": "untyped document without sections",
+    "source": "# Title\nAll body text.",
+    "preamble": "# Title\nAll body text.",
+    "value": "Replaced without final newline.",
+    "expected": "Replaced without final newline."
+  },
+  {
+    "name": "typed document without sections",
+    "source": "---\ntype: note\n---\n# Title\nAll body text.",
+    "preamble": "# Title\nAll body text.",
+    "value": "New body.\n",
+    "expected": "---\ntype: note\n---\nNew body.\n"
+  },
+  {
+    "name": "empty document",
+    "source": "",
+    "preamble": "",
+    "value": "First text.\n",
+    "expected": "First text.\n"
+  },
+  {
+    "name": "frontmatter only",
+    "source": "---\ntype: note\n---\n",
+    "preamble": "",
+    "value": "First text.\n",
+    "expected": "---\ntype: note\n---\nFirst text.\n"
+  },
+  {
+    "name": "frontmatter delimiter at EOF",
+    "source": "---\ntype: note\n---",
+    "preamble": "",
+    "value": "\nFirst text.",
+    "expected": "---\ntype: note\n---\nFirst text."
+  },
+  {
+    "name": "section starts at offset zero",
+    "source": "## Body\nKept.\n",
+    "preamble": "",
+    "value": "Intro.\n\n",
+    "expected": "Intro.\n\n## Body\nKept.\n"
+  },
+  {
+    "name": "section immediately after frontmatter",
+    "source": "---\ntype: note\n---\n## Body\nKept.\n",
+    "preamble": "",
+    "value": "Intro.\n",
+    "expected": "---\ntype: note\n---\nIntro.\n## Body\nKept.\n"
+  },
+  {
+    "name": "backtick fence hides a heading",
+    "source": "```md\n## Example\n```\n\n## Body\nKept.\n",
+    "preamble": "```md\n## Example\n```\n\n",
+    "value": "Example removed.\n",
+    "expected": "Example removed.\n## Body\nKept.\n"
+  },
+  {
+    "name": "tilde fence hides a heading",
+    "source": "  ~~~md\n## Example\n  ~~~\n\n## Body\nKept.",
+    "preamble": "  ~~~md\n## Example\n  ~~~\n\n",
+    "value": "Example removed.\n",
+    "expected": "Example removed.\n## Body\nKept."
+  },
+  {
+    "name": "unclosed fence carries the entire body",
+    "source": "---\ntype: note\n---\n```\n## Example\n",
+    "preamble": "```\n## Example\n",
+    "value": "Plain replacement.\n",
+    "expected": "---\ntype: note\n---\nPlain replacement.\n"
+  },
+  {
+    "name": "existing section parser ignores other heading forms",
+    "source": "# Title\n### Subheading\n> ## Quoted\n    ## Indented\nSetext\n------\n\n## Actual ##\nKept.\n",
+    "preamble": "# Title\n### Subheading\n> ## Quoted\n    ## Indented\nSetext\n------\n\n",
+    "value": "Intro.\n",
+    "expected": "Intro.\n## Actual ##\nKept.\n"
+  },
+  {
+    "name": "Unicode and mixed newlines",
+    "source": "---\r\ntype: note\r\n---\r\n🙂 Вступ\r\n\n## Body\nKept.\r\n",
+    "preamble": "🙂 Вступ\r\n\n",
+    "value": "Новий 🙂\n\n",
+    "expected": "---\r\ntype: note\r\n---\r\nНовий 🙂\n\n## Body\nKept.\r\n"
+  },
+  {
+    "name": "heading at EOF and empty replacement",
+    "source": "Intro.\n\n## Body",
+    "preamble": "Intro.\n\n",
+    "value": "",
+    "expected": "## Body"
+  },
+  {
+    "name": "Runtime moved export link",
+    "source": "---\ntype: note\ntitle: Filed note\n---\n\nFiled beside [the export](../data/export.csv).\n\n## Body\n\nThe destination above sits outside every section.\n",
+    "preamble": "\nFiled beside [the export](../data/export.csv).\n\n",
+    "value": "\nFiled beside [the export](../files/export.csv).\n\n",
+    "expected": "---\ntype: note\ntitle: Filed note\n---\n\nFiled beside [the export](../files/export.csv).\n\n## Body\n\nThe destination above sits outside every section.\n"
+  }
+]