@shanepadgett/design.md 0.1.0

package/dist/core/validation/document-structure.js

@@ -0,0 +1,145 @@
+import { isFinalNonWhitespaceBlock, sectionHasProseBeforeLine, } from "../document/parse-document.js";
+import { lineSpan } from "../source/source-file.js";
+import { canonicalOrderIndex, getSectionDefinition, requiredSectionNames, } from "../sections/registry.js";
+export function validateDocumentStructure(document) {
+    const diagnostics = [];
+    const tokenFences = [];
+    const knownSections = document.sections.filter((section) => getSectionDefinition(section.name) !== undefined);
+    validateRequiredSections(document, diagnostics);
+    validateDuplicateKnownSections(document, diagnostics);
+    validateKnownSectionOrder(document, knownSections, diagnostics);
+    validateMetadataPosition(document, diagnostics);
+    for (const section of document.sections) {
+        const definition = getSectionDefinition(section.name);
+        if (definition === undefined) {
+            continue;
+        }
+        const yamlFences = section.fences.filter((fence) => fence.info === "yaml");
+        const firstYamlFence = yamlFences[0];
+        if (definition.proseRequired) {
+            const hasProse = sectionHasProseBeforeLine(section, firstYamlFence?.openingLine.number);
+            if (!hasProse) {
+                diagnostics.push({
+                    severity: "error",
+                    rule: "missing-prose",
+                    path: section.name,
+                    message: `Section '${section.name}' must include prose before tokens.`,
+                    span: lineSpan(document.sourceFile, section.heading.line),
+                });
+            }
+        }
+        if (definition.tokenFence === "none") {
+            continue;
+        }
+        if (yamlFences.length === 0) {
+            if (definition.tokenFence === "required") {
+                diagnostics.push({
+                    severity: "error",
+                    rule: "missing-token-fence",
+                    path: section.name,
+                    message: `Section '${section.name}' must include one final yaml token fence.`,
+                    span: lineSpan(document.sourceFile, section.heading.line),
+                });
+            }
+            continue;
+        }
+        if (firstYamlFence === undefined) {
+            continue;
+        }
+        if (yamlFences.length > 1) {
+            diagnostics.push({
+                severity: "error",
+                rule: "multiple-token-fences",
+                path: section.name,
+                message: `Section '${section.name}' must not include multiple yaml token fences.`,
+                span: lineSpan(document.sourceFile, yamlFences[1]?.openingLine ?? section.heading.line),
+            });
+        }
+        if (!isFinalNonWhitespaceBlock(section, firstYamlFence)) {
+            diagnostics.push({
+                severity: "error",
+                rule: "token-fence-placement",
+                path: section.name,
+                message: `The yaml token fence in '${section.name}' must be the final block in the section.`,
+                span: lineSpan(document.sourceFile, firstYamlFence.openingLine),
+            });
+        }
+        tokenFences.push({ section, definition, fence: firstYamlFence });
+    }
+    return { diagnostics, tokenFences };
+}
+function validateRequiredSections(document, diagnostics) {
+    const sectionNames = new Set(document.sections.map((section) => section.name));
+    for (const requiredName of requiredSectionNames) {
+        if (!sectionNames.has(requiredName)) {
+            const diagnostic = {
+                severity: "error",
+                rule: "missing-section",
+                path: requiredName,
+                message: `Missing required section '${requiredName}'.`,
+            };
+            if (document.title !== undefined) {
+                diagnostic.span = lineSpan(document.sourceFile, document.title.line);
+            }
+            diagnostics.push(diagnostic);
+        }
+    }
+}
+function validateDuplicateKnownSections(document, diagnostics) {
+    const seen = new Set();
+    for (const section of document.sections) {
+        if (getSectionDefinition(section.name) === undefined) {
+            continue;
+        }
+        if (seen.has(section.name)) {
+            diagnostics.push({
+                severity: "error",
+                rule: "duplicate-section",
+                path: section.name,
+                message: `Duplicate known section '${section.name}'.`,
+                span: lineSpan(document.sourceFile, section.heading.line),
+            });
+        }
+        else {
+            seen.add(section.name);
+        }
+    }
+}
+function validateKnownSectionOrder(document, knownSections, diagnostics) {
+    let highestSeen = -1;
+    for (const section of knownSections) {
+        const definition = getSectionDefinition(section.name);
+        if (definition === undefined) {
+            continue;
+        }
+        const index = canonicalOrderIndex(definition.name);
+        if (index < highestSeen) {
+            diagnostics.push({
+                severity: "warning",
+                rule: "section-order",
+                path: section.name,
+                message: `Known section '${section.name}' should appear in canonical order.`,
+                span: lineSpan(document.sourceFile, section.heading.line),
+            });
+        }
+        else {
+            highestSeen = index;
+        }
+    }
+}
+function validateMetadataPosition(document, diagnostics) {
+    const metadata = document.sections.find((section) => section.name === "Metadata");
+    if (metadata === undefined) {
+        return;
+    }
+    if (document.sections[0] !== metadata) {
+        diagnostics.push({
+            severity: "error",
+            rule: "metadata-position",
+            path: "Metadata",
+            message: "Metadata must be the first H2 section after the H1 title.",
+            span: lineSpan(document.sourceFile, metadata.heading.line),
+        });
+    }
+}
+//# sourceMappingURL=document-structure.js.map

