ontoref/reflection/modes/validate-project.ncl
Jesús Pérez 13b03d6edf
Some checks failed
Nickel Type Check / Nickel Type Checking (push) Has been cancelled
Rust CI / Security Audit (push) Has been cancelled
Rust CI / Check + Test + Lint (nightly) (push) Has been cancelled
Rust CI / Check + Test + Lint (stable) (push) Has been cancelled
feat: mode guards, convergence, manifest coverage, doc authoring pattern
## Mode guards and convergence loops (ADR-011)

  - `Guard` and `Converge` types added to `reflection/schema.ncl` and
    `reflection/defaults.ncl`. Guards run pre-flight checks (Block/Warn);
    converge loops iterate until a condition is met (RetryFailed/RetryAll).
  - `sync-ontology.ncl`: 3 guards + converge (zero-drift condition, max 2 iter).
  - `coder-workflow.ncl`: guard (coder-dir-exists) + `novelty-check` step.
  - Rust types in `ontoref-reflection/src/mode.rs`; executor in `executor.rs`
    evaluates guards before steps and convergence loop after.
  - `adrs/adr-011-mode-guards-and-convergence.ncl` added.

  ## Manifest capability completeness

  - `.ontology/manifest.ncl`: 3 → 19 declared capabilities covering the full
    action surface (daemon API, modes, Task Composer, QA, bookmarks, etc.).
  - `sync.nu`: `audit-manifest-coverage` + `sync manifest-check` command.
  - `validate-project.ncl`: 6th category `manifest-cov`.
  - Pre-commit hook `manifest-coverage` added.
  - Migrations `0010-manifest-capability-completeness`,
    `0011-manifest-coverage-hooks`.

  ## Rust doc authoring pattern — canonical `///` convention

  - `#[onto_api]`: `description = "..."` optional when `///` doc comment exists
    above handler — first line used as fallback. `#[derive(OntologyNode)]` same.
  - `ontoref-daemon/src/api.rs`: 42 handlers migrated to `///` doc comments;
    `description = "..."` removed from all `#[onto_api]` blocks.
  - `sync diff --docs --fail-on-drift`: exits 1 on crate `//!` drift; used by
    new `docs-drift` pre-commit hook. `docs-links` hook checks rustdoc broken links.
  - `generator.nu`: mdBook `crates/` chapter — per-crate page from `//!` doc,
    coverage badge, feature flags, implementing practice nodes.
  - `.claude/CLAUDE.md`: `### Documentation Authoring (Rust)` section added.
  - Migration `0012-rust-doc-authoring-pattern`.

  ## OntologyNode derive fixes

  - `#[derive(OntologyNode)]`: `name` and `paths` attributes supported; `///`
    doc fallback for `description`; `artifact_paths` correctly populated.
  - `Core::from_value` calls `merge_contributors()` behind `#[cfg(feature = "derive")]`.

  ## Bug fixes

  - `sync.nu` drift check: exact crate path match (not `str starts-with`);
    first-path-only rule; split on `. ` not `.` to avoid `.ontology/` truncation.
  - `find-unclaimed-artifacts`: fixed absolute vs relative path comparison.
  - Rustdoc broken intra-doc links fixed across all three crates.
  - `ci-docs` recipe now sets `RUSTDOCFLAGS` and actually fails on errors.

  mode guards/converge, manifest coverage validation, 19 capabilities (ADR-011)

  Extend the mode schema with Guard (pre-flight Block/Warn checks) and Converge
  (RetryFailed/RetryAll post-execution loops) — protocol pushes back on invalid
  state and iterates until convergence. ADR-011 records the decision to extend
  modes rather than create a separate action subsystem.

  Manifest expanded from 3 to 19 capabilities covering the full action surface
  (compose, plans, backlog graduation, notifications, coder pipeline, forms,
  templates, drift, quick actions, migrations, config, onboarding). New
  audit-manifest-coverage validator + pre-commit hook + SessionStart hook
  ensure agents always see complete project self-description.

  Bug fix: find-unclaimed-artifacts absolute vs relative path comparison —
  19 phantom MISSING items resolved. Health 43% → 100%.

  Anti-slop: coder novelty-check step (Jaccard overlap against published+QA)
  inserted between triage and publish in coder-workflow.

  Justfile restructured into 5 modules (build/test/dev/ci/assets).
  Migrations 0010-0011 propagate requirements to consumer projects.
2026-03-30 19:08:25 +01:00

111 lines
6.6 KiB
Plaintext

