Skip to content

vox-project-scaffold API Reference (generated)

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

Shared Vox project scaffolding for vox init and MCP vox_project_init.

DependencyKind
vox-package-typesNormal
vox-repositoryNormal
StructDescription
ScaffoldSummarySummary of files and directories created under the scaffold root.
FunctionDescription
render_fn_stubRender 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_stubAppend 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_repoResolve target directory strictly under workspace_repo_root (empty / missing target_subdir → workspace root).
scaffold_vox_project_atScaffold under an absolute directory (e.g. CLI current dir). Creates the directory tree if needed.
scaffold_vox_project_under_repoScaffold under workspace_repo_root or a strict repo-relative subdirectory (for MCP).
Dependency Topology, diagram 16 nodes, 5 edges: vox-project-scaffold → vox-package-types; vox-project-scaffold → vox-repository; vox-audit → vox-project-scaffold; vox-cli → vox-project-scaffold; vox-orchestrator-mcp → vox-project-scaffoldvox-project-scaffoldvox-package-typesvox-repositoryvox-auditvox-clivox-orchestrator-mcp
Diagram source
graph {
direction: right
node vox_project_scaffold: "vox-project-scaffold"
node vox_package_types: "vox-package-types"
vox_project_scaffold -> vox_package_types
node vox_repository: "vox-repository"
vox_project_scaffold -> vox_repository
node vox_audit: "vox-audit"
vox_audit -> vox_project_scaffold
node vox_cli: "vox-cli"
vox_cli -> vox_project_scaffold
node vox_orchestrator_mcp: "vox-orchestrator-mcp"
vox_orchestrator_mcp -> vox_project_scaffold
}
Consumer CrateRole
vox-auditDirect workspace dependent
vox-cliDirect workspace dependent
vox-orchestrator-mcpDirect workspace dependent
KindSymbolSignatureSourceDescription
fnrender_fn_stubpub fn render_fn_stub(name: &str, params: Option<&str>, returns: Option<&str>) -> Result<String>crates/vox-project-scaffold/src/lib.rs#L244-L271Render 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.
fnappend_fn_stubpub fn append_fn_stub(crates/vox-project-scaffold/src/lib.rs#L302Append 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.
structScaffoldSummarypub struct ScaffoldSummarycrates/vox-project-scaffold/src/lib.rs#L357-L363Summary of files and directories created under the scaffold root.
fnresolve_scaffold_target_under_repopub fn resolve_scaffold_target_under_repo(crates/vox-project-scaffold/src/lib.rs#L366Resolve target directory strictly under workspace_repo_root (empty / missing target_subdir → workspace root).
fnscaffold_vox_project_atpub fn scaffold_vox_project_at(crates/vox-project-scaffold/src/lib.rs#L402Scaffold under an absolute directory (e.g. CLI current dir). Creates the directory tree if needed.
fnscaffold_vox_project_under_repopub fn scaffold_vox_project_under_repo(crates/vox-project-scaffold/src/lib.rs#L483Scaffold under workspace_repo_root or a strict repo-relative subdirectory (for MCP).