shuck-formatter 0.0.45

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

use crate::Result;
use crate::comments::SourceMap;
use crate::facts::FormatterFacts;
use crate::options::ResolvedShellFormatOptions;
use shuck_ast::{File, StmtSeq};
use shuck_parser::parser::Parser;

#[derive(Clone, Copy)]
pub(crate) struct RenderContext<'source, 'a> {
    pub(crate) source: &'source str,
    pub(crate) options: &'a ResolvedShellFormatOptions,
    pub(crate) facts: &'a FormatterFacts<'source>,
}

impl<'source, 'a> RenderContext<'source, 'a> {
    pub(crate) fn new(
        source: &'source str,
        options: &'a ResolvedShellFormatOptions,
        facts: &'a FormatterFacts<'source>,
    ) -> Self {
        Self {
            source,
            options,
            facts,
        }
    }

    pub(crate) fn source_map(self) -> &'a SourceMap<'source> {
        self.facts.source_map()
    }

    pub(crate) fn format_stmt_sequence_to_buf(
        self,
        statements: &StmtSeq,
        upper_bound: Option<usize>,
        output: &mut String,
    ) -> Result<()> {
        crate::streaming::format_stmt_sequence_streaming_to_buf(
            self,
            statements,
            upper_bound,
            output,
        )
    }
}

pub(crate) struct FragmentFormatter<'source, 'a> {
    source: &'source str,
    options: &'a ResolvedShellFormatOptions,
    file: File,
    facts: FormatterFacts<'source>,
}

impl<'source, 'a> FragmentFormatter<'source, 'a> {
    pub(crate) fn parse(
        source: &'source str,
        options: &'a ResolvedShellFormatOptions,
    ) -> Option<Self> {
        let parsed = Parser::with_dialect(source, options.dialect()).parse();
        if parsed.is_err() {
            return None;
        }

        let file = parsed.file;
        let facts = FormatterFacts::build(source, &file, options);
        Some(Self {
            source,
            options,
            file,
            facts,
        })
    }

    pub(crate) fn body(&self) -> &StmtSeq {
        &self.file.body
    }

    pub(crate) fn body_len(&self) -> usize {
        self.file.body.len()
    }

    pub(crate) fn facts(&self) -> &FormatterFacts<'source> {
        &self.facts
    }

    pub(crate) fn render_context(&self) -> RenderContext<'source, '_> {
        RenderContext::new(self.source, self.options, &self.facts)
    }

    pub(crate) fn format_body_to_buf(
        &self,
        upper_bound: Option<usize>,
        output: &mut String,
    ) -> Result<()> {
        self.render_context()
            .format_stmt_sequence_to_buf(self.body(), upper_bound, output)
    }

    pub(crate) fn format_body(&self, upper_bound: Option<usize>) -> Result<String> {
        let mut output = String::new();
        self.format_body_to_buf(upper_bound, &mut output)?;
        Ok(output)
    }
}