Testing Documentation
This section covers the testing mechanisms and quality assurance tools for PromptScript formatters.
Overview
PromptScript provides comprehensive testing to ensure formatter quality and consistency:
flowchart TB
subgraph "Quality Assurance"
PM[Parity Matrix] --> |Validates| Consistency[Formatter Consistency]
GF[Golden Files] --> |Validates| Output[Output Correctness]
FC[Feature Coverage] --> |Tracks| Capabilities[Tool Capabilities]
end
Testing Mechanisms
Parity Testing
Ensures consistent output across all formatters using specification-based and reference-based testing.
→
Feature Coverage
Tracks which features each AI tool supports and which our formatters implement.
→
Quick Reference
Running Tests
# Run all formatter testspnpm nx test formatters
# Run parity tests onlypnpm nx test formatters --testNamePattern="Parity"
# Run golden file testspnpm nx test formatters --testNamePattern="Golden Files"
# Run feature coverage testspnpm nx test formatters --testNamePattern="Feature Coverage"
# Update golden files after intentional changesUPDATE_GOLDEN=true pnpm nx test formattersTest Files
| Test File | Purpose |
|---|---|
parity-matrix.spec.ts | Section coverage validation |
golden-files.spec.ts | Output comparison against references |
feature-coverage.spec.ts | Feature implementation verification |
parity.spec.ts | Cross-formatter consistency |
Key Exports
@promptscript/formatters is not published to npm, so these imports work inside the PromptScript repository only.
import { // Parity Matrix PARITY_MATRIX, getRequiredSections, analyzeFormatterOutput,
// Feature Coverage FEATURE_MATRIX, getToolFeatures, toolSupportsFeature, getFeatureCoverage,} from '@promptscript/formatters';CI/CD Integration
Testing is integrated into the CI pipeline:
- Unit Tests - All formatter tests run on every push
- Golden Files Check - Detects drift in formatter output
- Coverage Reports - Tracks test coverage metrics
See Parity Testing - CI/CD Integration for details.