ardent 0.1.0

Opinionated formatter for NSIS scripts
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

pub mod canonical_casing;
pub mod canonical_parameters;
pub mod parser;
pub mod printer;
pub mod rules;

use parser::parse;
use printer::{PrinterOptions, print};

const DEFAULT_INDENT_SIZE: usize = 2;

#[derive(Debug, Clone)]
pub enum EndOfLines {
	Crlf,
	Lf,
}

#[derive(Debug, Clone)]
pub struct DentOptions {
	pub end_of_lines: Option<EndOfLines>,
	pub indent_size: usize,
	pub trim_empty_lines: bool,
	pub use_tabs: bool,
}

impl Default for DentOptions {
	fn default() -> Self {
		Self {
			end_of_lines: None,
			indent_size: DEFAULT_INDENT_SIZE,
			trim_empty_lines: true,
			use_tabs: true,
		}
	}
}

pub struct Formatter {
	options: DentOptions,
}

impl Formatter {
	pub fn new(options: DentOptions) -> Result<Self, String> {
		if !options.use_tabs
			&& options.indent_size == 0 {
				return Err("The indent_size option expects a positive integer".to_string());
			}
		Ok(Self { options })
	}

	pub fn format(&self, input: &str) -> Result<String, String> {
		let nodes = parse(input)?;
		let eol = self.detect_eol(input);

		Ok(print(
			&nodes,
			&PrinterOptions {
				use_tabs: self.options.use_tabs,
				indent_size: self.options.indent_size,
				trim_empty_lines: self.options.trim_empty_lines,
				eol,
			},
		))
	}

	pub fn check(&self, input: &str) -> Result<Option<String>, String> {
		let formatted = self.format(input)?;
		if formatted == input {
			Ok(None)
		} else {
			Ok(Some(formatted))
		}
	}

	fn detect_eol(&self, input: &str) -> String {
		if let Some(ref eol) = self.options.end_of_lines {
			return match eol {
				EndOfLines::Crlf => "\r\n".to_string(),
				EndOfLines::Lf => "\n".to_string(),
			};
		}

		if input.contains("\r\n") || cfg!(windows) {
			"\r\n".to_string()
		} else {
			"\n".to_string()
		}
	}
}

#[cfg(test)]
mod tests {
	use super::*;

	#[test]
	fn format_basic() {
		let formatter = Formatter::new(DentOptions {
			end_of_lines: Some(EndOfLines::Lf),
			..Default::default()
		})
		.unwrap();

		let result = formatter
			.format("section \"Test\"\nDetailPrint \"hello\"\nsectionend\n")
			.unwrap();
		assert_eq!(
			result,
			"Section \"Test\"\n\tDetailPrint \"hello\"\nSectionEnd\n"
		);
	}

	#[test]
	fn check_returns_none_when_formatted() {
		let formatter = Formatter::new(DentOptions {
			end_of_lines: Some(EndOfLines::Lf),
			..Default::default()
		})
		.unwrap();

		let input = "Section \"Test\"\n\tDetailPrint \"hello\"\nSectionEnd\n";
		assert!(formatter.check(input).unwrap().is_none());
	}

	#[test]
	fn check_returns_some_when_unformatted() {
		let formatter = Formatter::new(DentOptions {
			end_of_lines: Some(EndOfLines::Lf),
			..Default::default()
		})
		.unwrap();

		let input = "section \"Test\"\nDetailPrint \"hello\"\nsectionend\n";
		assert!(formatter.check(input).unwrap().is_some());
	}

	#[test]
	fn spaces_indent() {
		let formatter = Formatter::new(DentOptions {
			end_of_lines: Some(EndOfLines::Lf),
			use_tabs: false,
			indent_size: 4,
			..Default::default()
		})
		.unwrap();

		let result = formatter
			.format("section \"Test\"\nDetailPrint \"hello\"\nsectionend\n")
			.unwrap();
		assert_eq!(
			result,
			"Section \"Test\"\n    DetailPrint \"hello\"\nSectionEnd\n"
		);
	}
}