shuck-formatter 0.1.1

Shell script formatter with configurable style options
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
142
143
144
145
146
147
148
149
150
151
152
153

use shuck_ast::{Span, StmtSeq};

use crate::context::RenderContext;

use super::body_site::{CompoundBodyOpen, CompoundBodySite};
use super::shape::{
    body_starts_with_inline_do_brace_group, body_starts_with_inline_do_if,
    can_inline_body_with_upper_bound, inline_do_brace_group_done_separator,
};

#[derive(Debug, Clone, Copy)]
pub(crate) struct CompoundBodyPlan<'a> {
    site: CompoundBodySite<'a>,
    layout: CompoundBodyLayout,
    open_suffix_span: Option<Span>,
    preserve_open_blank: bool,
    preserve_close_blank: bool,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum CompoundBodyLayout {
    DoDone(DoDoneBodyLayout),
    DirectInline,
    BraceGroup { prefix: &'static str },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum DoDoneBodyLayout {
    Inline,
    LegacyInline { close_separator: &'static str },
    Multiline { open: &'static str },
}

impl<'a> CompoundBodyPlan<'a> {
    pub(crate) fn loop_body(
        site: CompoundBodySite<'a>,
        brace_prefix: &'static str,
        context: RenderContext<'_, '_>,
    ) -> Self {
        match site.open() {
            CompoundBodyOpen::Keyword("do") => Self::do_done(site, context),
            CompoundBodyOpen::Direct => {
                Self::from_layout(site, CompoundBodyLayout::DirectInline, context)
            }
            CompoundBodyOpen::Group('{') => Self::brace_group(site, brace_prefix, context),
            _ => unreachable!("compound body uses do, direct, or brace syntax"),
        }
    }

    pub(crate) fn do_done(site: CompoundBodySite<'a>, context: RenderContext<'_, '_>) -> Self {
        let body = site.body();
        let body_upper_bound = site.bounds().render_end();
        let open_suffix_span = context
            .facts
            .sequence(body, Some(body_upper_bound))
            .group_open_suffix_span();
        let layout = if open_suffix_span.is_none() {
            if can_inline_body_with_upper_bound(
                context,
                body,
                site.enclosing_span(),
                Some(body_upper_bound),
            ) {
                DoDoneBodyLayout::Inline
            } else if body_starts_with_inline_do_brace_group(context, body) {
                DoDoneBodyLayout::LegacyInline {
                    close_separator: inline_do_brace_group_done_separator(
                        context,
                        body,
                        site.enclosing_span(),
                    ),
                }
            } else if body_starts_with_inline_do_if(context, body) {
                DoDoneBodyLayout::LegacyInline {
                    close_separator: "; ",
                }
            } else {
                DoDoneBodyLayout::Multiline { open: "; do" }
            }
        } else {
            DoDoneBodyLayout::Multiline { open: "; do" }
        };
        Self::from_layout(site, CompoundBodyLayout::DoDone(layout), context)
    }

    pub(crate) fn split_do_done(
        site: CompoundBodySite<'a>,
        context: RenderContext<'_, '_>,
    ) -> Self {
        Self::from_layout(
            site,
            CompoundBodyLayout::DoDone(DoDoneBodyLayout::Multiline { open: "do" }),
            context,
        )
    }

    pub(crate) fn brace_group(
        site: CompoundBodySite<'a>,
        prefix: &'static str,
        context: RenderContext<'_, '_>,
    ) -> Self {
        Self::from_layout(site, CompoundBodyLayout::BraceGroup { prefix }, context)
    }

    fn from_layout(
        site: CompoundBodySite<'a>,
        layout: CompoundBodyLayout,
        context: RenderContext<'_, '_>,
    ) -> Self {
        let body = site.body();
        let upper_bound = site.bounds().render_limit();
        let sequence = context.facts.sequence(body, upper_bound);
        Self {
            site,
            layout,
            open_suffix_span: sequence.group_open_suffix_span(),
            preserve_open_blank: sequence.has_blank_line_after_open(),
            preserve_close_blank: sequence.has_blank_line_before_close(),
        }
    }

    pub(crate) fn body(self) -> &'a StmtSeq {
        self.site.body()
    }

    pub(crate) fn body_upper_bound(self) -> usize {
        self.site.bounds().render_end()
    }

    pub(crate) fn upper_bound(self) -> Option<usize> {
        self.site.bounds().render_limit()
    }

    pub(crate) fn close_span(self) -> Option<Span> {
        self.site.close_span()
    }

    pub(crate) fn layout(self) -> CompoundBodyLayout {
        self.layout
    }

    pub(crate) fn open_suffix_span(self) -> Option<Span> {
        self.open_suffix_span
    }

    pub(crate) fn preserve_open_blank(self) -> bool {
        self.preserve_open_blank
    }

    pub(crate) fn preserve_close_blank(self) -> bool {
        self.preserve_close_blank
    }
}