ontoref/reflection/modes/sync-ontology.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

104 lines
4.2 KiB
Plaintext

let d = import "../defaults.ncl" in
d.make_mode String {
id = "sync-ontology",
trigger = "Synchronize .ontology/ declarations with actual project artifacts — detect drift, propose patches, apply with confirmation",
preconditions = [
"ONTOREF_PROJECT_ROOT is set and points to a project with .ontology/core.ncl",
"nickel binary is available on PATH",
"Nushell >= 0.110.0 is available",
],
guards = [
{
id = "ontology-exists",
cmd = "test -f .ontology/core.ncl",
reason = "No .ontology/core.ncl found — this project has no ontology to sync. Run adopt_ontoref first.",
severity = 'Block,
},
{
id = "nickel-available",
cmd = "command -v nickel >/dev/null 2>&1",
reason = "nickel binary not on PATH — cannot export NCL schemas. Install via: cargo install nickel-lang-cli",
severity = 'Block,
},
{
id = "manifest-capabilities",
cmd = "ONTOREF_ROOT=\"$(pwd)\" ONTOREF_PROJECT_ROOT=\"$(pwd)\" nu --no-config-file -c 'use ./reflection/modules/sync.nu *; sync manifest-check'",
reason = "Manifest capabilities incomplete — sync may report drift caused by undeclared capabilities rather than real code divergence. Fix manifest first.",
severity = 'Warn,
},
],
converge = {
condition = "ONTOREF_ROOT=\"$(pwd)\" ONTOREF_PROJECT_ROOT=\"$(pwd)\" nu --no-config-file -c 'use ./reflection/modules/sync.nu *; let d = (sync diff --quick); let issues = ($d | where { |r| $r.status != \"OK\" }); if ($issues | is-empty) { exit 0 } else { exit 1 }'",
max_iterations = 2,
strategy = 'RetryFailed,
},
steps = [
{
id = "scan",
action = "Analyze project structure: crates, scenarios, agents, CI, forms, modes. If nightly toolchain is available, extract pub API surface via cargo doc JSON.",
cmd = "./ontoref sync scan",
actor = 'Both,
on_error = { strategy = 'Stop },
},
{
id = "diff",
action = "Compare scan results against .ontology/core.ncl nodes and edges. Categorize each item as OK, MISSING (artifact without node), STALE (node without artifact), DRIFT (node outdated), or BROKEN (edge referencing missing node).",
cmd = "./ontoref sync diff",
actor = 'Both,
depends_on = [{ step = "scan" }],
on_error = { strategy = 'Stop },
},
{
id = "doc-drift",
action = "Compare crate-level //! doc comments against ontology node descriptions. Reports DRIFT for nodes whose description is empty or diverges significantly (Jaccard < 25%) from what the crate itself documents.",
cmd = "ontoref sync diff --docs",
actor = 'Both,
depends_on = [{ step = "diff" }],
on_error = { strategy = 'Continue },
note = "Skipped silently if no crates have //! doc comments. Requires src/lib.rs or src/main.rs with //! lines.",
},
{
id = "propose",
action = "Generate Nickel code for new nodes (MISSING), mark stale nodes for removal, generate updated nodes for DRIFT, mark broken edges for deletion.",
cmd = "ontoref sync propose",
actor = 'Both,
depends_on = [{ step = "doc-drift" }],
on_error = { strategy = 'Stop },
},
{
id = "review",
action = "Human reviews the proposal. Agent can skip this step.",
actor = 'Human,
depends_on = [{ step = "propose" }],
on_error = { strategy = 'Stop },
},
{
id = "apply",
action = "Apply approved changes to .ontology/core.ncl. Each category (add/remove/update) confirmed separately.",
cmd = "./ontoref sync apply",
actor = 'Human,
depends_on = [{ step = "review" }],
on_error = { strategy = 'Stop },
},
{
id = "verify",
action = "Run nickel typecheck on modified files. Execute sync diff again to confirm zero drift.",
cmd = "nickel typecheck .ontology/core.ncl && ./ontoref sync diff",
actor = 'Both,
depends_on = [{ step = "apply" }],
on_error = { strategy = 'Stop },
},
],
postconditions = [
"nickel export .ontology/core.ncl succeeds without errors",
"sync diff reports zero MISSING, STALE, or BROKEN items",
"All existing ADR Hard constraints still pass",
],
}