mirror of
https://github.com/edera-dev/sprout.git
synced 2026-11-04 21:42:23 +00:00
alex
96b6c6f86a
Generators can now declare variant axes. Every generated entry is multiplied by each combination of choices, one per axis. A choice sets the axis name to the choice name and inserts its own values, and the entry name is suffixed with the choice names. Generators can also declare exclude rules, which remove generated entries whose values match every glob pattern in a rule. This covers unwanted variant combinations and entries like BLS rescue kernels. Entry matching for default-entry and the bootloader interface now accepts `*` anywhere in the pattern instead of only at the end, so generated entry names can be matched regardless of the kernel version in the middle of the name. The BLS generator gains a pin-names option (default true, the existing behavior). Two BLS generators reading the same directory previously produced entries with identical names; disabling pin-names prefixes them with the generator name instead. Sprout now warns when more than one entry has the same name. * docs(config): note that variants suffix pinned BLS entry names Pinned BLS entry names match the BLS entry ids, but variants still append their choice names, so those entries need a pattern like <id>-* to be selected.
73 lines
3.2 KiB
Rust
73 lines
3.2 KiB
Rust
use crate::generators::bls::BlsConfiguration;
|
|
use crate::generators::list::ListConfiguration;
|
|
use crate::generators::matrix::MatrixConfiguration;
|
|
use crate::generators::variants::VariantChoice;
|
|
use alloc::collections::BTreeMap;
|
|
use alloc::string::String;
|
|
use alloc::vec::Vec;
|
|
use serde::{Deserialize, Serialize};
|
|
|
|
/// Configuration for the BLS generator.
|
|
pub mod bls;
|
|
|
|
/// Configuration for the list generator.
|
|
pub mod list;
|
|
|
|
/// Configuration for the matrix generator.
|
|
pub mod matrix;
|
|
|
|
/// Configuration for generator variants.
|
|
pub mod variants;
|
|
|
|
/// Declares a generator configuration.
|
|
/// Generators allow generating entries at runtime based on a set of data.
|
|
#[derive(Serialize, Deserialize, Debug, Default, Clone)]
|
|
pub struct GeneratorDeclaration {
|
|
/// Matrix generator configuration.
|
|
/// Matrix allows you to specify multiple value-key values as arrays.
|
|
/// This allows multiplying the number of entries by any number of possible
|
|
/// configuration options. For example,
|
|
/// data.x = ["a", "b"]
|
|
/// data.y = ["c", "d"]
|
|
/// would generate an entry for each of these combinations:
|
|
/// x = a, y = c
|
|
/// x = a, y = d
|
|
/// x = b, y = c
|
|
/// x = b, y = d
|
|
#[serde(default)]
|
|
pub matrix: Option<MatrixConfiguration>,
|
|
/// BLS generator configuration.
|
|
/// BLS allows you to pass a filesystem path that contains a set of BLS entries.
|
|
/// It will generate a sprout entry for every supported BLS entry.
|
|
#[serde(default)]
|
|
pub bls: Option<BlsConfiguration>,
|
|
/// List generator configuration.
|
|
/// Allows you to specify a list of values to generate an entry from.
|
|
pub list: Option<ListConfiguration>,
|
|
/// Variants to apply to every entry produced by the generator.
|
|
/// Each key is an axis, and each axis has a list of choices. Every generated entry
|
|
/// is multiplied by every combination of choices, one choice from each axis.
|
|
/// For example,
|
|
/// variants.console = [{ name = "serial" }, { name = "graphics" }]
|
|
/// variants.mode = [{ name = "normal" }, { name = "debug", values.mode-options = "loglevel=7" }]
|
|
/// would turn each generated entry into four entries:
|
|
/// console = serial, mode = normal
|
|
/// console = serial, mode = debug
|
|
/// console = graphics, mode = normal
|
|
/// console = graphics, mode = debug
|
|
/// The axis name is set to the name of the chosen choice, and then the values of the
|
|
/// chosen choice are inserted, so `$console` and `$mode-options` can be used by the entry.
|
|
/// The entry name is suffixed with the choice names, like `-graphics-debug`.
|
|
/// Axes are applied in alphabetical order. Choices are applied in the declared order.
|
|
#[serde(default)]
|
|
pub variants: BTreeMap<String, Vec<VariantChoice>>,
|
|
/// Rules that exclude generated entries, applied after variants.
|
|
/// Each rule is a map of value names to glob patterns, where `*` matches anything.
|
|
/// An entry is excluded if every value named in any one rule matches its pattern.
|
|
/// Values are matched before they are stamped. For example,
|
|
/// exclude = [{ version = "0-rescue-*" }, { console = "graphics", mode = "debug" }]
|
|
/// excludes BLS rescue entries and the combination of the graphics and debug variants.
|
|
#[serde(default)]
|
|
pub exclude: Vec<BTreeMap<String, String>>,
|
|
}
|