Struct PartialTemplateConfig 

pub struct PartialTemplateConfig {
    pub schema: Option<String>,
    pub description: Option<String>,
    pub destination: Option<String>,
    pub extends: Option<OneOrMany<Id>>,
    pub id: Option<Id>,
    pub title: Option<String>,
    pub variables: Option<FxHashMap<String, <TemplateVariable as Config>::Partial>>,
}

Configures a template and its files to be scaffolded. Docs: https://moonrepo.dev/docs/config/template

Fields

schema: Option<String>

description: Option<String>

A description on what the template scaffolds.

destination: Option<String>

A pre-populated destination to scaffold to, relative from the workspace root when leading with /, otherwise the working directory.

extends: Option<OneOrMany<Id>>

Extends one or many other templates.

id: Option<Id>

Overrides the identifier of the template, instead of using the folder name.

title: Option<String>

A human-readable title for the template.

variables: Option<FxHashMap<String, <TemplateVariable as Config>::Partial>>

A map of variables that’ll be interpolated within each template file. Variables can also be populated by passing command line arguments.

Trait Implementations

impl Clone for PartialTemplateConfig

fn clone(&self) -> PartialTemplateConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PartialTemplateConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PartialTemplateConfig

fn default() -> PartialTemplateConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PartialTemplateConfig

where PartialTemplateConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialConfig for PartialTemplateConfig

type Context = ()

fn default_values(context: &Self::Context) -> Result<Option<Self>, ConfigError>

Return a partial configuration with values populated with default values for settings marked with #[setting(default)]. Unmarked settings will be None.

fn env_values() -> Result<Option<Self>, ConfigError>

Return a partial configuration with values populated from environment variables for settings marked with #[setting(env)]. Unmarked settings will be None.

fn extends_from(&self) -> Option<ExtendsFrom>

When a setting is marked as extendable with #[setting(extend)], this returns ExtendsFrom with the extended sources, either a list of strings or a single string. When no setting is extendable, this returns None.

fn finalize(self, context: &Self::Context) -> Result<Self, ConfigError>

Finalize the partial configuration by consuming it and populating all fields with a value. Defaults values from PartialConfig::default_values will be applied first, followed by merging the current partial, and lastly environment variable values from PartialConfig::env_values.

fn merge( &mut self, context: &Self::Context, next: Self, ) -> Result<(), ConfigError>

Merge another partial configuration into this one and clone values when applicable. The following merge strategies are applied:

fn validate( &self, context: &Self::Context, finalize: bool, ) -> Result<(), ConfigError>

Recursively validate the configuration with the provided context. Validation should be done on the final state, after merging partials.

impl PartialEq for PartialTemplateConfig

fn eq(&self, other: &PartialTemplateConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Schematic for PartialTemplateConfig

fn schema_name() -> Option<String>

Define a name for this schema type. Names are required for non-primitive values as a means to link references, and avoid cycles.

fn build_schema(schema: SchemaBuilder) -> Schema

Create and return a schema that models the structure of the implementing type. The schema can be used to generate code, documentation, or other artifacts.

impl Serialize for PartialTemplateConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PartialTemplateConfig