401294de5d
Config surface — per-project config introspection, coherence verification, and
audited mutation without destroying NCL structure (ADR-008):
- crates/ontoref-daemon/src/config.rs — typed DaemonNclConfig (parse-at-boundary
pattern); all section structs derive ConfigFields + config_section(id, ncl_file)
emitting inventory::submit!(ConfigFieldsEntry{...}) at link time
- crates/ontoref-derive/src/lib.rs — #[derive(ConfigFields)] proc-macro; serde
rename support; serde_rename_of() helper extracted to fix excessive_nesting
- crates/ontoref-daemon/src/main.rs — 3-tuple bootstrap block (nickel_import_path,
loaded_ncl_config: Option<DaemonNclConfig>, stdin_raw); apply_ui_config takes
&UiConfig; NATS call site typed; resolve_asset_dir cfg(feature = "ui")
- crates/ontoref-daemon/src/api.rs — config GET/PUT endpoints, quickref, coherence,
cross-project comparison; index_section_fields() extracted (excessive_nesting)
- crates/ontoref-daemon/src/config_coherence.rs — multi-consumer coherence;
merge_meta_into_section() extracted; and() replaces unnecessary and_then
NCL contracts for ontoref's own config:
- .ontoref/contracts.ncl — LogConfig (LogLevel, LogRotation, PositiveInt) and
DaemonConfig (Port, optional overrides); std.contract.from_validator throughout
- .ontoref/config.ncl — log | C.LogConfig applied
- .ontology/manifest.ncl — contracts_path, log/daemon contract refs, daemon section
with DaemonRuntimeConfig consumer and 7 declared fields
Protocol:
- adrs/adr-008-ncl-first-config-validation-and-override-layer.ncl — NCL contracts
as single validation gate; Rust structs are contract-trusted; override-layer
mutation writes {section}.overrides.ncl + _overrides_meta, never touches source
on+re update:
- .ontology/core.ncl — config-surface node (28 practices); adr-lifecycle extended
to adr-007 + adr-008; 6 new edges (ManifestsIn daemon, DependsOn ontology-crate,
Complements api-catalog-surface/dag-formalized/self-describing/adopt-ontoref)
- .ontology/state.ncl — protocol-maturity blocker and self-description-coverage
catalyst updated for session 2026-03-26
- README.md / CHANGELOG.md updated
63 lines
2.8 KiB
Plaintext
63 lines
2.8 KiB
Plaintext
let d = import "../defaults.ncl" in
|
|
|
|
d.make_mode String {
|
|
id = "config_coherence",
|
|
trigger = "Verify NCL↔consumer coherence for a project's config surface — detect unclaimed fields and consumer fields missing from the NCL export",
|
|
|
|
preconditions = [
|
|
"ONTOREF_PROJECT_ROOT is set and points to a project with config_surface in manifest.ncl",
|
|
"nickel is available in PATH",
|
|
"Nushell >= 0.110.0 is available",
|
|
"ontoref-daemon is running or ONTOREF_DAEMON_URL is set",
|
|
],
|
|
|
|
steps = [
|
|
{
|
|
id = "load-manifest",
|
|
action = "Export the project manifest and confirm config_surface is declared. Verify sections, consumers, and overrides_dir paths resolve.",
|
|
cmd = "nickel export --format json .ontology/manifest.ncl | from json | get config_surface",
|
|
actor = 'Both,
|
|
on_error = { strategy = 'Stop },
|
|
},
|
|
{
|
|
id = "export-configs",
|
|
action = "Export each NCL section file in parallel to get current field names and values. Uses NclCache if the daemon is running; falls back to direct nickel invocation.",
|
|
cmd = "open $env.ONTOREF_DAEMON_URL | url join --path $\"/api/projects/($slug)/config\"",
|
|
actor = 'Both,
|
|
depends_on = [{ step = "load-manifest" }],
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
{
|
|
id = "run-coherence",
|
|
action = "Run the multi-consumer coherence check via the daemon API. Returns per-section reports with unclaimed_fields and per-consumer missing_in_ncl.",
|
|
cmd = "http get $\"($env.ONTOREF_DAEMON_URL)/api/projects/($slug)/config/coherence\"",
|
|
actor = 'Both,
|
|
depends_on = [{ step = "export-configs" }],
|
|
on_error = { strategy = 'Stop },
|
|
},
|
|
{
|
|
id = "check-nu-accessors",
|
|
action = "For NuScript consumers that declare fields, verify the referenced .nu file actually contains $config.<section>.<field> access patterns. Flag mismatches.",
|
|
cmd = "rg --no-heading '\\$config\\.(\\w+)\\.(\\w+)' <nu-script-path>",
|
|
actor = 'Both,
|
|
depends_on = [{ step = "run-coherence" }],
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
{
|
|
id = "generate-quickref",
|
|
action = "Generate the living config documentation combining NCL values, manifest rationales, _meta_ records, and override history.",
|
|
cmd = "http get $\"($env.ONTOREF_DAEMON_URL)/api/projects/($slug)/config/quickref\"",
|
|
actor = 'Both,
|
|
depends_on = [{ step = "run-coherence" }],
|
|
on_error = { strategy = 'Continue },
|
|
},
|
|
{
|
|
id = "report",
|
|
action = "Summarise coherence findings: list unclaimed fields by section, consumer mismatches, and overall status (Ok | Warning | Error). Output as structured JSON for downstream tools.",
|
|
actor = 'Both,
|
|
depends_on = [{ step = "check-nu-accessors" }, { step = "generate-quickref" }],
|
|
on_error = { strategy = 'Stop },
|
|
},
|
|
],
|
|
}
|