Skip to content
internal/gendata
Updated
On this page

Generating data files by running declared scripts under bubblewrap, with no network, no inherited environment and no writable path but the output one.

#internal/gendata

#internal/gendata

Package gendata generates data files by running sandboxed scripts via bubblewrap (bwrap).

A project declares its scripts under the "gen_data" key of selfdoc.json; each declaration names the command to run, the file it must produce inside .selfdoc/data, and the paths the sandbox mounts read-only. [GenerateData] runs each one inside bwrap with no network, no inherited environment and no writable path other than the output directory, then validates the produced file against its extension.

#Error

Go go
type Error struct

Error is the failure every gen-data operation reports: a malformed script declaration, a missing bwrap, a script that failed, timed out or produced nothing, and an output file that does not parse as its extension claims.

It is the Go counterpart of the Python surface's GenDataError, and the one error type a caller needs to recognize with errors.As to render "gen-data" diagnostics distinctly from an unexpected internal failure.

#GenerateData

Go go
func GenerateData(config map[string]any, baseDir string, h *effects.Handle) ([]string, error)

GenerateData runs the sandboxed scripts declared in config and returns the paths of the files they produced, in declaration order.

config is the decoded selfdoc.json object: the scripts are read from its "gen_data" object's "scripts" array, and a config declaring neither returns no paths and runs nothing. baseDir is the project directory every relative mount and the sandbox's working directory resolve against; the output directory is always baseDir/.selfdoc/data, created before the first script runs.

Each returned path is baseDir/.selfdoc/data joined with the script's declared output name, so a relative baseDir yields relative paths.

Under a handle in preview mode every script is recorded rather than run: the returned paths then name the files the scripts would have produced, and no output is validated, because nothing was produced.

#Error.Error

Go go
func (e *Error) Error() string { return e.Message }

Error returns the diagnostic.

Search