let d = import "../defaults.ncl" in
# Comprehensive project validation mode.
# Runs 6 independent validation categories in parallel, then aggregates results.
#
# DAG structure:
# adr-checks ─┐
# content-verify ─┤
# conn-health ─┤
# practice-cov ─┼─► aggregate
# gate-align ─┤
# manifest-cov ─┘
#
# Exit: non-zero if any Hard constraint fails (via validate check-all).
# All parallel steps use on_error = 'Continue so the aggregate always runs
# and collects all failures in one pass.
d.make_mode String {
id = "validate-project",
trigger = "Run all 6 validation categories (ADR constraints, content assets, connection health, practice coverage, gate consistency, manifest capability completeness) and produce a unified compliance report.",
preconditions = [
"ONTOREF_PROJECT_ROOT is set and points to a project with .ontology/ and adrs/ directories",
"Nushell >= 0.111.0 is available on PATH",
"nickel binary is available on PATH",
"rg (ripgrep) is available on PATH for Grep-type constraint checks",
],
steps = [
# ── Category 1: ADR typed constraint checks ─────────────────────────────
{
id = "adr-checks",
action = "Load all accepted ADRs, dispatch each typed constraint check (Grep, Cargo, NuCmd, ApiCall, FileExists). Fails on any Hard constraint violation.",
cmd = "nu --no-config-file -c 'use reflection/modules/validate.nu *; validate check-all --fmt json'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Category 2: content asset path verification ─────────────────────────
{
id = "content-verify",
action = "Verify that all source_path entries declared in manifest content_assets exist on disk. Reports missing files without failing the build.",
cmd = "nu --no-config-file -c 'use reflection/modules/describe.nu *; let m = (nickel export --format json .ontology/manifest.ncl | from json); let missing = ($m.content_assets? | default [] | where { |a| not ($a.source_path | path exists) } | get source_path); if ($missing | is-empty) { print \"content-verify: ok\" } else { print $\"content-verify: MISSING ($missing | str join \", \")\"; exit 1 }'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Category 3: connection health ───────────────────────────────────────
{
id = "conn-health",
action = "Validate connections.ncl: check that all referenced project slugs are reachable and that node IDs resolve. Reports unresolvable connections as warnings.",
cmd = "nu --no-config-file -c 'let f = \".ontology/connections.ncl\"; if ($f | path exists) { print \"conn-health: connections.ncl present\" } else { print \"conn-health: no connections.ncl — skipped\" }'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Category 4: practice coverage ───────────────────────────────────────
{
id = "practice-cov",
action = "Report Practice ontology nodes that have no corresponding test coverage annotation. Informational only — does not fail the mode.",
cmd = "nu --no-config-file -c 'let nodes = (nickel export --format json .ontology/core.ncl | from json | get nodes? | default [] | where { |n| ($n.level? | default \"\") == \"Practice\" }); print $\"practice-cov: ($nodes | length) practices in ontology\"'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Category 5: gate/dimension consistency ──────────────────────────────
{
id = "gate-align",
action = "Check that active gate membranes are consistent with current dimension states. A Closed membrane should reflect a dimension at a terminal state.",
cmd = "nu --no-config-file -c 'let g = (nickel export --format json .ontology/gate.ncl | from json); let active = ($g.membranes? | default [] | where { |m| ($m.active? | default false) }); print $\"gate-align: ($active | length) active membrane(s)\"'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Category 6: manifest capability completeness ───────────────────────
{
id = "manifest-cov",
action = "Cross-reference manifest capabilities against Practice nodes, reflection modes, and daemon UI pages. Detects undeclared functionality that agents will never discover via describe capabilities.",
cmd = "nu --no-config-file -c 'use reflection/modules/sync.nu; let root = ($env.ONTOREF_PROJECT_ROOT? | default $env.ONTOREF_ROOT? | default \".\"); let results = (sync audit --quick | get manifest_coverage? | default []); if ($results | is-empty) { print \"manifest-cov: no audit data\" } else { let warns = ($results | where status != \"PASS\"); if ($warns | is-empty) { print \"manifest-cov: ok\" } else { for w in $warns { print $\" ($w.status) ($w.check): ($w.detail)\" }; if ($warns | any { |w| ($w.severity? | default \"Soft\") == \"Hard\" }) { exit 1 } } }'",
actor = 'Both,
on_error = { strategy = 'Continue },
},
# ── Aggregate: collect results from all categories ──────────────────────
{
id = "aggregate",
action = "Collect results from all 6 validation categories and produce a unified compliance report. Exits non-zero if any Hard constraint failed.",
cmd = "nu --no-config-file -c 'use reflection/modules/validate.nu *; let summary = (validate summary); print ($summary | to json); if $summary.hard_passing < $summary.hard_total { exit 1 }'",
actor = 'Both,
depends_on = [
{ step = "adr-checks" },
{ step = "content-verify" },
{ step = "conn-health" },
{ step = "practice-cov" },
{ step = "gate-align" },
{ step = "manifest-cov" },
],
on_error = { strategy = 'Stop },
},
],
postconditions = [
"All Hard constraints from accepted ADRs exit with passed = true",
"All declared content_assets have existing source_path files",
"Gate/dimension state alignment is consistent",
"Practice coverage report is available in output",
"Manifest capability coverage has no Hard failures (all functionality declared)",
"Unified compliance JSON is printed to stdout",
],
}