♻️ (config): Ajustes con #[settings] al arrancar
- Nuevo atributo `#[settings]`: valores por defecto en los campos (tipos comprobados al compilar y documentados); claves desconocidas y valores no válidos rechazados. Sustituye a `include_config!`, que se elimina. - `LazySettings<T>::new()` declara los ajustes de una sección, y `Extension::settings()` los carga al arrancar, en orden; un error de configuración o una sección reclamada dos veces detiene el arranque. - Aviso de secciones que no corresponden a ninguna extensión. - Bootsier: [dev] bootsier_static_dir pasa a [bootsier] static_dir.
This commit is contained in:
parent
8a7a827259
commit
728a5c83dc
32 changed files with 918 additions and 488 deletions
|
|
@ -1,4 +1,4 @@
|
|||
//! Opciones de configuración del tema.
|
||||
//! Ajustes de configuración de `pagetop-bootsier`.
|
||||
//!
|
||||
//! Ejemplo:
|
||||
//!
|
||||
|
|
@ -13,46 +13,46 @@
|
|||
//! # use pagetop::prelude::*;
|
||||
//! use pagetop_bootsier::config;
|
||||
//!
|
||||
//! assert_eq!(config::SETTINGS.bootsier.max_width, UnitValue::Px(1440));
|
||||
//! assert_eq!(config::SETTINGS.max_width, UnitValue::RelRem(90.0));
|
||||
//! ```
|
||||
//!
|
||||
//! Todas las opciones, con su valor por defecto, se documentan en [`BootsierSettings`].
|
||||
//!
|
||||
//! Consulta [`pagetop::config`] para ver cómo PageTop lee los archivos de configuración y aplica
|
||||
//! los valores a los ajustes.
|
||||
|
||||
use pagetop::prelude::*;
|
||||
|
||||
use serde::Deserialize;
|
||||
/// Ajustes de la sección `[bootsier]`, cargados al arrancar la aplicación.
|
||||
pub static SETTINGS: LazySettings<BootsierSettings> = LazySettings::new();
|
||||
|
||||
include_config!(SETTINGS: Settings => [
|
||||
// [bootsier]
|
||||
"bootsier.max_width" => "1440px",
|
||||
// [dev]
|
||||
"dev.bootsier_static_dir" => "",
|
||||
]);
|
||||
|
||||
/// Ajustes para la sección [`Bootsier`] de [`SETTINGS`].
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct Settings {
|
||||
pub bootsier: Bootsier,
|
||||
pub dev: Dev,
|
||||
}
|
||||
|
||||
/// Sección **`[bootsier]`** de la configuración. Forma parte de [`Settings`].
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct Bootsier {
|
||||
/// Sección **`[bootsier]`** de la configuración.
|
||||
#[settings(section = "bootsier")]
|
||||
pub struct BootsierSettings {
|
||||
/// Ancho máximo predeterminado para la página, por ejemplo "100%" o "90rem".
|
||||
#[default(UnitValue::Px(1440))]
|
||||
pub max_width: UnitValue,
|
||||
}
|
||||
|
||||
/// Sección **`[dev]`** de la configuración. Forma parte de [`Settings`].
|
||||
#[derive(Debug, Deserialize)]
|
||||
pub struct Dev {
|
||||
/// Directorio raíz de `static/` para servir los archivos estáticos propios de Bootsier.
|
||||
///
|
||||
/// Si se indica una ruta válida, absoluta o relativa al directorio del proyecto o del binario
|
||||
/// en ejecución, los archivos estáticos se servirán desde disco. Útil para poder modificar los
|
||||
/// archivos estáticos mientras la aplicación está en ejecución, sin necesidad de recompilar.
|
||||
/// Si se indica una ruta válida, absoluta o relativa al directorio del proyecto (o, al ejecutar
|
||||
/// el binario, al directorio de trabajo actual), los archivos estáticos se servirán desde
|
||||
/// disco. Útil durante el desarrollo para poder modificar los archivos estáticos mientras la
|
||||
/// aplicación está en ejecución, sin necesidad de recompilar.
|
||||
///
|
||||
/// Si la cadena está vacía, se ignora este ajuste.
|
||||
pub bootsier_static_dir: String,
|
||||
pub static_dir: String,
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::{BootsierSettings, config};
|
||||
|
||||
// `reference.toml` documents every option; with unknown keys rejected, loading it proves that
|
||||
// it only documents keys that exist, with values of the right type.
|
||||
const REFERENCE: &str = include_str!("../../../config/reference.toml");
|
||||
|
||||
#[test]
|
||||
fn reference_toml_documents_only_existing_keys() {
|
||||
config::load_from_str::<BootsierSettings>(REFERENCE).unwrap();
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue