boltbuild 0.1.0

BoltBuild is a programmable build system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

---@meta

local function use(var)
    return var
end

---A container for managing command-line options or general settings for a program.
---Settings allow values to be configured via command-line arguments, and each setting type can be declared with methods prefixed by `add_*`.
---These `add_*` methods are only available during the `init` stage of the tool's lifecycle.
---@class Settings
---@field [string] EnvironmentValue Holds environment values mapped to string keys, for storing any program-defined settings.
Settings = {}

---Represents a command-line option that has been declared within `Settings`.
---The option may be of various types, such as a boolean flag, string, integer count, list, or an enumerated choice.
---@class CommandLineOption
CommandLineOption = {}

---Declares a new boolean setting, representing a flag that can be toggled on or off.
---This setting can optionally be configured from the command line.
---@param name string The name of the setting, used as a key for retrieval.
---@param help string A help message displayed in the `--help` output, describing the setting's purpose.
---@param default_value boolean|nil The default value of the flag if it is not specified on the command line; defaults to `false` if unspecified.
---@return CommandLineOption A `CommandLineOption` object for further configuration.
function Settings:add_flag(name, help, default_value)
    use(name)
    use(help)
    use(default_value)
end

---Declares a new string setting, allowing users to input arbitrary text values.
---@param name string The name of the setting, used as a key for retrieval.
---@param help string A help message displayed in the `--help` output, describing the setting's purpose.
---@param default_value string|nil The default value if the setting is not specified on the command line.
---@return CommandLineOption A `CommandLineOption` object for further configuration.
function Settings:add_value(name, help, default_value)
    use(name)
    use(help)
    use(default_value)
end

---Declares a new integer setting, often used for counters or specifying numerical values.
---@param name string The name of the setting, used as a key for retrieval.
---@param help string A help message displayed in the `--help` output, describing the setting's purpose.
---@param default_value number|nil The default value if the setting is not specified on the command line.
---@return CommandLineOption A `CommandLineOption` object for further configuration.
function Settings:add_count(name, help, default_value)
    use(name)
    use(help)
    use(default_value)
end

---Declares a new list setting, allowing multiple values to be provided as a comma-separated list.
---@param name string The name of the setting, used as a key for retrieval.
---@param help string A help message displayed in the `--help` output, describing the setting's purpose.
---@param default_value string[]|nil The default list of values if none are provided on the command line.
---@return CommandLineOption A `CommandLineOption` object for further configuration.
function Settings:add_list(name, help, default_value)
    use(name)
    use(help)
    use(default_value)
end

---Declares a new enum setting, restricting input to a defined set of valid string values.
---@param name string The name of the setting, used as a key for retrieval.
---@param help string A help message displayed in the `--help` output, describing the setting's purpose.
---@param possible_values string[] An array of valid values that this setting can accept.
---@param default_value string|nil The default value if the setting is not specified on the command line.
---@return CommandLineOption A `CommandLineOption` object for further configuration.
function Settings:add_choice(name, help, possible_values, default_value)
    use(name)
    use(help)
    use(default_value)
    use(possible_values)
end

---Specifies a category for the command-line option, helping to organize options within `--help` output.
---@param category string The category name under which this option will appear in help documentation.
---@return CommandLineOption The current `CommandLineOption` object, allowing method chaining.
function CommandLineOption:set_category(category)
    use(category)
end

---Sets the full (long) form of the option as it will appear on the command line.
---For example, setting `--verbose` as the long form of a flag.
---@param long string The long version of the option (e.g., `--verbose`).
---@return CommandLineOption The current `CommandLineOption` object, allowing method chaining.
function CommandLineOption:set_long(long)
    use(long)
end

---Sets the abbreviated (short) form of the option as it will appear on the command line.
---For example, setting `-v` as the short form of a flag.
---@param short string The short version of the option (e.g., `-v`).
---@return CommandLineOption The current `CommandLineOption` object, allowing method chaining.
function CommandLineOption:set_short(short)
    use(short)
end

---Marks this option as required, meaning that the program will enforce that it is specified at runtime.
---If omitted, the program will produce an error indicating the option must be provided.
---@return CommandLineOption The current `CommandLineOption` object, allowing method chaining.
function CommandLineOption:set_required()
end