Expand description
Canonical semantic engine for the .norm format.
Structs§
- Collect
Response - Successful
collectmachine response. - Collected
Norm - One parsed convention file in a
collectresponse. - Compatibility
Conformance - Frozen conformance surface reported by a candidate.
- Compatibility
Product - Exact product identity reported by compatibility discovery.
- Compatibility
Response - Machine-readable compatibility discovery response.
- Compatibility
Rust Api - Public Rust consumer-surface identity.
- Diagnostic
- Stable diagnostic emitted by schema, profile, or semantic validation.
- Directory
Observation - Filesystem-neutral observation of one traversed directory.
- Error
Detail - Stable machine-readable error detail.
- Error
Response - Versioned machine response for a handled command failure.
- Init
Response - Versioned machine response for a completed
initoperation. - Norm
Coverage - Aggregate
.normcoverage across traversed directories. - Parse
Options - Options that alter accepted
.norminput formats. - Parse
Response - Successful
parsemachine response. - Parsed
Norm - A parsed
.normdocument before it is wrapped in a machine response. - Recurring
Filename - Filename found in two or more traversed directories.
- Scan
Naming - Naming-style counts collected from directories and visible files.
- Scan
Response - Versioned deterministic structural-scan response.
- Scan
Symlink - Portable symbolic-link observation in a scan response.
- Scanned
Directory - One traversed directory summarized for machine output.
- Schema
Bundle - Root and profile schemas supplied explicitly by a caller.
- Schema
Compile Error - Failure to compile a Draft 7 schema from the supplied offline resources.
- Schema
Violation - One structured Draft 7 schema violation.
- Validate
Response - Versioned machine response for a completed
validateevaluation. - Validation
Diagnostics - Schema and profile findings for one parsed document.
- Validation
Options - Options that alter validation severity or profile selection.
- Validation
Result - Validation outcome for one root-relative
.normpath. - Validation
Summary - Aggregate counts for a validation response.
Enums§
- Collect
Path Error - Failure to express a collection target relative to its project root.
- Init
Action - Filesystem action completed by
norm init. - Parse
Error - Stable parser failure categories.
- Reference
Status - Filesystem observation for one local reference target.
- Scan
Symlink Action - Action taken for an observed symbolic link.
- Scan
Symlink Kind - Kind of symbolic link observed without traversal.
- Validation
Status - Overall classification of one validated
.normfile.
Constants§
- A1_
CLI_ CASE_ COUNT - Number of executable cases in the frozen initial A1 CLI suite.
- A1_
CLI_ CONTRACT_ DIGEST - SHA-256 identity of the exact frozen initial A1 CLI contract bundle.
- A1_
CLI_ SUITE_ ID - Identifier for the frozen initial A1 CLI conformance suite.
- COLLECT_
API_ VERSION - Machine API identifier for collect responses.
- COMPATIBILITY_
API_ VERSION - Machine API identifier for compatibility discovery responses.
- CONFORMANCE_
API_ VERSION - Machine API identifier for arbitrary-candidate conformance reports.
- CONTRACT_
BUNDLE_ API_ VERSION - Identifier for the locked contract-bundle format.
- ERROR_
API_ VERSION - Machine API identifier for handled CLI failures in machine mode.
- FORMAT_
ID - Identifier for the initial
.normformat contract. - INIT_
API_ VERSION - Machine API identifier for init responses.
- PARSE_
API_ VERSION - Machine API identifier for parse responses.
- RUST_
API_ VERSION - Identifier for the public high-level Rust consumer surface.
- SCAN_
API_ VERSION - Machine API identifier for scan responses.
- VALIDATE_
API_ VERSION - Machine API identifier for validate responses.
Traits§
- Reference
Resolver - Explicit reference-resolution boundary implemented by filesystem adapters.
Functions§
- classify_
name - Classify one directory name or filename into a deterministic style bucket.
- collect_
candidate_ paths - Return candidate
.normpaths from the most-specific directory to root. - crate_
version - Return the compiled crate version.
- is_
ignored_ directory - Return whether a directory is infrastructure excluded from structural scan.
- parse_
norm - Parse an A1
.normdocument, or the pre-A1 format when explicitly enabled. - project_
path - Render a root-relative project path with portable separators.
- validate_
draft7 - Validate an instance with an explicit Draft 7 schema and offline resources.
- validate_
frontmatter - Validate schema, profile, lifecycle, SSOT, and reference semantics.
- validate_
structure - Validate parsed frontmatter without reading the filesystem or environment.