scriptoriumadmin/fabro
1
0
Fork 0
mirror of https://github.com/fabro-sh/fabro.git synced 2026-09-15 23:32:46 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3

docs(config): point new code at ConfigLayer::as_v2 rather than the bridge

Browse source
This commit is contained in:
Bryan Helmkamp 2026-04-09 11:38:00 -04:00
parent 3dd3c7bf8b
commit 31db613aa0
No known key found for this signature in database
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lib/crates/fabro-config/src/config.rs
View file

@ -1,15 +1,16 @@
//! v2-backed configuration layer.
//!
//! `ConfigLayer` is now a newtype over [`SettingsFile`] — the v2 namespaced
//! parse tree in `fabro_types::settings::v2`. Loading functions return the
//! same `ConfigLayer` type they always have; internally they call
//! `parse_settings_file`, which hard-fails on any legacy top-level key with a
//! targeted rename hint.
//! `ConfigLayer` is a newtype over [`SettingsFile`] — the v2 namespaced
//! parse tree in `fabro_types::settings::v2`. Loading functions (`parse`,
//! `load`, `for_workflow`, `project`, `settings`) all hard-fail on legacy
//! top-level keys with targeted rename hints. `ConfigLayer::combine` walks
//! the v2 merge matrix from [`crate::merge`].
//!
//! `ConfigLayer::combine` walks the v2 merge matrix from `crate::merge`.
//! `ConfigLayer::resolve` uses the temporary bridge in
//! `fabro_types::settings::v2::bridge` to produce the legacy flat [`Settings`]
//! shape until Stage 4 migrates consumers off it.
//! [`ConfigLayer::resolve`] uses the transitional bridge in
//! [`fabro_types::settings::v2::bridge`] to produce the legacy flat
//! [`Settings`] shape that most consumers still read. New code should prefer
//! [`ConfigLayer::as_v2`] to read v2 fields directly; the bridge and the old
//! flat shape are scheduled for removal once every consumer is migrated.
use std::path::Path;