oc_chat
Loading...
Searching...
No Matches
oc_chat.registry.render Namespace Reference

Namespaces

namespace  _common
namespace  plan_header
namespace  plan_status
namespace  roadmap

Functions

RenderReport render_all (Registry registry, *, Path target_root, bool prefer_local=False, bool dry_run=False, Iterable[str]|None artifacts=None)

Variables

 DEFAULT_ARTIFACTS = frozenset({"plan_status", "plan_header"})
 ALL_ARTIFACTS = DEFAULT_ARTIFACTS

Detailed Description

Registry render orchestration.

Purpose
-------
Expose the public `render_all` orchestration entry point for registry-backed
filesystem artifacts.

Responsibilities
----------------
- Dispatch to each artifact renderer in a deterministic order.
- Apply shared `prefer_local`, `dry_run`, and artifact filtering options.
- Return an aggregate `RenderReport` for CLI and doctor consumers.

Diagnostics
-----------
Domain: OC_CHAT.MAIN
Levels:
    L2 - render-all lifecycle events
    L3 - artifact selection details
    L4 - per-artifact dispatch tracing

Contracts
---------
- `render_all` mutates files only through artifact writers.
- Registry state is read-only during rendering.

Dependencies
------------
- oc_diagnostics (structured debug logging via _dbg)
- oc_chat.registry.api (Registry facade the artifacts are rendered from)
- oc_chat.registry.render._common (RenderReport, RenderResult and the worktree plan rows)
- oc_chat.registry.render.plan_header (plan header artifact writer)
- oc_chat.registry.render.plan_status (plan status artifact writer)

Function Documentation

◆ render_all()

RenderReport oc_chat.registry.render.render_all ( Registry registry,
* ,
Path target_root,
bool prefer_local = False,
bool dry_run = False,
Iterable[str] | None artifacts = None )
Render all requested registry-backed filesystem artifacts.

Definition at line 76 of file __init__.py.

Variable Documentation

◆ ALL_ARTIFACTS

oc_chat.registry.render.ALL_ARTIFACTS = DEFAULT_ARTIFACTS

Definition at line 73 of file __init__.py.

◆ DEFAULT_ARTIFACTS

oc_chat.registry.render.DEFAULT_ARTIFACTS = frozenset({"plan_status", "plan_header"})

Definition at line 72 of file __init__.py.