pub struct SettingMeta {
pub name: &'static str,
pub description: &'static str,
pub type_: &'static str,
pub default: &'static str,
pub docs: &'static str,
pub cli_flags: &'static [&'static str],
pub env_vars: &'static [&'static str],
pub npmrc_keys: &'static [&'static str],
pub workspace_yaml_keys: &'static [&'static str],
pub examples: &'static [&'static str],
pub typed_accessor_unused: bool,
pub npm_shared: bool,
}Expand description
Metadata for one setting. Every field is 'static because the
containing SETTINGS slice is a const built from string
literals at compile time.
Fields§
§name: &'static strpnpm-style canonical name (e.g. preferFrozenLockfile, registries)
description: &'static strOne-line summary
type_: &'static strTOML-ish type spec (e.g. "bool", "list<string>", "\"highest\" | \"time-based\"")
default: &'static strDefault value rendered as a string (e.g. "true", "undefined")
docs: &'static strLonger markdown docs body
cli_flags: &'static [&'static str]CLI flags that set this setting
env_vars: &'static [&'static str]Environment variables that set this setting
npmrc_keys: &'static [&'static str].npmrc keys that set this setting (aliases listed together;
the first entry is treated as the canonical spelling)
workspace_yaml_keys: &'static [&'static str]pnpm-workspace.yaml (and aube-workspace.yaml) keys that
set this setting.
examples: &'static [&'static str]Example invocations
typed_accessor_unused: boolEscape hatch for the workspace-level accessor audit in
tests/accessor_audit.rs. true means “this setting is
honored but not via its generated resolved::<name> typed
accessor” — e.g. read through std::env::var behind a
hand-rolled LazyLock, looked up in NpmConfig by string
key, or accepted for pnpm parity with no behavior wired.
Default false; the audit fails CI when a setting with a
supported scalar type has no resolved::<name> call site
anywhere in the workspace and this flag is not set.
Marks a setting as part of the npm-shared .npmrc surface:
npm (and yarn / pnpm) read it from .npmrc too, so
aube config set writes it there to keep the multi-tool
contract. Aube-specific / pnpm-only settings leave this
false and route to aube’s own config (config.toml).
Trait Implementations§
Source§impl Clone for SettingMeta
impl Clone for SettingMeta
Source§fn clone(&self) -> SettingMeta
fn clone(&self) -> SettingMeta
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreimpl Copy for SettingMeta
Auto Trait Implementations§
impl Freeze for SettingMeta
impl RefUnwindSafe for SettingMeta
impl Send for SettingMeta
impl Sync for SettingMeta
impl Unpin for SettingMeta
impl UnsafeUnpin for SettingMeta
impl UnwindSafe for SettingMeta
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more