swayfmt 0.31.2

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

//! Configuration options related to item formatting.
use crate::{
    config::{lists::ListTactic, user_opts::ItemsOptions},
    constants::{DEFAULT_BLANK_LINES_LOWER_BOUND, DEFAULT_BLANK_LINES_UPPER_BOUND},
};
use serde::{Deserialize, Serialize};

#[derive(Debug, Copy, Clone)]
pub struct Items {
    /// Brace style for items.
    pub item_brace_style: ItemBraceStyle,
    /// Maximum number of blank lines which can be put between items.
    pub blank_lines_upper_bound: usize,
    /// Minimum number of blank lines which must be put between items.
    pub blank_lines_lower_bound: usize,
    /// Put empty-body functions and impls on a single line.
    pub empty_item_single_line: bool,
}

impl Default for Items {
    fn default() -> Self {
        Self {
            item_brace_style: ItemBraceStyle::SameLineWhere,
            blank_lines_upper_bound: DEFAULT_BLANK_LINES_UPPER_BOUND,
            blank_lines_lower_bound: DEFAULT_BLANK_LINES_LOWER_BOUND,
            empty_item_single_line: true,
        }
    }
}

impl Items {
    pub fn from_opts(opts: &ItemsOptions) -> Self {
        let default = Self::default();
        Self {
            item_brace_style: opts.item_brace_style.unwrap_or(default.item_brace_style),
            blank_lines_upper_bound: opts
                .blank_lines_upper_bound
                .unwrap_or(default.blank_lines_upper_bound),
            blank_lines_lower_bound: opts
                .blank_lines_lower_bound
                .unwrap_or(default.blank_lines_lower_bound),
            empty_item_single_line: opts
                .empty_item_single_line
                .unwrap_or(default.empty_item_single_line),
        }
    }
}

/// Preference of how list-like items are displayed.
#[derive(Serialize, Deserialize, Debug, Copy, Clone)]
pub enum ItemsLayout {
    /// Fit as much on one line as possible.
    Compressed,
    /// Items are placed horizontally if sufficient space, vertically otherwise.
    Tall,
    /// Place every item on a separate line.
    Vertical,
}

impl ItemsLayout {
    pub fn to_list_tactic(self, len: usize) -> ListTactic {
        match self {
            ItemsLayout::Compressed => ListTactic::Mixed,
            ItemsLayout::Tall => ListTactic::HorizontalVertical,
            ItemsLayout::Vertical if len == 1 => ListTactic::Horizontal,
            ItemsLayout::Vertical => ListTactic::Vertical,
        }
    }
}

/// Where to put the opening brace of items (`fn`, `impl`, etc.).
#[derive(Serialize, Deserialize, Debug, Copy, Clone)]
pub enum ItemBraceStyle {
    /// Put the opening brace on the next line.
    AlwaysNextLine,
    /// Put the opening brace on the same line, if possible.
    PreferSameLine,
    /// Prefer the same line except where there is a where-clause, in which
    /// case force the brace to be put on the next line.
    SameLineWhere,
}