ontoref-code/crates/ontoref-ontology/src/contrib.rs
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

64 lines
2.6 KiB
Rust

/// A statically registered node contribution, submitted at link time.
///
/// Crates that derive `OntologyNode` emit an
/// `inventory::submit!(NodeContribution { ... })` call, which is collected
/// here. All submissions are merged into [`Core`] via
/// [`Core::merge_contributors`](crate::ontology::Core::merge_contributors) —
/// NCL-loaded nodes always win on id collision.
///
/// [`Core`]: crate::ontology::Core
pub struct NodeContribution {
/// Returns the node to contribute. Called once per contribution during
/// merge.
pub supplier: fn() -> crate::types::Node,
}
inventory::collect!(NodeContribution);
/// A statically registered test coverage entry, submitted at test-binary link
/// time.
///
/// Produced by `#[onto_validates(practice = "...", adr = "...")]` from
/// `ontoref-derive`. Collected by [`Core::uncovered_practices`] to identify
/// practices without test coverage.
///
/// Only present in test binaries — zero production binary impact because
/// `#[cfg(all(test, feature = "derive"))]` gates all `inventory::submit!`
/// calls.
///
/// [`Core::uncovered_practices`]: crate::ontology::Core::uncovered_practices
pub struct TestCoverage {
/// Practice node id validated by this test, if any.
pub practice_id: Option<&'static str>,
/// ADR id validated by this test, if any.
pub adr_id: Option<&'static str>,
}
inventory::collect!(TestCoverage);
/// A statically registered config field inventory entry.
///
/// Consumer projects derive `#[derive(ConfigFields)]` on their serde config
/// structs to emit `inventory::submit!(ConfigFieldsEntry { ... })` at link
/// time. Ontoref daemon and test helpers iterate these entries to compare
/// against NCL section exports — detecting unclaimed NCL fields and fields
/// expected by Rust but absent in the contract.
///
/// Field names respect `#[serde(rename = "...")]` — the registered name is
/// what serde would use to match the JSON key, not the Rust identifier.
pub struct ConfigFieldsEntry {
/// Matches the `id` in the project's `manifest.ncl
/// config_surface.sections`.
pub section_id: &'static str,
/// Path to the NCL file for this section, relative to the project root.
/// Used to locate the file for export during coherence verification.
pub ncl_file: &'static str,
/// Fully-qualified Rust type name (e.g.
/// `"vapora_backend::config::ServerConfig"`). Informational — used in
/// coherence reports for traceability.
pub struct_name: &'static str,
/// All serde field names this struct expects from the NCL JSON export.
pub fields: &'static [&'static str],
}
inventory::collect!(ConfigFieldsEntry);