PureXML/docs/rules/README.md
Mihaela Mihaljevic 229d7df3d0 feat(validation,schema): composable validation framework and cross-document composition
Ship the OpenAPIKit-style validation layer (builtin rules, warnings channel,
Validator tiers, coverage gates) and wire XSD compile checks through it. Advance
#161 with chameleon include validation, multi-container reference resolution,
and include targetNamespace composition rules so merged schema sets compile
correctly when a schemaLoader is provided.
2026-06-16 09:57:43 +02:00

31 lines
1.1 KiB
Markdown

# PureXML Rules
Load these rules before changing code:
- `code-style.md`
- `namespacing.md`
- `cross-platform.md`
- `testing.md`
- `verification.md`
- `commits.md`
- `research-first.md`
Project-specific overrides:
- PureXML uses a root `Package.swift`.
- Sources live directly under `Sources`.
- Tests live in `Tests` (test target `PureXMLTests`).
- `Package.swift` must keep `dependencies: []`.
- Public API must live under the `PureXML` namespace tree.
- The package must build on macOS, Linux, Windows, and WASI.
- Validation coverage gates: `docs/validation-coverage-registry.txt` (public types),
`docs/validation-field-registry.txt` (document/subject fields), enforced by
`scripts/check-validation-coverage.sh` and `scripts/check-validation-fields.sh`.
The broader rule files are retained for detailed guidance. When they include
generic examples, apply the PureXML-specific overrides above.
Canonical Swift rules live at `/Volumes/Code/DeveloperExt/private/rules-swift`
(especially `validation-rules.md` and `parsing-rules.md`). Prefer that source
when `docs/rules/` copies drift.