Struct WorkspaceConfig 

pub struct WorkspaceConfig {

    pub schema: String,
    pub config: Option<Config>,
    pub config_file: Option<String>,
    pub extends: Option<ExtendsConfig>,
    pub workspace_root: String,
    pub name: String,
    pub namespace: String,
    pub variant: WorkspaceVariant,
    pub organization: WorkspaceOrganizationConfig,
    pub repository: String,
    pub license: String,
    pub homepage: String,
    pub docs: Option<String>,
    pub portal: Option<String>,
    pub licensing: Option<String>,
    pub contact: Option<String>,
    pub support: Option<String>,
    pub branch: String,
    pub preid: Option<String>,
    pub owner: String,
    pub bot: WorkspaceBotConfig,
    pub mode: WorkspaceMode,
    pub colors: WorkspaceColorsConfig,
    pub release: WorkspaceReleaseConfig,
    pub socials: WorkspaceSocialsConfig,
    pub error: WorkspaceErrorConfig,
    pub skip_cache: bool,
    pub registry: WorkspaceRegistryUrlConfig,
    pub directories: WorkspaceDirectoriesConfig,
    pub package_manager: PackageManagerType,
    pub timezone: String,
    pub locale: String,
    pub log_level: LogLevel,
    pub skip_config_logging: bool,
    pub extensions: RefCell<HashMap<String, HashMap<String, Value>>>,
}

Storm Workspace config values used during various development processes. It represents the shared config of the entire monorepo.

Fields

schema: String

The JSON schema reference describing the workspace configuration

config: Option<Config>

The configuration values parsed from the file

config_file: Option<String>

The filepath of the Storm config. When this field is null, no config file was found in the current workspace.

extends: Option<ExtendsConfig>

Optional configuration presets to extend from

workspace_root: String

The root directory of the package

name: String

The name of the package

namespace: String

The namespace of the package

variant: WorkspaceVariant

The configured workspace variant

organization: WorkspaceOrganizationConfig

The organization configuration backing the workspace

repository: String

The repo URL of the workspace (i.e. GitHub)

license: String

The license used by the package

homepage: String

The homepage of the workspace

docs: Option<String>

The documentation site for the workspace

portal: Option<String>

The development portal site for the workspace

licensing: Option<String>

The licensing site for the workspace

contact: Option<String>

The contact site for the workspace

support: Option<String>

The support site for the workspace

branch: String

The branch of the workspace

preid: Option<String>

A tag specifying the version pre-release identifier

owner: String

The owner of the package

bot: WorkspaceBotConfig

The workspace bot configuration used to automate tasks

mode: WorkspaceMode

The current workspace runtime mode (development/test/production)

colors: WorkspaceColorsConfig

Configured color settings for the workspace

release: WorkspaceReleaseConfig

The workspace release configuration

socials: WorkspaceSocialsConfig

The workspace socials configuration

error: WorkspaceErrorConfig

The workspace error configuration

skip_cache: bool

Should all known types of workspace caching be skipped?

registry: WorkspaceRegistryUrlConfig

The registry configuration for the workspace

directories: WorkspaceDirectoriesConfig

The directories configuration for the workspace

package_manager: PackageManagerType

The package manager used by the repository

timezone: String

The default timezone of the workspace

locale: String

The default locale of the workspace

log_level: LogLevel

The log level used to filter out lower priority log messages. If not provided, this is defaulted using the environment config value (if environment is set to production then level is error, else level is debug).

skip_config_logging: bool

Should the logging of the current Storm Workspace configuration be skipped?

extensions: RefCell<HashMap<String, HashMap<String, Value>>>

Configuration of each used extension

Implementations

impl WorkspaceConfig

pub fn new() -> Result<Self, ConfigError>

pub fn from_workspace_root(workspace_root: &Path) -> Result<Self, ConfigError>

pub fn get_extension(&self, name: &str) -> Option<HashMap<String, Value>>

Trait Implementations

impl Clone for WorkspaceConfig

fn clone(&self) -> WorkspaceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceConfig

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

Formats the value using the given formatter.

impl Default for WorkspaceConfig

fn default() -> Self

Returns the “default value” for a type.

impl FromStr for WorkspaceConfig

type Err = ()

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<WorkspaceConfig, Self::Err>

Parses a string s to return a value of this type.