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 },
|
||
|
|
},
|
||
|
|
],
|
||
|
|
}
|