Glossary
Args
Individual arguments passed to a Block or Input. These are completely separate from Options.
Base
👉 See: Concepts > Bases.
A listing of option types and how to generate their default values.
Bases are used to create child Blocks and Presets.
Base Context
The shared helper functions and information provided to Bases.
These include user-provided Options, if they exist.
Base Definition
A description of a Base.
Bases are created by providing a Base Definition to the createBase function provided by create.
Block
👉 See: Concepts > Blocks.
A Block defines the logic to create a portion of a repository.
Each Block is associated with a parent Base, which defines the Options the Block may access during production.
Block Definition
A description of a Block.
Bases create Blocks with a createBlock() method, which takes in a Block Definition and returns a Block.
Block Context
The shared helper functions and information provided to Blocks.
These include Options as defined by the parent Base as well as any Args defined by the Block.
Block Data
TODO
// 1. Block Definition: the object passed to createBlock// 2. Block: the callable function used in:// * Preset definitions: passed to base.createPreset// * Addons: returned by Blocks and processed in runPreset// 3. BlockData: from calling a BlockContext
👉 See: Runtime > Contexts.
Helper functions and information provided to Blocks, Inputs, and Bases.
Creation
👉 See: Runtime > Creations.
The produced outputs generated by Blocks and Presets.
Creations describe the contents of a repository, such as files on disk or initialization shell commands.
Input
👉 See: Concepts > Inputs.
A standalone function that can be used to provide dynamic data by Blocks and Bases.
Input Context
The shared helper functions and information provided to Inputs.
These include Options as defined by the parent Base as well as any Args defined by the Input.
Input Definition
An object describing how to create an Input.
Options
The shared set of values defined by a Base and used
These are completely separate from any individual Args.
Preset
👉 See: Concepts > Presets.
A group of Blocks associated with the same parent Base.
System
APIs to interact with the file system, network, and shell.
Template
👉 See: Concepts > Templates.
A group of Presets that can be chosen between by a user to generate a repository.