vox-project-scaffold API Reference (generated)

vox-project-scaffold

Crate: vox-project-scaffold · Version: 0.6.0 · Target: Library (lib.rs)

Shared Vox.toml + src/main.vox + skill scaffolding for vox init and MCP

Crate Overview

Shared Vox project scaffolding for vox init and MCP vox_project_init.

Workspace Dependencies

Dependency	Kind
vox-package-types	Normal
vox-repository	Normal

Public API Surface

Structs

Struct	Description
ScaffoldSummary	Summary of files and directories created under the scaffold root.

Functions

Function	Description
render_fn_stub	Render a Red-then-Green Vox fn stub paired with an @test block. The output is intentionally non-runnable: the test references undefined placeholders (_expected, _ per param) so the user is forced to fill in the expected behavior before the function compiles. This is the friction reducer for AGENTS.md §Test-First Policy. name: validated Vox identifier (alphanumeric + underscore, not starting with a digit). params: optional, e.g. "a: int, b: int". Empty means no parameters. returns: optional return type, e.g. "int". None means Unit.
append_fn_stub	Append a rendered fn-stub to a target file (creating it if missing). Returns the bytes written. Refuses to clobber a fn of the same name unless force is true.
resolve_scaffold_target_under_repo	Resolve target directory strictly under workspace_repo_root (empty / missing target_subdir → workspace root).
scaffold_vox_project_at	Scaffold under an absolute directory (e.g. CLI current dir). Creates the directory tree if needed.
scaffold_vox_project_under_repo	Scaffold under workspace_repo_root or a strict repo-relative subdirectory (for MCP).