@hstm-labs/forge-spec-parser

Specification parsing and validation for Forge — reads product specifications in Markdown, YAML, or JSON format and produces a canonical ParsedSpecification model with completeness scoring and cross-reference validation.

Installation

npm install @hstm-labs/forge-spec-parser

Public API

Parsing

• parseSpec(content, format) — parse specification content into canonical model
• loadSpecFile(path) — load and parse a specification file
• detectFormat(path) — auto-detect specification format
• ParserRegistry — plugin registry for format parsers
• createDefaultRegistry() — factory for registry with all built-in parsers

Parser Plugins

• MarkdownParserPlugin — GFM Markdown with entity/requirement extraction
• YamlParserPlugin — structured YAML specifications
• JsonParserPlugin — structured JSON specifications
• mapStructuredSpec() — shared mapper for YAML/JSON formats

Validation

• validateSpec(spec) — full validation (schema + completeness + cross-references)
• validateSchema(spec) — schema validation
• checkCompleteness(spec) — 6-dimension completeness scoring
• validateCrossReferences(spec) — entity/requirement reference integrity

Types

• ParsedSpecification — canonical specification model
• SpecRequirement, SpecEntity, SpecWorkflow — specification components
• ValidationReport, ValidationFinding — validation output

Usage

import { loadSpecFile, validateSpec } from '@hstm-labs/forge-spec-parser';

const spec = await loadSpecFile('specs/product-spec.md');
const report = validateSpec(spec);
console.log(`Completeness: ${report.completeness.overall}%`);

License

MIT