package/dist/core/validation/document-structure.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document-structure.js","sourceRoot":"","sources":["../../../src/core/validation/document-structure.ts"],"names":[],"mappings":"AACA,OAAO,EACL,yBAAyB,EACzB,yBAAyB,GAC1B,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,EACL,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,yBAAyB,CAAC;AAOjC,MAAM,UAAU,yBAAyB,CAAC,QAAwB;IAChE,MAAM,WAAW,GAAiB,EAAE,CAAC;IACrC,MAAM,WAAW,GAAwB,EAAE,CAAC;IAC5C,MAAM,aAAa,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,SAAS,CAC9D,CAAC;IAEF,wBAAwB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAChD,8BAA8B,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IACtD,yBAAyB,CAAC,QAAQ,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAChE,wBAAwB,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC;IAEhD,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxC,MAAM,UAAU,GAAG,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,SAAS;QACX,CAAC;QAED,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;QAC3E,MAAM,cAAc,GAAG,UAAU,CAAC,CAAC,CAAC,CAAC;QAErC,IAAI,UAAU,CAAC,aAAa,EAAE,CAAC;YAC7B,MAAM,QAAQ,GAAG,yBAAyB,CAAC,OAAO,EAAE,cAAc,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;YAExF,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,WAAW,CAAC,IAAI,CAAC;oBACf,QAAQ,EAAE,OAAO;oBACjB,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,YAAY,OAAO,CAAC,IAAI,qCAAqC;oBACtE,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;iBAC1D,CAAC,CAAC;YACL,CAAC;QACH,CAAC;QAED,IAAI,UAAU,CAAC,UAAU,KAAK,MAAM,EAAE,CAAC;YACrC,SAAS;QACX,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5B,IAAI,UAAU,CAAC,UAAU,KAAK,UAAU,EAAE,CAAC;gBACzC,WAAW,CAAC,IAAI,CAAC;oBACf,QAAQ,EAAE,OAAO;oBACjB,IAAI,EAAE,qBAAqB;oBAC3B,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO,EAAE,YAAY,OAAO,CAAC,IAAI,4CAA4C;oBAC7E,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;iBAC1D,CAAC,CAAC;YACL,CAAC;YAED,SAAS;QACX,CAAC;QAED,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YACjC,SAAS;QACX,CAAC;QAED,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,WAAW,CAAC,IAAI,CAAC;gBACf,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,uBAAuB;gBAC7B,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,YAAY,OAAO,CAAC,IAAI,gDAAgD;gBACjF,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,IAAI,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;aACxF,CAAC,CAAC;QACL,CAAC;QAED,IAAI,CAAC,yBAAyB,CAAC,OAAO,EAAE,cAAc,CAAC,EAAE,CAAC;YACxD,WAAW,CAAC,IAAI,CAAC;gBACf,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,uBAAuB;gBAC7B,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,4BAA4B,OAAO,CAAC,IAAI,2CAA2C;gBAC5F,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,cAAc,CAAC,WAAW,CAAC;aAChE,CAAC,CAAC;QACL,CAAC;QAED,WAAW,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,KAAK,EAAE,cAAc,EAAE,CAAC,CAAC;IACnE,CAAC;IAED,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,CAAC;AACtC,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAwB,EAAE,WAAyB;IACnF,MAAM,YAAY,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/E,KAAK,MAAM,YAAY,IAAI,oBAAoB,EAAE,CAAC;QAChD,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;YACpC,MAAM,UAAU,GAAe;gBAC7B,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,iBAAiB;gBACvB,IAAI,EAAE,YAAY;gBAClB,OAAO,EAAE,6BAA6B,YAAY,IAAI;aACvD,CAAC;YAEF,IAAI,QAAQ,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;gBACjC,UAAU,CAAC,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;YACvE,CAAC;YAED,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,8BAA8B,CAAC,QAAwB,EAAE,WAAyB;IACzF,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAE/B,KAAK,MAAM,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACxC,IAAI,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,SAAS,EAAE,CAAC;YACrD,SAAS;QACX,CAAC;QAED,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,WAAW,CAAC,IAAI,CAAC;gBACf,QAAQ,EAAE,OAAO;gBACjB,IAAI,EAAE,mBAAmB;gBACzB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,4BAA4B,OAAO,CAAC,IAAI,IAAI;gBACrD,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;aAC1D,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACzB,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,yBAAyB,CAChC,QAAwB,EACxB,aAA8B,EAC9B,WAAyB;IAEzB,IAAI,WAAW,GAAG,CAAC,CAAC,CAAC;IAErB,KAAK,MAAM,OAAO,IAAI,aAAa,EAAE,CAAC;QACpC,MAAM,UAAU,GAAG,oBAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,SAAS;QACX,CAAC;QAED,MAAM,KAAK,GAAG,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACnD,IAAI,KAAK,GAAG,WAAW,EAAE,CAAC;YACxB,WAAW,CAAC,IAAI,CAAC;gBACf,QAAQ,EAAE,SAAS;gBACnB,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,kBAAkB,OAAO,CAAC,IAAI,qCAAqC;gBAC5E,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;aAC1D,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,WAAW,GAAG,KAAK,CAAC;QACtB,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,wBAAwB,CAAC,QAAwB,EAAE,WAAyB;IACnF,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC;IAClF,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO;IACT,CAAC;IAED,IAAI,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QACtC,WAAW,CAAC,IAAI,CAAC;YACf,QAAQ,EAAE,OAAO;YACjB,IAAI,EAAE,mBAAmB;YACzB,IAAI,EAAE,UAAU;YAChB,OAAO,EAAE,2DAA2D;YACpE,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC;SAC3D,CAAC,CAAC;IACL,CAAC;AACH,CAAC"}

package/dist/core/validation/section-schemas.d.ts

@@ -0,0 +1,4 @@
+import type { Diagnostic } from "../diagnostics/types.js";
+import type { ParsedSectionToken } from "../sections/tokens.js";
+export declare function validateSectionSchemas(sectionTokens: readonly ParsedSectionToken[]): Diagnostic[];
+//# sourceMappingURL=section-schemas.d.ts.map

package/dist/core/validation/section-schemas.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"section-schemas.d.ts","sourceRoot":"","sources":["../../../src/core/validation/section-schemas.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AAiChE,wBAAgB,sBAAsB,CAAC,aAAa,EAAE,SAAS,kBAAkB,EAAE,GAAG,UAAU,EAAE,CAwCjG"}