shuck-formatter 0.1.0

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

use shuck_ast::Stmt;

use crate::context::RenderContext;

use super::body_site::CompoundBodySite;
use super::shape::{
    can_format_multiline_subshell_inline, can_inline_group, can_inline_source_line_subshell,
    group_has_inline_source_shape,
};

#[derive(Debug, Clone, Copy)]
pub(crate) struct FunctionBodyPlan<'a> {
    body: &'a Stmt,
    layout: FunctionBodyLayout<'a>,
}

#[derive(Debug, Clone, Copy)]
pub(crate) enum FunctionBodyLayout<'a> {
    FallbackStmt,
    BraceGroup {
        site: CompoundBodySite<'a>,
        layout: FunctionBodyGroupLayout,
    },
    Subshell {
        site: CompoundBodySite<'a>,
        layout: FunctionSubshellLayout,
    },
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum FunctionBodyGroupLayout {
    Inline,
    Multiline,
    HeaderComment,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub(crate) enum FunctionSubshellLayout {
    Inline { source_line: bool },
    MultilineInline,
    Multiline,
}

impl<'a> FunctionBodyPlan<'a> {
    pub(crate) fn for_body(
        body: &'a Stmt,
        upper_bound: usize,
        has_header_comment: bool,
        context: RenderContext<'_, '_>,
    ) -> Self {
        let Some(site) = CompoundBodySite::function_group_body(body, upper_bound) else {
            return Self {
                body,
                layout: FunctionBodyLayout::FallbackStmt,
            };
        };

        let layout = match site.group_open_char() {
            Some('{') => FunctionBodyLayout::BraceGroup {
                site,
                layout: brace_group_layout(site, has_header_comment, context),
            },
            Some('(') => FunctionBodyLayout::Subshell {
                site,
                layout: subshell_layout(site, context),
            },
            _ => unreachable!("function body group uses brace or subshell syntax"),
        };
        Self { body, layout }
    }

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

    pub(crate) fn layout(self) -> FunctionBodyLayout<'a> {
        self.layout
    }
}

fn brace_group_layout(
    site: CompoundBodySite<'_>,
    has_header_comment: bool,
    context: RenderContext<'_, '_>,
) -> FunctionBodyGroupLayout {
    if has_header_comment {
        return FunctionBodyGroupLayout::HeaderComment;
    }

    let body = site.body();
    let upper_bound = site.bounds().render_limit();
    if !context.options.function_next_line()
        && context
            .facts
            .sequence(body, upper_bound)
            .group_open_suffix_span()
            .is_none()
        && group_has_inline_source_shape(context, body, '{')
        && can_inline_group(context, body, '{')
    {
        FunctionBodyGroupLayout::Inline
    } else {
        FunctionBodyGroupLayout::Multiline
    }
}

fn subshell_layout(
    site: CompoundBodySite<'_>,
    context: RenderContext<'_, '_>,
) -> FunctionSubshellLayout {
    let body = site.body();
    let upper_bound = site.bounds().render_limit();
    let sequence = context.facts.sequence(body, upper_bound);
    let group_inline =
        group_has_inline_source_shape(context, body, '(') && can_inline_group(context, body, '(');
    let source_line_inline = can_inline_source_line_subshell(context, body, upper_bound);

    if !context.options.function_next_line()
        && sequence.group_open_suffix_span().is_none()
        && (group_inline || source_line_inline)
    {
        return FunctionSubshellLayout::Inline {
            source_line: source_line_inline && !group_inline,
        };
    }

    if can_format_multiline_subshell_inline(context, body, upper_bound) {
        FunctionSubshellLayout::MultilineInline
    } else {
        FunctionSubshellLayout::Multiline
    }
}