36 lines
1.9 KiB
Go
36 lines
1.9 KiB
Go
// Package fejkdata generates fake data from recursive JSON templates.
|
|
//
|
|
// Data lives in JSON, not in Go. A generator starts from the shipped data set and
|
|
// layers any directories you add; folders and files become a dot-path namespace,
|
|
// then generate values by path:
|
|
//
|
|
// f, _ := fejkdata.New(fejkdata.WithSeed(42))
|
|
// f.Fake("sv_SE.address") // "Räfsalsvägen 43\n442 42 Kungälv"
|
|
// f.Fake("sv_SE.address.locality") // "Umeå": a second call draws afresh
|
|
//
|
|
// Several sources merge in order, the last winning a name clash, so custom data
|
|
// layers over the built-ins. The JSON template format is documented in the [README].
|
|
//
|
|
// [README]: https://github.com/larvit/fejkdata#readme
|
|
package fejkdata
|
|
|
|
// Vocabulary
|
|
//
|
|
// - draw — one pick from a choice, or one row taken from a table: `pick`,
|
|
// `resolveChoice`, `renderScope.drawRowOf`. Every {…} draws afresh, bar a read of a name.
|
|
// - expansion — one render of one format: `expand`.
|
|
// - render — one walk of the tree from an entry point, over one `frameStack`:
|
|
// `Generator.Fake`, `FakeRecord`, `Template.Fake` and `RecordTemplate.Fake`
|
|
// start one each, and `FakeStruct` one per record.
|
|
// - named pick — the draw a token such as {/person as p} binds to a name, drawn
|
|
// on its first read and kept while its scope renders: a category, or one
|
|
// repeat iteration: `nameBinding`, `nameScope`, `namedPick`, `pickFrame`.
|
|
// - memo — what a named pick keeps its draws in, the variant drawn at each level
|
|
// and the value each path read: `drawMemo`.
|
|
// - pin — fixing which row of a table one path, or one named pick, uses:
|
|
// `pinSet`, `namedPick.pins`, `table.drawStep`.
|
|
// - family — a table and every table reaching it through a chain of links
|
|
// `table.linkParent` makes.
|
|
// - fence — a load-time check, run over each category, template or struct as it
|
|
// loads or compiles, so rendering a compiled tree cannot fail.
|