dotfiles_core/lib.rs
1// Copyright (c) 2021-2026 Miguel Barreto and others
2//
3// Permission is hereby granted, free of charge, to any person obtaining
4// a copy of this software and associated documentation files (the
5// "Software"), to deal in the Software without restriction, including
6// without limitation the rights to use, copy, modify, merge, publish,
7// distribute, sublicense, and/or sell copies of the Software, and to
8// permit persons to whom the Software is furnished to do so, subject to
9// the following conditions:
10//
11// The above copyright notice and this permission notice shall be
12// included in all copies or substantial portions of the Software.
13//
14// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18// LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19// OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20// WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21
22#![warn(missing_docs)]
23#![deny(rustdoc::broken_intra_doc_links)]
24#![feature(map_try_insert)]
25
26//! The core of Dotfiles-rs is basically a set of [actions](action::Action)
27//! built from configuration sources (StrictYaml is the only supported configuration source
28//! so far).
29//!
30//! The framework parses configuration from the configuration source,
31//! applies default [settings] if necessary, and builds actions that can be executed.
32//!
33//! The base traits and helper functions for these building blocks can be found in the
34//! [action] and [yaml_util] modules.
35pub mod action;
36pub mod error;
37pub mod exec_wrapper;
38pub mod path;
39pub mod settings;
40pub mod yaml_util;
41
42pub use action::Action;
43pub use settings::Setting;
44pub use settings::Settings;