shuck-formatter 0.0.17

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

use shuck_format::FormatContext;

use crate::comments::Comments;
use crate::options::ResolvedShellFormatOptions;

#[derive(Debug, Clone)]
pub struct ShellFormatContext<'a> {
    options: ResolvedShellFormatOptions,
    source: &'a str,
    comments: Comments<'a>,
}

impl<'a> ShellFormatContext<'a> {
    #[must_use]
    pub fn new(
        options: ResolvedShellFormatOptions,
        source: &'a str,
        comments: Comments<'a>,
    ) -> Self {
        Self {
            options,
            source,
            comments,
        }
    }

    #[must_use]
    pub fn source(&self) -> &'a str {
        self.source
    }

    #[must_use]
    pub fn options(&self) -> &ResolvedShellFormatOptions {
        &self.options
    }

    #[must_use]
    pub fn comments(&self) -> &Comments<'a> {
        &self.comments
    }

    pub fn comments_mut(&mut self) -> &mut Comments<'a> {
        &mut self.comments
    }
}

impl FormatContext for ShellFormatContext<'_> {
    type Options = ResolvedShellFormatOptions;

    fn options(&self) -> &Self::Options {
        &self.options
    }

    fn source_length_hint(&self) -> usize {
        self.source.len()
    }
}