swayfmt 0.38.0

Sway language formatter.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

pub use crate::error::FormatterError;
use crate::{
    config::{
        comments::Comments, expr::Expressions, heuristics::Heuristics, imports::Imports,
        items::Items, lists::Lists, literals::Literals, ordering::Ordering, user_def::Structures,
        user_opts::*, whitespace::Whitespace,
    },
    constants::SWAY_FORMAT_FILE_NAME,
    error::ConfigError,
};
use forc_tracing::println_yellow_err;
use forc_util::find_parent_dir_with_file;
use serde::{Deserialize, Serialize};
use std::path::{Path, PathBuf};

/// A finalized `swayfmt` config.
#[derive(Debug, Default, Clone)]
pub struct Config {
    pub whitespace: Whitespace,
    pub imports: Imports,
    pub ordering: Ordering,
    pub items: Items,
    pub lists: Lists,
    pub literals: Literals,
    pub expressions: Expressions,
    pub heuristics: Heuristics,
    pub structures: Structures,
    pub comments: Comments,
}

/// A direct mapping to an optional `swayfmt.toml`.
#[derive(Serialize, Deserialize, Debug, Copy, Clone)]
#[serde(rename_all = "snake_case")]
pub struct ConfigOptions {
    pub whitespace: Option<WhitespaceOptions>,
    pub imports: Option<ImportsOptions>,
    pub ordering: Option<OrderingOptions>,
    pub items: Option<ItemsOptions>,
    pub lists: Option<ListsOptions>,
    pub literals: Option<LiteralsOptions>,
    pub expressions: Option<ExpressionsOptions>,
    pub heuristics: Option<HeuristicsOptions>,
    pub structures: Option<StructuresOptions>,
    pub comments: Option<CommentsOptions>,
}

impl Config {
    /// Construct the set of configuration to be used from the given set of options.
    ///
    pub fn from_opts(opts: ConfigOptions) -> Self {
        Self {
            whitespace: opts
                .whitespace
                .as_ref()
                .map(Whitespace::from_opts)
                .unwrap_or_default(),
            imports: opts
                .imports
                .as_ref()
                .map(Imports::from_opts)
                .unwrap_or_default(),
            ordering: opts
                .ordering
                .as_ref()
                .map(Ordering::from_opts)
                .unwrap_or_default(),
            items: opts
                .items
                .as_ref()
                .map(Items::from_opts)
                .unwrap_or_default(),
            lists: opts
                .lists
                .as_ref()
                .map(Lists::from_opts)
                .unwrap_or_default(),
            literals: opts
                .literals
                .as_ref()
                .map(Literals::from_opts)
                .unwrap_or_default(),
            expressions: opts
                .expressions
                .as_ref()
                .map(Expressions::from_opts)
                .unwrap_or_default(),
            heuristics: opts
                .heuristics
                .as_ref()
                .map(Heuristics::from_opts)
                .unwrap_or_default(),
            structures: opts
                .structures
                .as_ref()
                .map(Structures::from_opts)
                .unwrap_or_default(),
            comments: opts
                .comments
                .as_ref()
                .map(Comments::from_opts)
                .unwrap_or_default(),
        }
    }
    /// Given a directory to a forc project containing a `swayfmt.toml`, read and
    /// construct a `Config` from the project's `swayfmt.toml` configuration file.
    ///
    /// This is a combination of `ConfigOptions::from_dir` and `Config::from_opts`,
    /// and takes care of constructing a finalized config.
    pub fn from_dir(config_path: &Path) -> Result<Self, ConfigError> {
        let config_opts = ConfigOptions::from_dir(config_path)?;
        Ok(Self::from_opts(config_opts))
    }
}

impl ConfigOptions {
    /// Given a path to a `swayfmt.toml`, read and construct the `ConfigOptions`.
    pub fn from_file(config_path: PathBuf) -> Result<Self, ConfigError> {
        let config_str =
            std::fs::read_to_string(&config_path).map_err(|e| ConfigError::ReadConfig {
                path: config_path,
                err: e,
            })?;
        let toml_de = &mut toml::de::Deserializer::new(&config_str);
        let config_opts: Self = serde_ignored::deserialize(toml_de, |field| {
            let warning = format!("  WARNING! found unusable configuration: {field}");
            println_yellow_err(&warning);
        })
        .map_err(|e| ConfigError::Deserialize { err: (e) })?;
        Ok(config_opts)
    }
    /// Given a directory to a forc project containing a `swayfmt.toml`, read the config.
    ///
    /// This is short for `ConfigOptions::from_file`, but takes care of constructing the path to the
    /// file.
    pub fn from_dir(dir: &Path) -> Result<Self, ConfigError> {
        let config_dir =
            find_parent_dir_with_file(dir, SWAY_FORMAT_FILE_NAME).ok_or(ConfigError::NotFound)?;
        let file_path = config_dir.join(SWAY_FORMAT_FILE_NAME);
        Self::from_file(file_path)
    }
}