markdown-structure-checker 0.1.0

package/README.md

@@ -0,0 +1,250 @@
+# markdown-structure-checker
+
+[![npm version](https://img.shields.io/npm/v/markdown-structure-checker.svg)](https://www.npmjs.com/package/markdown-structure-checker)
+![build status](https://img.shields.io/badge/build-passing-lightgrey)
+[![license: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+
+`markdown-structure-checker` is a minimal TypeScript tool that validates the **structural outline** of Markdown files against a user-provided JSON Schema.
+
+It extracts heading hierarchy (H1-H6), normalizes heading text, produces a deterministic internal representation (`StructureJSON`), and validates it with AJV.
+
+## What It Does
+
+- Extracts Markdown headings (`#` through `######`) from a file.
+- Strips YAML front matter before parsing.
+- Builds nested heading structure based on heading depth.
+- Normalizes heading text:
+  - trims surrounding whitespace
+  - collapses repeated spaces
+  - includes only `text` and `inlineCode` content
+- Validates extracted structure against your JSON Schema.
+- Provides a CLI with predictable exit codes for CI usage.
+
+## What It Does Not Do (v0.1 Scope)
+
+- Does not validate prose/content semantics.
+- Does not auto-fix documents.
+- Does not validate non-heading blocks (lists, tables, paragraphs, etc.).
+- Does not provide plugin/config file systems.
+
+## Installation
+
+```bash
+npm install markdown-structure-checker
+```
+
+Or run without installing globally:
+
+```bash
+npx markdown-structure-checker --file ./doc.md --schema ./schema.json
+```
+
+## CLI Usage
+
+```bash
+markdown-structure-checker --file <path> --schema <schemaPath> [--print-ir] [--verbose]
+```
+
+### Flags
+
+- `--file <path>`: Markdown file to validate.
+- `--schema <schemaPath>`: JSON Schema used to validate extracted structure.
+- `--print-ir`: Print extracted `StructureJSON` to stdout.
+- `--verbose`: Print success message on pass.
+
+### Example
+
+```bash
+markdown-structure-checker \
+  --file ./examples/incident.md \
+  --schema ./examples/incident-structure.schema.json \
+  --print-ir \
+  --verbose
+```
+
+Example output (pass):
+
+```json
+{
+  "headings": [
+    { "depth": 2, "text": "Summary" },
+    { "depth": 2, "text": "Steps to Reproduce" },
+    { "depth": 2, "text": "Expected Behavior" },
+    { "depth": 2, "text": "Actual Behavior" },
+    { "depth": 2, "text": "Impact" },
+    { "depth": 2, "text": "Workarounds" },
+    {
+      "depth": 2,
+      "text": "Vendor Response Timeline",
+      "children": [{ "depth": 3, "text": "2026-02-20" }]
+    }
+  ]
+}
+```
+
+```text
+Validation passed.
+```
+
+Example output (fail):
+
+```text
+Validation failed:
+- /headings/2/text must be equal to constant
+```
+
+## StructureJSON Format
+
+`extractStructure()` produces:
+
+```json
+{
+  "headings": [
+    {
+      "depth": 2,
+      "text": "Summary",
+      "children": [
+        {
+          "depth": 3,
+          "text": "Details"
+        }
+      ]
+    }
+  ]
+}
+```
+
+Shape:
+
+```ts
+interface StructureJSON {
+  headings: HeadingNode[];
+}
+
+interface HeadingNode {
+  depth: number; // 1..6
+  text: string;
+  children?: HeadingNode[];
+}
+```
+
+## Example JSON Schema (Required H2 Sequence)
+
+This schema enforces exact H2 order and disallows extra top-level headings.
+
+```json
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "required": ["headings"],
+  "properties": {
+    "headings": {
+      "type": "array",
+      "prefixItems": [
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Summary" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Steps to Reproduce" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Expected Behavior" }
+          }
+        }
+      ],
+      "items": false
+    }
+  }
+}
+```
+
+A full example is included at `examples/incident-structure.schema.json`.
+
+## Exit Codes
+
+- `0`: Validation passed.
+- `1`: Validation failed (schema mismatch).
+- `2`: Usage or runtime error (invalid args, file read failure, JSON parse error, etc.).
+
+## API Usage
+
+```ts
+import {
+  extractStructure,
+  validateStructure,
+  validateMarkdownFile,
+  type StructureJSON,
+  type ValidationResult,
+} from "markdown-structure-checker";
+```
+
+### Exports
+
+```ts
+extractStructure(markdown: string): StructureJSON
+validateStructure(structure: StructureJSON, schema: object): { ok: boolean; errors?: any[] }
+validateMarkdownFile(filePath: string, schemaPath: string): { ok: boolean; errors?: any[] }
+```
+
+### Minimal example
+
+```ts
+import { extractStructure, validateStructure } from "markdown-structure-checker";
+
+const markdown = "## Summary\n## Steps to Reproduce";
+const schema = {
+  type: "object",
+  required: ["headings"],
+  properties: {
+    headings: {
+      type: "array",
+      minItems: 2,
+    },
+  },
+};
+
+const structure = extractStructure(markdown);
+const result = validateStructure(structure, schema);
+
+if (!result.ok) {
+  console.error(result.errors);
+}
+```
+
+## Roadmap
+
+Near-term improvements after v0.1:
+
+- Better CLI formatting for AJV errors (grouped/context-rich output).
+- Optional schema helper templates for common document formats.
+- Additional deterministic normalization edge-case coverage.
+- Performance benchmarking for large Markdown documents.
+
+## Contributing
+
+Contributions are welcome. For local validation:
+
+```bash
+npm test
+npm run build
+```
+
+Please include tests for behavioral changes, especially extractor and CLI exit code behavior.
+
+## License
+
+MIT. See `LICENSE`.

package/dist/cli.d.mts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+declare function runCli(argv: string[]): Promise<number>;
+
+export { runCli };

package/dist/cli.d.ts

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+declare function runCli(argv: string[]): Promise<number>;
+
+export { runCli };

package/dist/cli.js

@@ -0,0 +1,178 @@
+#!/usr/bin/env node
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/cli.ts
+var cli_exports = {};
+__export(cli_exports, {
+  runCli: () => runCli
+});
+module.exports = __toCommonJS(cli_exports);
+var import_node_fs2 = __toESM(require("fs"));
+var import_commander = require("commander");
+
+// src/extract.ts
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_unified = require("unified");
+var import_remark_parse = __toESM(require("remark-parse"));
+function normalizeText(text) {
+  return text.trim().replace(/\s+/g, " ");
+}
+function extractInlineText(node) {
+  if (!node || typeof node !== "object") {
+    return "";
+  }
+  if (node.type === "text" || node.type === "inlineCode") {
+    return node.value ?? "";
+  }
+  if (!Array.isArray(node.children)) {
+    return "";
+  }
+  return node.children.map(extractInlineText).join("");
+}
+function collectHeadings(node, acc = []) {
+  if (!node || typeof node !== "object") {
+    return acc;
+  }
+  if (node.type === "heading" && typeof node.depth === "number") {
+    acc.push(node);
+  }
+  if (Array.isArray(node.children)) {
+    for (const child of node.children) {
+      collectHeadings(child, acc);
+    }
+  }
+  return acc;
+}
+function extractStructure(markdown) {
+  const { content } = (0, import_gray_matter.default)(markdown);
+  const tree = (0, import_unified.unified)().use(import_remark_parse.default).parse(content);
+  const headingNodes = collectHeadings(tree);
+  const headings = [];
+  const stack = [];
+  for (const heading of headingNodes) {
+    const depth = heading.depth;
+    if (typeof depth !== "number" || depth < 1 || depth > 6) {
+      continue;
+    }
+    const text = normalizeText(extractInlineText(heading));
+    const current = { depth, text };
+    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {
+      stack.pop();
+    }
+    const parent = stack[stack.length - 1];
+    if (parent) {
+      parent.children ??= [];
+      parent.children.push(current);
+    } else {
+      headings.push(current);
+    }
+    stack.push(current);
+  }
+  return { headings };
+}
+
+// src/validate.ts
+var import_node_fs = __toESM(require("fs"));
+var import__ = __toESM(require("ajv/dist/2020"));
+function validateStructure(structure, schema) {
+  const ajv = new import__.default({ allErrors: true, strict: false });
+  const validate = ajv.compile(schema);
+  const ok = validate(structure);
+  if (ok) {
+    return { ok: true };
+  }
+  return { ok: false, errors: validate.errors ?? [] };
+}
+function validateMarkdownFile(filePath, schemaPath) {
+  const markdown = import_node_fs.default.readFileSync(filePath, "utf8");
+  const schemaRaw = import_node_fs.default.readFileSync(schemaPath, "utf8");
+  const schema = JSON.parse(schemaRaw);
+  const structure = extractStructure(markdown);
+  return validateStructure(structure, schema);
+}
+
+// src/cli.ts
+function formatErrors(errors) {
+  if (!errors || errors.length === 0) {
+    return "Validation failed.";
+  }
+  return errors.map((err) => {
+    const path = err.instancePath && err.instancePath.length > 0 ? err.instancePath : "/";
+    return `- ${path} ${err.message ?? "validation error"}`;
+  }).join("\n");
+}
+async function runCli(argv) {
+  const program = new import_commander.Command();
+  program.name("markdown-structure-checker").requiredOption("--file <path>", "Path to markdown file").requiredOption("--schema <path>", "Path to JSON Schema file").option("--print-ir", "Print extracted StructureJSON").option("--verbose", "Print extra output").exitOverride();
+  let opts;
+  try {
+    program.parse(argv, { from: "user" });
+    opts = program.opts();
+  } catch (error) {
+    if (error?.code === "commander.helpDisplayed") {
+      return 0;
+    }
+    if (error?.message) {
+      console.error(error.message);
+    }
+    return 2;
+  }
+  try {
+    if (opts.printIr) {
+      const markdown = import_node_fs2.default.readFileSync(opts.file, "utf8");
+      const structure = extractStructure(markdown);
+      console.log(JSON.stringify(structure, null, 2));
+    }
+    const result = validateMarkdownFile(opts.file, opts.schema);
+    if (result.ok) {
+      if (opts.verbose) {
+        console.log("Validation passed.");
+      }
+      return 0;
+    }
+    console.error("Validation failed:");
+    console.error(formatErrors(result.errors));
+    return 1;
+  } catch (error) {
+    console.error(error?.message ?? "Runtime error");
+    return 2;
+  }
+}
+var isDirectRun = typeof require !== "undefined" && require.main === module;
+if (isDirectRun) {
+  runCli(process.argv.slice(2)).then((code) => {
+    process.exit(code);
+  });
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  runCli
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/cli.ts","../src/extract.ts","../src/validate.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport { Command } from \"commander\";\nimport { extractStructure, validateMarkdownFile } from \"./index\";\n\nfunction formatErrors(errors: any[] | undefined): string {\n  if (!errors || errors.length === 0) {\n    return \"Validation failed.\";\n  }\n\n  return errors\n    .map((err) => {\n      const path = err.instancePath && err.instancePath.length > 0 ? err.instancePath : \"/\";\n      return `- ${path} ${err.message ?? \"validation error\"}`;\n    })\n    .join(\"\\n\");\n}\n\nexport async function runCli(argv: string[]): Promise<number> {\n  const program = new Command();\n\n  program\n    .name(\"markdown-structure-checker\")\n    .requiredOption(\"--file <path>\", \"Path to markdown file\")\n    .requiredOption(\"--schema <path>\", \"Path to JSON Schema file\")\n    .option(\"--print-ir\", \"Print extracted StructureJSON\")\n    .option(\"--verbose\", \"Print extra output\")\n    .exitOverride();\n\n  let opts: {\n    file: string;\n    schema: string;\n    printIr?: boolean;\n    verbose?: boolean;\n  };\n\n  try {\n    program.parse(argv, { from: \"user\" });\n    opts = program.opts();\n  } catch (error: any) {\n    if (error?.code === \"commander.helpDisplayed\") {\n      return 0;\n    }\n\n    if (error?.message) {\n      console.error(error.message);\n    }\n    return 2;\n  }\n\n  try {\n    if (opts.printIr) {\n      const markdown = fs.readFileSync(opts.file, \"utf8\");\n      const structure = extractStructure(markdown);\n      console.log(JSON.stringify(structure, null, 2));\n    }\n\n    const result = validateMarkdownFile(opts.file, opts.schema);\n\n    if (result.ok) {\n      if (opts.verbose) {\n        console.log(\"Validation passed.\");\n      }\n      return 0;\n    }\n\n    console.error(\"Validation failed:\");\n    console.error(formatErrors(result.errors));\n    return 1;\n  } catch (error: any) {\n    console.error(error?.message ?? \"Runtime error\");\n    return 2;\n  }\n}\n\nconst isDirectRun = typeof require !== \"undefined\" && require.main === module;\n\nif (isDirectRun) {\n  runCli(process.argv.slice(2)).then((code) => {\n    process.exit(code);\n  });\n}\n","import matter from \"gray-matter\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport type { HeadingNode, StructureJSON } from \"./types\";\n\ninterface MdastNode {\n  type?: string;\n  value?: string;\n  depth?: number;\n  children?: MdastNode[];\n}\n\nfunction normalizeText(text: string): string {\n  return text.trim().replace(/\\s+/g, \" \");\n}\n\nfunction extractInlineText(node: MdastNode): string {\n  if (!node || typeof node !== \"object\") {\n    return \"\";\n  }\n\n  if (node.type === \"text\" || node.type === \"inlineCode\") {\n    return node.value ?? \"\";\n  }\n\n  if (!Array.isArray(node.children)) {\n    return \"\";\n  }\n\n  return node.children.map(extractInlineText).join(\"\");\n}\n\nfunction collectHeadings(node: MdastNode, acc: MdastNode[] = []): MdastNode[] {\n  if (!node || typeof node !== \"object\") {\n    return acc;\n  }\n\n  if (node.type === \"heading\" && typeof node.depth === \"number\") {\n    acc.push(node);\n  }\n\n  if (Array.isArray(node.children)) {\n    for (const child of node.children) {\n      collectHeadings(child, acc);\n    }\n  }\n\n  return acc;\n}\n\nexport function extractStructure(markdown: string): StructureJSON {\n  const { content } = matter(markdown);\n  const tree = unified().use(remarkParse).parse(content) as MdastNode;\n  const headingNodes = collectHeadings(tree);\n\n  const headings: HeadingNode[] = [];\n  const stack: HeadingNode[] = [];\n\n  for (const heading of headingNodes) {\n    const depth = heading.depth;\n    if (typeof depth !== \"number\" || depth < 1 || depth > 6) {\n      continue;\n    }\n\n    const text = normalizeText(extractInlineText(heading));\n    const current: HeadingNode = { depth, text };\n\n    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {\n      stack.pop();\n    }\n\n    const parent = stack[stack.length - 1];\n    if (parent) {\n      parent.children ??= [];\n      parent.children.push(current);\n    } else {\n      headings.push(current);\n    }\n\n    stack.push(current);\n  }\n\n  return { headings };\n}\n","import fs from \"node:fs\";\nimport Ajv2020 from \"ajv/dist/2020\";\nimport { extractStructure } from \"./extract\";\nimport type { StructureJSON, ValidationResult } from \"./types\";\n\nexport function validateStructure(structure: StructureJSON, schema: object): ValidationResult {\n  const ajv = new Ajv2020({ allErrors: true, strict: false });\n  const validate = ajv.compile(schema);\n  const ok = validate(structure) as boolean;\n\n  if (ok) {\n    return { ok: true };\n  }\n\n  return { ok: false, errors: validate.errors ?? [] };\n}\n\nexport function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult {\n  const markdown = fs.readFileSync(filePath, \"utf8\");\n  const schemaRaw = fs.readFileSync(schemaPath, \"utf8\");\n  const schema = JSON.parse(schemaRaw) as object;\n\n  const structure = extractStructure(markdown);\n  return validateStructure(structure, schema);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AACA,IAAAA,kBAAe;AACf,uBAAwB;;;ACFxB,yBAAmB;AACnB,qBAAwB;AACxB,0BAAwB;AAUxB,SAAS,cAAc,MAAsB;AAC3C,SAAO,KAAK,KAAK,EAAE,QAAQ,QAAQ,GAAG;AACxC;AAEA,SAAS,kBAAkB,MAAyB;AAClD,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,UAAU,KAAK,SAAS,cAAc;AACtD,WAAO,KAAK,SAAS;AAAA,EACvB;AAEA,MAAI,CAAC,MAAM,QAAQ,KAAK,QAAQ,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,SAAS,IAAI,iBAAiB,EAAE,KAAK,EAAE;AACrD;AAEA,SAAS,gBAAgB,MAAiB,MAAmB,CAAC,GAAgB;AAC5E,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,aAAa,OAAO,KAAK,UAAU,UAAU;AAC7D,QAAI,KAAK,IAAI;AAAA,EACf;AAEA,MAAI,MAAM,QAAQ,KAAK,QAAQ,GAAG;AAChC,eAAW,SAAS,KAAK,UAAU;AACjC,sBAAgB,OAAO,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,SAAO;AACT;AAEO,SAAS,iBAAiB,UAAiC;AAChE,QAAM,EAAE,QAAQ,QAAI,mBAAAC,SAAO,QAAQ;AACnC,QAAM,WAAO,wBAAQ,EAAE,IAAI,oBAAAC,OAAW,EAAE,MAAM,OAAO;AACrD,QAAM,eAAe,gBAAgB,IAAI;AAEzC,QAAM,WAA0B,CAAC;AACjC,QAAM,QAAuB,CAAC;AAE9B,aAAW,WAAW,cAAc;AAClC,UAAM,QAAQ,QAAQ;AACtB,QAAI,OAAO,UAAU,YAAY,QAAQ,KAAK,QAAQ,GAAG;AACvD;AAAA,IACF;AAEA,UAAM,OAAO,cAAc,kBAAkB,OAAO,CAAC;AACrD,UAAM,UAAuB,EAAE,OAAO,KAAK;AAE3C,WAAO,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,OAAO;AACjE,YAAM,IAAI;AAAA,IACZ;AAEA,UAAM,SAAS,MAAM,MAAM,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,CAAC;AACrB,aAAO,SAAS,KAAK,OAAO;AAAA,IAC9B,OAAO;AACL,eAAS,KAAK,OAAO;AAAA,IACvB;AAEA,UAAM,KAAK,OAAO;AAAA,EACpB;AAEA,SAAO,EAAE,SAAS;AACpB;;;ACnFA,qBAAe;AACf,eAAoB;AAIb,SAAS,kBAAkB,WAA0B,QAAkC;AAC5F,QAAM,MAAM,IAAI,SAAAC,QAAQ,EAAE,WAAW,MAAM,QAAQ,MAAM,CAAC;AAC1D,QAAM,WAAW,IAAI,QAAQ,MAAM;AACnC,QAAM,KAAK,SAAS,SAAS;AAE7B,MAAI,IAAI;AACN,WAAO,EAAE,IAAI,KAAK;AAAA,EACpB;AAEA,SAAO,EAAE,IAAI,OAAO,QAAQ,SAAS,UAAU,CAAC,EAAE;AACpD;AAEO,SAAS,qBAAqB,UAAkB,YAAsC;AAC3F,QAAM,WAAW,eAAAC,QAAG,aAAa,UAAU,MAAM;AACjD,QAAM,YAAY,eAAAA,QAAG,aAAa,YAAY,MAAM;AACpD,QAAM,SAAS,KAAK,MAAM,SAAS;AAEnC,QAAM,YAAY,iBAAiB,QAAQ;AAC3C,SAAO,kBAAkB,WAAW,MAAM;AAC5C;;;AFnBA,SAAS,aAAa,QAAmC;AACvD,MAAI,CAAC,UAAU,OAAO,WAAW,GAAG;AAClC,WAAO;AAAA,EACT;AAEA,SAAO,OACJ,IAAI,CAAC,QAAQ;AACZ,UAAM,OAAO,IAAI,gBAAgB,IAAI,aAAa,SAAS,IAAI,IAAI,eAAe;AAClF,WAAO,KAAK,IAAI,IAAI,IAAI,WAAW,kBAAkB;AAAA,EACvD,CAAC,EACA,KAAK,IAAI;AACd;AAEA,eAAsB,OAAO,MAAiC;AAC5D,QAAM,UAAU,IAAI,yBAAQ;AAE5B,UACG,KAAK,4BAA4B,EACjC,eAAe,iBAAiB,uBAAuB,EACvD,eAAe,mBAAmB,0BAA0B,EAC5D,OAAO,cAAc,+BAA+B,EACpD,OAAO,aAAa,oBAAoB,EACxC,aAAa;AAEhB,MAAI;AAOJ,MAAI;AACF,YAAQ,MAAM,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,WAAO,QAAQ,KAAK;AAAA,EACtB,SAAS,OAAY;AACnB,QAAI,OAAO,SAAS,2BAA2B;AAC7C,aAAO;AAAA,IACT;AAEA,QAAI,OAAO,SAAS;AAClB,cAAQ,MAAM,MAAM,OAAO;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAEA,MAAI;AACF,QAAI,KAAK,SAAS;AAChB,YAAM,WAAW,gBAAAC,QAAG,aAAa,KAAK,MAAM,MAAM;AAClD,YAAM,YAAY,iBAAiB,QAAQ;AAC3C,cAAQ,IAAI,KAAK,UAAU,WAAW,MAAM,CAAC,CAAC;AAAA,IAChD;AAEA,UAAM,SAAS,qBAAqB,KAAK,MAAM,KAAK,MAAM;AAE1D,QAAI,OAAO,IAAI;AACb,UAAI,KAAK,SAAS;AAChB,gBAAQ,IAAI,oBAAoB;AAAA,MAClC;AACA,aAAO;AAAA,IACT;AAEA,YAAQ,MAAM,oBAAoB;AAClC,YAAQ,MAAM,aAAa,OAAO,MAAM,CAAC;AACzC,WAAO;AAAA,EACT,SAAS,OAAY;AACnB,YAAQ,MAAM,OAAO,WAAW,eAAe;AAC/C,WAAO;AAAA,EACT;AACF;AAEA,IAAM,cAAc,OAAO,YAAY,eAAe,QAAQ,SAAS;AAEvE,IAAI,aAAa;AACf,SAAO,QAAQ,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS;AAC3C,YAAQ,KAAK,IAAI;AAAA,EACnB,CAAC;AACH;","names":["import_node_fs","matter","remarkParse","Ajv2020","fs","fs"]}

package/dist/cli.mjs

@@ -0,0 +1,150 @@
+#!/usr/bin/env node
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+
+// src/cli.ts
+import fs2 from "fs";
+import { Command } from "commander";
+
+// src/extract.ts
+import matter from "gray-matter";
+import { unified } from "unified";
+import remarkParse from "remark-parse";
+function normalizeText(text) {
+  return text.trim().replace(/\s+/g, " ");
+}
+function extractInlineText(node) {
+  if (!node || typeof node !== "object") {
+    return "";
+  }
+  if (node.type === "text" || node.type === "inlineCode") {
+    return node.value ?? "";
+  }
+  if (!Array.isArray(node.children)) {
+    return "";
+  }
+  return node.children.map(extractInlineText).join("");
+}
+function collectHeadings(node, acc = []) {
+  if (!node || typeof node !== "object") {
+    return acc;
+  }
+  if (node.type === "heading" && typeof node.depth === "number") {
+    acc.push(node);
+  }
+  if (Array.isArray(node.children)) {
+    for (const child of node.children) {
+      collectHeadings(child, acc);
+    }
+  }
+  return acc;
+}
+function extractStructure(markdown) {
+  const { content } = matter(markdown);
+  const tree = unified().use(remarkParse).parse(content);
+  const headingNodes = collectHeadings(tree);
+  const headings = [];
+  const stack = [];
+  for (const heading of headingNodes) {
+    const depth = heading.depth;
+    if (typeof depth !== "number" || depth < 1 || depth > 6) {
+      continue;
+    }
+    const text = normalizeText(extractInlineText(heading));
+    const current = { depth, text };
+    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {
+      stack.pop();
+    }
+    const parent = stack[stack.length - 1];
+    if (parent) {
+      parent.children ??= [];
+      parent.children.push(current);
+    } else {
+      headings.push(current);
+    }
+    stack.push(current);
+  }
+  return { headings };
+}
+
+// src/validate.ts
+import fs from "fs";
+import Ajv2020 from "ajv/dist/2020";
+function validateStructure(structure, schema) {
+  const ajv = new Ajv2020({ allErrors: true, strict: false });
+  const validate = ajv.compile(schema);
+  const ok = validate(structure);
+  if (ok) {
+    return { ok: true };
+  }
+  return { ok: false, errors: validate.errors ?? [] };
+}
+function validateMarkdownFile(filePath, schemaPath) {
+  const markdown = fs.readFileSync(filePath, "utf8");
+  const schemaRaw = fs.readFileSync(schemaPath, "utf8");
+  const schema = JSON.parse(schemaRaw);
+  const structure = extractStructure(markdown);
+  return validateStructure(structure, schema);
+}
+
+// src/cli.ts
+function formatErrors(errors) {
+  if (!errors || errors.length === 0) {
+    return "Validation failed.";
+  }
+  return errors.map((err) => {
+    const path = err.instancePath && err.instancePath.length > 0 ? err.instancePath : "/";
+    return `- ${path} ${err.message ?? "validation error"}`;
+  }).join("\n");
+}
+async function runCli(argv) {
+  const program = new Command();
+  program.name("markdown-structure-checker").requiredOption("--file <path>", "Path to markdown file").requiredOption("--schema <path>", "Path to JSON Schema file").option("--print-ir", "Print extracted StructureJSON").option("--verbose", "Print extra output").exitOverride();
+  let opts;
+  try {
+    program.parse(argv, { from: "user" });
+    opts = program.opts();
+  } catch (error) {
+    if (error?.code === "commander.helpDisplayed") {
+      return 0;
+    }
+    if (error?.message) {
+      console.error(error.message);
+    }
+    return 2;
+  }
+  try {
+    if (opts.printIr) {
+      const markdown = fs2.readFileSync(opts.file, "utf8");
+      const structure = extractStructure(markdown);
+      console.log(JSON.stringify(structure, null, 2));
+    }
+    const result = validateMarkdownFile(opts.file, opts.schema);
+    if (result.ok) {
+      if (opts.verbose) {
+        console.log("Validation passed.");
+      }
+      return 0;
+    }
+    console.error("Validation failed:");
+    console.error(formatErrors(result.errors));
+    return 1;
+  } catch (error) {
+    console.error(error?.message ?? "Runtime error");
+    return 2;
+  }
+}
+var isDirectRun = typeof __require !== "undefined" && __require.main === module;
+if (isDirectRun) {
+  runCli(process.argv.slice(2)).then((code) => {
+    process.exit(code);
+  });
+}
+export {
+  runCli
+};
+//# sourceMappingURL=cli.mjs.map

package/dist/cli.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/cli.ts","../src/extract.ts","../src/validate.ts"],"sourcesContent":["#!/usr/bin/env node\nimport fs from \"node:fs\";\nimport { Command } from \"commander\";\nimport { extractStructure, validateMarkdownFile } from \"./index\";\n\nfunction formatErrors(errors: any[] | undefined): string {\n  if (!errors || errors.length === 0) {\n    return \"Validation failed.\";\n  }\n\n  return errors\n    .map((err) => {\n      const path = err.instancePath && err.instancePath.length > 0 ? err.instancePath : \"/\";\n      return `- ${path} ${err.message ?? \"validation error\"}`;\n    })\n    .join(\"\\n\");\n}\n\nexport async function runCli(argv: string[]): Promise<number> {\n  const program = new Command();\n\n  program\n    .name(\"markdown-structure-checker\")\n    .requiredOption(\"--file <path>\", \"Path to markdown file\")\n    .requiredOption(\"--schema <path>\", \"Path to JSON Schema file\")\n    .option(\"--print-ir\", \"Print extracted StructureJSON\")\n    .option(\"--verbose\", \"Print extra output\")\n    .exitOverride();\n\n  let opts: {\n    file: string;\n    schema: string;\n    printIr?: boolean;\n    verbose?: boolean;\n  };\n\n  try {\n    program.parse(argv, { from: \"user\" });\n    opts = program.opts();\n  } catch (error: any) {\n    if (error?.code === \"commander.helpDisplayed\") {\n      return 0;\n    }\n\n    if (error?.message) {\n      console.error(error.message);\n    }\n    return 2;\n  }\n\n  try {\n    if (opts.printIr) {\n      const markdown = fs.readFileSync(opts.file, \"utf8\");\n      const structure = extractStructure(markdown);\n      console.log(JSON.stringify(structure, null, 2));\n    }\n\n    const result = validateMarkdownFile(opts.file, opts.schema);\n\n    if (result.ok) {\n      if (opts.verbose) {\n        console.log(\"Validation passed.\");\n      }\n      return 0;\n    }\n\n    console.error(\"Validation failed:\");\n    console.error(formatErrors(result.errors));\n    return 1;\n  } catch (error: any) {\n    console.error(error?.message ?? \"Runtime error\");\n    return 2;\n  }\n}\n\nconst isDirectRun = typeof require !== \"undefined\" && require.main === module;\n\nif (isDirectRun) {\n  runCli(process.argv.slice(2)).then((code) => {\n    process.exit(code);\n  });\n}\n","import matter from \"gray-matter\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport type { HeadingNode, StructureJSON } from \"./types\";\n\ninterface MdastNode {\n  type?: string;\n  value?: string;\n  depth?: number;\n  children?: MdastNode[];\n}\n\nfunction normalizeText(text: string): string {\n  return text.trim().replace(/\\s+/g, \" \");\n}\n\nfunction extractInlineText(node: MdastNode): string {\n  if (!node || typeof node !== \"object\") {\n    return \"\";\n  }\n\n  if (node.type === \"text\" || node.type === \"inlineCode\") {\n    return node.value ?? \"\";\n  }\n\n  if (!Array.isArray(node.children)) {\n    return \"\";\n  }\n\n  return node.children.map(extractInlineText).join(\"\");\n}\n\nfunction collectHeadings(node: MdastNode, acc: MdastNode[] = []): MdastNode[] {\n  if (!node || typeof node !== \"object\") {\n    return acc;\n  }\n\n  if (node.type === \"heading\" && typeof node.depth === \"number\") {\n    acc.push(node);\n  }\n\n  if (Array.isArray(node.children)) {\n    for (const child of node.children) {\n      collectHeadings(child, acc);\n    }\n  }\n\n  return acc;\n}\n\nexport function extractStructure(markdown: string): StructureJSON {\n  const { content } = matter(markdown);\n  const tree = unified().use(remarkParse).parse(content) as MdastNode;\n  const headingNodes = collectHeadings(tree);\n\n  const headings: HeadingNode[] = [];\n  const stack: HeadingNode[] = [];\n\n  for (const heading of headingNodes) {\n    const depth = heading.depth;\n    if (typeof depth !== \"number\" || depth < 1 || depth > 6) {\n      continue;\n    }\n\n    const text = normalizeText(extractInlineText(heading));\n    const current: HeadingNode = { depth, text };\n\n    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {\n      stack.pop();\n    }\n\n    const parent = stack[stack.length - 1];\n    if (parent) {\n      parent.children ??= [];\n      parent.children.push(current);\n    } else {\n      headings.push(current);\n    }\n\n    stack.push(current);\n  }\n\n  return { headings };\n}\n","import fs from \"node:fs\";\nimport Ajv2020 from \"ajv/dist/2020\";\nimport { extractStructure } from \"./extract\";\nimport type { StructureJSON, ValidationResult } from \"./types\";\n\nexport function validateStructure(structure: StructureJSON, schema: object): ValidationResult {\n  const ajv = new Ajv2020({ allErrors: true, strict: false });\n  const validate = ajv.compile(schema);\n  const ok = validate(structure) as boolean;\n\n  if (ok) {\n    return { ok: true };\n  }\n\n  return { ok: false, errors: validate.errors ?? [] };\n}\n\nexport function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult {\n  const markdown = fs.readFileSync(filePath, \"utf8\");\n  const schemaRaw = fs.readFileSync(schemaPath, \"utf8\");\n  const schema = JSON.parse(schemaRaw) as object;\n\n  const structure = extractStructure(markdown);\n  return validateStructure(structure, schema);\n}\n"],"mappings":";;;;;;;;;AACA,OAAOA,SAAQ;AACf,SAAS,eAAe;;;ACFxB,OAAO,YAAY;AACnB,SAAS,eAAe;AACxB,OAAO,iBAAiB;AAUxB,SAAS,cAAc,MAAsB;AAC3C,SAAO,KAAK,KAAK,EAAE,QAAQ,QAAQ,GAAG;AACxC;AAEA,SAAS,kBAAkB,MAAyB;AAClD,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,UAAU,KAAK,SAAS,cAAc;AACtD,WAAO,KAAK,SAAS;AAAA,EACvB;AAEA,MAAI,CAAC,MAAM,QAAQ,KAAK,QAAQ,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,SAAS,IAAI,iBAAiB,EAAE,KAAK,EAAE;AACrD;AAEA,SAAS,gBAAgB,MAAiB,MAAmB,CAAC,GAAgB;AAC5E,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,aAAa,OAAO,KAAK,UAAU,UAAU;AAC7D,QAAI,KAAK,IAAI;AAAA,EACf;AAEA,MAAI,MAAM,QAAQ,KAAK,QAAQ,GAAG;AAChC,eAAW,SAAS,KAAK,UAAU;AACjC,sBAAgB,OAAO,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,SAAO;AACT;AAEO,SAAS,iBAAiB,UAAiC;AAChE,QAAM,EAAE,QAAQ,IAAI,OAAO,QAAQ;AACnC,QAAM,OAAO,QAAQ,EAAE,IAAI,WAAW,EAAE,MAAM,OAAO;AACrD,QAAM,eAAe,gBAAgB,IAAI;AAEzC,QAAM,WAA0B,CAAC;AACjC,QAAM,QAAuB,CAAC;AAE9B,aAAW,WAAW,cAAc;AAClC,UAAM,QAAQ,QAAQ;AACtB,QAAI,OAAO,UAAU,YAAY,QAAQ,KAAK,QAAQ,GAAG;AACvD;AAAA,IACF;AAEA,UAAM,OAAO,cAAc,kBAAkB,OAAO,CAAC;AACrD,UAAM,UAAuB,EAAE,OAAO,KAAK;AAE3C,WAAO,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,OAAO;AACjE,YAAM,IAAI;AAAA,IACZ;AAEA,UAAM,SAAS,MAAM,MAAM,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,CAAC;AACrB,aAAO,SAAS,KAAK,OAAO;AAAA,IAC9B,OAAO;AACL,eAAS,KAAK,OAAO;AAAA,IACvB;AAEA,UAAM,KAAK,OAAO;AAAA,EACpB;AAEA,SAAO,EAAE,SAAS;AACpB;;;ACnFA,OAAO,QAAQ;AACf,OAAO,aAAa;AAIb,SAAS,kBAAkB,WAA0B,QAAkC;AAC5F,QAAM,MAAM,IAAI,QAAQ,EAAE,WAAW,MAAM,QAAQ,MAAM,CAAC;AAC1D,QAAM,WAAW,IAAI,QAAQ,MAAM;AACnC,QAAM,KAAK,SAAS,SAAS;AAE7B,MAAI,IAAI;AACN,WAAO,EAAE,IAAI,KAAK;AAAA,EACpB;AAEA,SAAO,EAAE,IAAI,OAAO,QAAQ,SAAS,UAAU,CAAC,EAAE;AACpD;AAEO,SAAS,qBAAqB,UAAkB,YAAsC;AAC3F,QAAM,WAAW,GAAG,aAAa,UAAU,MAAM;AACjD,QAAM,YAAY,GAAG,aAAa,YAAY,MAAM;AACpD,QAAM,SAAS,KAAK,MAAM,SAAS;AAEnC,QAAM,YAAY,iBAAiB,QAAQ;AAC3C,SAAO,kBAAkB,WAAW,MAAM;AAC5C;;;AFnBA,SAAS,aAAa,QAAmC;AACvD,MAAI,CAAC,UAAU,OAAO,WAAW,GAAG;AAClC,WAAO;AAAA,EACT;AAEA,SAAO,OACJ,IAAI,CAAC,QAAQ;AACZ,UAAM,OAAO,IAAI,gBAAgB,IAAI,aAAa,SAAS,IAAI,IAAI,eAAe;AAClF,WAAO,KAAK,IAAI,IAAI,IAAI,WAAW,kBAAkB;AAAA,EACvD,CAAC,EACA,KAAK,IAAI;AACd;AAEA,eAAsB,OAAO,MAAiC;AAC5D,QAAM,UAAU,IAAI,QAAQ;AAE5B,UACG,KAAK,4BAA4B,EACjC,eAAe,iBAAiB,uBAAuB,EACvD,eAAe,mBAAmB,0BAA0B,EAC5D,OAAO,cAAc,+BAA+B,EACpD,OAAO,aAAa,oBAAoB,EACxC,aAAa;AAEhB,MAAI;AAOJ,MAAI;AACF,YAAQ,MAAM,MAAM,EAAE,MAAM,OAAO,CAAC;AACpC,WAAO,QAAQ,KAAK;AAAA,EACtB,SAAS,OAAY;AACnB,QAAI,OAAO,SAAS,2BAA2B;AAC7C,aAAO;AAAA,IACT;AAEA,QAAI,OAAO,SAAS;AAClB,cAAQ,MAAM,MAAM,OAAO;AAAA,IAC7B;AACA,WAAO;AAAA,EACT;AAEA,MAAI;AACF,QAAI,KAAK,SAAS;AAChB,YAAM,WAAWC,IAAG,aAAa,KAAK,MAAM,MAAM;AAClD,YAAM,YAAY,iBAAiB,QAAQ;AAC3C,cAAQ,IAAI,KAAK,UAAU,WAAW,MAAM,CAAC,CAAC;AAAA,IAChD;AAEA,UAAM,SAAS,qBAAqB,KAAK,MAAM,KAAK,MAAM;AAE1D,QAAI,OAAO,IAAI;AACb,UAAI,KAAK,SAAS;AAChB,gBAAQ,IAAI,oBAAoB;AAAA,MAClC;AACA,aAAO;AAAA,IACT;AAEA,YAAQ,MAAM,oBAAoB;AAClC,YAAQ,MAAM,aAAa,OAAO,MAAM,CAAC;AACzC,WAAO;AAAA,EACT,SAAS,OAAY;AACnB,YAAQ,MAAM,OAAO,WAAW,eAAe;AAC/C,WAAO;AAAA,EACT;AACF;AAEA,IAAM,cAAc,OAAO,cAAY,eAAe,UAAQ,SAAS;AAEvE,IAAI,aAAa;AACf,SAAO,QAAQ,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,SAAS;AAC3C,YAAQ,KAAK,IAAI;AAAA,EACnB,CAAC;AACH;","names":["fs","fs"]}

package/dist/index.d.mts

@@ -0,0 +1,19 @@
+interface HeadingNode {
+    depth: number;
+    text: string;
+    children?: HeadingNode[];
+}
+interface StructureJSON {
+    headings: HeadingNode[];
+}
+interface ValidationResult {
+    ok: boolean;
+    errors?: any[];
+}
+
+declare function extractStructure(markdown: string): StructureJSON;
+
+declare function validateStructure(structure: StructureJSON, schema: object): ValidationResult;
+declare function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult;
+
+export { type HeadingNode, type StructureJSON, type ValidationResult, extractStructure, validateMarkdownFile, validateStructure };

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+interface HeadingNode {
+    depth: number;
+    text: string;
+    children?: HeadingNode[];
+}
+interface StructureJSON {
+    headings: HeadingNode[];
+}
+interface ValidationResult {
+    ok: boolean;
+    errors?: any[];
+}
+
+declare function extractStructure(markdown: string): StructureJSON;
+
+declare function validateStructure(structure: StructureJSON, schema: object): ValidationResult;
+declare function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult;
+
+export { type HeadingNode, type StructureJSON, type ValidationResult, extractStructure, validateMarkdownFile, validateStructure };

package/dist/index.js

@@ -0,0 +1,125 @@
+"use strict";
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  extractStructure: () => extractStructure,
+  validateMarkdownFile: () => validateMarkdownFile,
+  validateStructure: () => validateStructure
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/extract.ts
+var import_gray_matter = __toESM(require("gray-matter"));
+var import_unified = require("unified");
+var import_remark_parse = __toESM(require("remark-parse"));
+function normalizeText(text) {
+  return text.trim().replace(/\s+/g, " ");
+}
+function extractInlineText(node) {
+  if (!node || typeof node !== "object") {
+    return "";
+  }
+  if (node.type === "text" || node.type === "inlineCode") {
+    return node.value ?? "";
+  }
+  if (!Array.isArray(node.children)) {
+    return "";
+  }
+  return node.children.map(extractInlineText).join("");
+}
+function collectHeadings(node, acc = []) {
+  if (!node || typeof node !== "object") {
+    return acc;
+  }
+  if (node.type === "heading" && typeof node.depth === "number") {
+    acc.push(node);
+  }
+  if (Array.isArray(node.children)) {
+    for (const child of node.children) {
+      collectHeadings(child, acc);
+    }
+  }
+  return acc;
+}
+function extractStructure(markdown) {
+  const { content } = (0, import_gray_matter.default)(markdown);
+  const tree = (0, import_unified.unified)().use(import_remark_parse.default).parse(content);
+  const headingNodes = collectHeadings(tree);
+  const headings = [];
+  const stack = [];
+  for (const heading of headingNodes) {
+    const depth = heading.depth;
+    if (typeof depth !== "number" || depth < 1 || depth > 6) {
+      continue;
+    }
+    const text = normalizeText(extractInlineText(heading));
+    const current = { depth, text };
+    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {
+      stack.pop();
+    }
+    const parent = stack[stack.length - 1];
+    if (parent) {
+      parent.children ??= [];
+      parent.children.push(current);
+    } else {
+      headings.push(current);
+    }
+    stack.push(current);
+  }
+  return { headings };
+}
+
+// src/validate.ts
+var import_node_fs = __toESM(require("fs"));
+var import__ = __toESM(require("ajv/dist/2020"));
+function validateStructure(structure, schema) {
+  const ajv = new import__.default({ allErrors: true, strict: false });
+  const validate = ajv.compile(schema);
+  const ok = validate(structure);
+  if (ok) {
+    return { ok: true };
+  }
+  return { ok: false, errors: validate.errors ?? [] };
+}
+function validateMarkdownFile(filePath, schemaPath) {
+  const markdown = import_node_fs.default.readFileSync(filePath, "utf8");
+  const schemaRaw = import_node_fs.default.readFileSync(schemaPath, "utf8");
+  const schema = JSON.parse(schemaRaw);
+  const structure = extractStructure(markdown);
+  return validateStructure(structure, schema);
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  extractStructure,
+  validateMarkdownFile,
+  validateStructure
+});
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/extract.ts","../src/validate.ts"],"sourcesContent":["export { extractStructure } from \"./extract\";\nexport { validateStructure, validateMarkdownFile } from \"./validate\";\nexport type { HeadingNode, StructureJSON, ValidationResult } from \"./types\";\n","import matter from \"gray-matter\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport type { HeadingNode, StructureJSON } from \"./types\";\n\ninterface MdastNode {\n  type?: string;\n  value?: string;\n  depth?: number;\n  children?: MdastNode[];\n}\n\nfunction normalizeText(text: string): string {\n  return text.trim().replace(/\\s+/g, \" \");\n}\n\nfunction extractInlineText(node: MdastNode): string {\n  if (!node || typeof node !== \"object\") {\n    return \"\";\n  }\n\n  if (node.type === \"text\" || node.type === \"inlineCode\") {\n    return node.value ?? \"\";\n  }\n\n  if (!Array.isArray(node.children)) {\n    return \"\";\n  }\n\n  return node.children.map(extractInlineText).join(\"\");\n}\n\nfunction collectHeadings(node: MdastNode, acc: MdastNode[] = []): MdastNode[] {\n  if (!node || typeof node !== \"object\") {\n    return acc;\n  }\n\n  if (node.type === \"heading\" && typeof node.depth === \"number\") {\n    acc.push(node);\n  }\n\n  if (Array.isArray(node.children)) {\n    for (const child of node.children) {\n      collectHeadings(child, acc);\n    }\n  }\n\n  return acc;\n}\n\nexport function extractStructure(markdown: string): StructureJSON {\n  const { content } = matter(markdown);\n  const tree = unified().use(remarkParse).parse(content) as MdastNode;\n  const headingNodes = collectHeadings(tree);\n\n  const headings: HeadingNode[] = [];\n  const stack: HeadingNode[] = [];\n\n  for (const heading of headingNodes) {\n    const depth = heading.depth;\n    if (typeof depth !== \"number\" || depth < 1 || depth > 6) {\n      continue;\n    }\n\n    const text = normalizeText(extractInlineText(heading));\n    const current: HeadingNode = { depth, text };\n\n    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {\n      stack.pop();\n    }\n\n    const parent = stack[stack.length - 1];\n    if (parent) {\n      parent.children ??= [];\n      parent.children.push(current);\n    } else {\n      headings.push(current);\n    }\n\n    stack.push(current);\n  }\n\n  return { headings };\n}\n","import fs from \"node:fs\";\nimport Ajv2020 from \"ajv/dist/2020\";\nimport { extractStructure } from \"./extract\";\nimport type { StructureJSON, ValidationResult } from \"./types\";\n\nexport function validateStructure(structure: StructureJSON, schema: object): ValidationResult {\n  const ajv = new Ajv2020({ allErrors: true, strict: false });\n  const validate = ajv.compile(schema);\n  const ok = validate(structure) as boolean;\n\n  if (ok) {\n    return { ok: true };\n  }\n\n  return { ok: false, errors: validate.errors ?? [] };\n}\n\nexport function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult {\n  const markdown = fs.readFileSync(filePath, \"utf8\");\n  const schemaRaw = fs.readFileSync(schemaPath, \"utf8\");\n  const schema = JSON.parse(schemaRaw) as object;\n\n  const structure = extractStructure(markdown);\n  return validateStructure(structure, schema);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,yBAAmB;AACnB,qBAAwB;AACxB,0BAAwB;AAUxB,SAAS,cAAc,MAAsB;AAC3C,SAAO,KAAK,KAAK,EAAE,QAAQ,QAAQ,GAAG;AACxC;AAEA,SAAS,kBAAkB,MAAyB;AAClD,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,UAAU,KAAK,SAAS,cAAc;AACtD,WAAO,KAAK,SAAS;AAAA,EACvB;AAEA,MAAI,CAAC,MAAM,QAAQ,KAAK,QAAQ,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,SAAS,IAAI,iBAAiB,EAAE,KAAK,EAAE;AACrD;AAEA,SAAS,gBAAgB,MAAiB,MAAmB,CAAC,GAAgB;AAC5E,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,aAAa,OAAO,KAAK,UAAU,UAAU;AAC7D,QAAI,KAAK,IAAI;AAAA,EACf;AAEA,MAAI,MAAM,QAAQ,KAAK,QAAQ,GAAG;AAChC,eAAW,SAAS,KAAK,UAAU;AACjC,sBAAgB,OAAO,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,SAAO;AACT;AAEO,SAAS,iBAAiB,UAAiC;AAChE,QAAM,EAAE,QAAQ,QAAI,mBAAAA,SAAO,QAAQ;AACnC,QAAM,WAAO,wBAAQ,EAAE,IAAI,oBAAAC,OAAW,EAAE,MAAM,OAAO;AACrD,QAAM,eAAe,gBAAgB,IAAI;AAEzC,QAAM,WAA0B,CAAC;AACjC,QAAM,QAAuB,CAAC;AAE9B,aAAW,WAAW,cAAc;AAClC,UAAM,QAAQ,QAAQ;AACtB,QAAI,OAAO,UAAU,YAAY,QAAQ,KAAK,QAAQ,GAAG;AACvD;AAAA,IACF;AAEA,UAAM,OAAO,cAAc,kBAAkB,OAAO,CAAC;AACrD,UAAM,UAAuB,EAAE,OAAO,KAAK;AAE3C,WAAO,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,OAAO;AACjE,YAAM,IAAI;AAAA,IACZ;AAEA,UAAM,SAAS,MAAM,MAAM,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,CAAC;AACrB,aAAO,SAAS,KAAK,OAAO;AAAA,IAC9B,OAAO;AACL,eAAS,KAAK,OAAO;AAAA,IACvB;AAEA,UAAM,KAAK,OAAO;AAAA,EACpB;AAEA,SAAO,EAAE,SAAS;AACpB;;;ACnFA,qBAAe;AACf,eAAoB;AAIb,SAAS,kBAAkB,WAA0B,QAAkC;AAC5F,QAAM,MAAM,IAAI,SAAAC,QAAQ,EAAE,WAAW,MAAM,QAAQ,MAAM,CAAC;AAC1D,QAAM,WAAW,IAAI,QAAQ,MAAM;AACnC,QAAM,KAAK,SAAS,SAAS;AAE7B,MAAI,IAAI;AACN,WAAO,EAAE,IAAI,KAAK;AAAA,EACpB;AAEA,SAAO,EAAE,IAAI,OAAO,QAAQ,SAAS,UAAU,CAAC,EAAE;AACpD;AAEO,SAAS,qBAAqB,UAAkB,YAAsC;AAC3F,QAAM,WAAW,eAAAC,QAAG,aAAa,UAAU,MAAM;AACjD,QAAM,YAAY,eAAAA,QAAG,aAAa,YAAY,MAAM;AACpD,QAAM,SAAS,KAAK,MAAM,SAAS;AAEnC,QAAM,YAAY,iBAAiB,QAAQ;AAC3C,SAAO,kBAAkB,WAAW,MAAM;AAC5C;","names":["matter","remarkParse","Ajv2020","fs"]}

package/dist/index.mjs

@@ -0,0 +1,86 @@
+// src/extract.ts
+import matter from "gray-matter";
+import { unified } from "unified";
+import remarkParse from "remark-parse";
+function normalizeText(text) {
+  return text.trim().replace(/\s+/g, " ");
+}
+function extractInlineText(node) {
+  if (!node || typeof node !== "object") {
+    return "";
+  }
+  if (node.type === "text" || node.type === "inlineCode") {
+    return node.value ?? "";
+  }
+  if (!Array.isArray(node.children)) {
+    return "";
+  }
+  return node.children.map(extractInlineText).join("");
+}
+function collectHeadings(node, acc = []) {
+  if (!node || typeof node !== "object") {
+    return acc;
+  }
+  if (node.type === "heading" && typeof node.depth === "number") {
+    acc.push(node);
+  }
+  if (Array.isArray(node.children)) {
+    for (const child of node.children) {
+      collectHeadings(child, acc);
+    }
+  }
+  return acc;
+}
+function extractStructure(markdown) {
+  const { content } = matter(markdown);
+  const tree = unified().use(remarkParse).parse(content);
+  const headingNodes = collectHeadings(tree);
+  const headings = [];
+  const stack = [];
+  for (const heading of headingNodes) {
+    const depth = heading.depth;
+    if (typeof depth !== "number" || depth < 1 || depth > 6) {
+      continue;
+    }
+    const text = normalizeText(extractInlineText(heading));
+    const current = { depth, text };
+    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {
+      stack.pop();
+    }
+    const parent = stack[stack.length - 1];
+    if (parent) {
+      parent.children ??= [];
+      parent.children.push(current);
+    } else {
+      headings.push(current);
+    }
+    stack.push(current);
+  }
+  return { headings };
+}
+
+// src/validate.ts
+import fs from "fs";
+import Ajv2020 from "ajv/dist/2020";
+function validateStructure(structure, schema) {
+  const ajv = new Ajv2020({ allErrors: true, strict: false });
+  const validate = ajv.compile(schema);
+  const ok = validate(structure);
+  if (ok) {
+    return { ok: true };
+  }
+  return { ok: false, errors: validate.errors ?? [] };
+}
+function validateMarkdownFile(filePath, schemaPath) {
+  const markdown = fs.readFileSync(filePath, "utf8");
+  const schemaRaw = fs.readFileSync(schemaPath, "utf8");
+  const schema = JSON.parse(schemaRaw);
+  const structure = extractStructure(markdown);
+  return validateStructure(structure, schema);
+}
+export {
+  extractStructure,
+  validateMarkdownFile,
+  validateStructure
+};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/extract.ts","../src/validate.ts"],"sourcesContent":["import matter from \"gray-matter\";\nimport { unified } from \"unified\";\nimport remarkParse from \"remark-parse\";\nimport type { HeadingNode, StructureJSON } from \"./types\";\n\ninterface MdastNode {\n  type?: string;\n  value?: string;\n  depth?: number;\n  children?: MdastNode[];\n}\n\nfunction normalizeText(text: string): string {\n  return text.trim().replace(/\\s+/g, \" \");\n}\n\nfunction extractInlineText(node: MdastNode): string {\n  if (!node || typeof node !== \"object\") {\n    return \"\";\n  }\n\n  if (node.type === \"text\" || node.type === \"inlineCode\") {\n    return node.value ?? \"\";\n  }\n\n  if (!Array.isArray(node.children)) {\n    return \"\";\n  }\n\n  return node.children.map(extractInlineText).join(\"\");\n}\n\nfunction collectHeadings(node: MdastNode, acc: MdastNode[] = []): MdastNode[] {\n  if (!node || typeof node !== \"object\") {\n    return acc;\n  }\n\n  if (node.type === \"heading\" && typeof node.depth === \"number\") {\n    acc.push(node);\n  }\n\n  if (Array.isArray(node.children)) {\n    for (const child of node.children) {\n      collectHeadings(child, acc);\n    }\n  }\n\n  return acc;\n}\n\nexport function extractStructure(markdown: string): StructureJSON {\n  const { content } = matter(markdown);\n  const tree = unified().use(remarkParse).parse(content) as MdastNode;\n  const headingNodes = collectHeadings(tree);\n\n  const headings: HeadingNode[] = [];\n  const stack: HeadingNode[] = [];\n\n  for (const heading of headingNodes) {\n    const depth = heading.depth;\n    if (typeof depth !== \"number\" || depth < 1 || depth > 6) {\n      continue;\n    }\n\n    const text = normalizeText(extractInlineText(heading));\n    const current: HeadingNode = { depth, text };\n\n    while (stack.length > 0 && stack[stack.length - 1].depth >= depth) {\n      stack.pop();\n    }\n\n    const parent = stack[stack.length - 1];\n    if (parent) {\n      parent.children ??= [];\n      parent.children.push(current);\n    } else {\n      headings.push(current);\n    }\n\n    stack.push(current);\n  }\n\n  return { headings };\n}\n","import fs from \"node:fs\";\nimport Ajv2020 from \"ajv/dist/2020\";\nimport { extractStructure } from \"./extract\";\nimport type { StructureJSON, ValidationResult } from \"./types\";\n\nexport function validateStructure(structure: StructureJSON, schema: object): ValidationResult {\n  const ajv = new Ajv2020({ allErrors: true, strict: false });\n  const validate = ajv.compile(schema);\n  const ok = validate(structure) as boolean;\n\n  if (ok) {\n    return { ok: true };\n  }\n\n  return { ok: false, errors: validate.errors ?? [] };\n}\n\nexport function validateMarkdownFile(filePath: string, schemaPath: string): ValidationResult {\n  const markdown = fs.readFileSync(filePath, \"utf8\");\n  const schemaRaw = fs.readFileSync(schemaPath, \"utf8\");\n  const schema = JSON.parse(schemaRaw) as object;\n\n  const structure = extractStructure(markdown);\n  return validateStructure(structure, schema);\n}\n"],"mappings":";AAAA,OAAO,YAAY;AACnB,SAAS,eAAe;AACxB,OAAO,iBAAiB;AAUxB,SAAS,cAAc,MAAsB;AAC3C,SAAO,KAAK,KAAK,EAAE,QAAQ,QAAQ,GAAG;AACxC;AAEA,SAAS,kBAAkB,MAAyB;AAClD,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,UAAU,KAAK,SAAS,cAAc;AACtD,WAAO,KAAK,SAAS;AAAA,EACvB;AAEA,MAAI,CAAC,MAAM,QAAQ,KAAK,QAAQ,GAAG;AACjC,WAAO;AAAA,EACT;AAEA,SAAO,KAAK,SAAS,IAAI,iBAAiB,EAAE,KAAK,EAAE;AACrD;AAEA,SAAS,gBAAgB,MAAiB,MAAmB,CAAC,GAAgB;AAC5E,MAAI,CAAC,QAAQ,OAAO,SAAS,UAAU;AACrC,WAAO;AAAA,EACT;AAEA,MAAI,KAAK,SAAS,aAAa,OAAO,KAAK,UAAU,UAAU;AAC7D,QAAI,KAAK,IAAI;AAAA,EACf;AAEA,MAAI,MAAM,QAAQ,KAAK,QAAQ,GAAG;AAChC,eAAW,SAAS,KAAK,UAAU;AACjC,sBAAgB,OAAO,GAAG;AAAA,IAC5B;AAAA,EACF;AAEA,SAAO;AACT;AAEO,SAAS,iBAAiB,UAAiC;AAChE,QAAM,EAAE,QAAQ,IAAI,OAAO,QAAQ;AACnC,QAAM,OAAO,QAAQ,EAAE,IAAI,WAAW,EAAE,MAAM,OAAO;AACrD,QAAM,eAAe,gBAAgB,IAAI;AAEzC,QAAM,WAA0B,CAAC;AACjC,QAAM,QAAuB,CAAC;AAE9B,aAAW,WAAW,cAAc;AAClC,UAAM,QAAQ,QAAQ;AACtB,QAAI,OAAO,UAAU,YAAY,QAAQ,KAAK,QAAQ,GAAG;AACvD;AAAA,IACF;AAEA,UAAM,OAAO,cAAc,kBAAkB,OAAO,CAAC;AACrD,UAAM,UAAuB,EAAE,OAAO,KAAK;AAE3C,WAAO,MAAM,SAAS,KAAK,MAAM,MAAM,SAAS,CAAC,EAAE,SAAS,OAAO;AACjE,YAAM,IAAI;AAAA,IACZ;AAEA,UAAM,SAAS,MAAM,MAAM,SAAS,CAAC;AACrC,QAAI,QAAQ;AACV,aAAO,aAAa,CAAC;AACrB,aAAO,SAAS,KAAK,OAAO;AAAA,IAC9B,OAAO;AACL,eAAS,KAAK,OAAO;AAAA,IACvB;AAEA,UAAM,KAAK,OAAO;AAAA,EACpB;AAEA,SAAO,EAAE,SAAS;AACpB;;;ACnFA,OAAO,QAAQ;AACf,OAAO,aAAa;AAIb,SAAS,kBAAkB,WAA0B,QAAkC;AAC5F,QAAM,MAAM,IAAI,QAAQ,EAAE,WAAW,MAAM,QAAQ,MAAM,CAAC;AAC1D,QAAM,WAAW,IAAI,QAAQ,MAAM;AACnC,QAAM,KAAK,SAAS,SAAS;AAE7B,MAAI,IAAI;AACN,WAAO,EAAE,IAAI,KAAK;AAAA,EACpB;AAEA,SAAO,EAAE,IAAI,OAAO,QAAQ,SAAS,UAAU,CAAC,EAAE;AACpD;AAEO,SAAS,qBAAqB,UAAkB,YAAsC;AAC3F,QAAM,WAAW,GAAG,aAAa,UAAU,MAAM;AACjD,QAAM,YAAY,GAAG,aAAa,YAAY,MAAM;AACpD,QAAM,SAAS,KAAK,MAAM,SAAS;AAEnC,QAAM,YAAY,iBAAiB,QAAQ;AAC3C,SAAO,kBAAkB,WAAW,MAAM;AAC5C;","names":[]}

package/examples/incident-structure.schema.json

@@ -0,0 +1,92 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "type": "object",
+  "required": ["headings"],
+  "additionalProperties": false,
+  "properties": {
+    "headings": {
+      "type": "array",
+      "prefixItems": [
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Summary" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Steps to Reproduce" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Expected Behavior" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Actual Behavior" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Impact" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Workarounds" }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["depth", "text"],
+          "additionalProperties": false,
+          "properties": {
+            "depth": { "const": 2 },
+            "text": { "const": "Vendor Response Timeline" },
+            "children": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "required": ["depth", "text"],
+                "additionalProperties": false,
+                "properties": {
+                  "depth": { "const": 3 },
+                  "text": {
+                    "type": "string",
+                    "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
+                  }
+                }
+              }
+            }
+          }
+        }
+      ],
+      "items": false
+    }
+  }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "markdown-structure-checker",
+  "version": "0.1.0",
+  "description": "Structural outline checker for Markdown files using JSON Schema",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "markdown-structure-checker": "dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "examples"
+  ],
+  "scripts": {
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "markdown",
+    "schema",
+    "validation",
+    "ajv",
+    "cli"
+  ],
+  "license": "MIT",
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "commander": "^14.0.1",
+    "gray-matter": "^4.0.3",
+    "remark-parse": "^11.0.0",
+    "unified": "^11.0.5"
+  },
+  "devDependencies": {
+    "@types/node": "^24.3.0",
+    "tsup": "^8.5.0",
+    "typescript": "^5.9.2",
+    "vitest": "^3.2.4"
+  }
+}