Implement ForceLineEnding option.

Author: Flone-dnb

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "shader-formatter"
-version = "1.2.0"
+version = "1.3.0"
 edition = "2021"
 authors = ["Alexander Tretyakov"]
 license = "MIT"

Cargo.toml

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2024 Alexander "Flone" Tretyakov
+Copyright (c) 2024-2025 Alexander "Flone" Tretyakov
 
 Permission is hereby granted, free of charge, to any
 person obtaining a copy of this software and associated

LICENSE

@@ -74,6 +74,8 @@ Below are the rules that are not checked unless they are specified in your confi
 - **FloatPrefix** (string) - defines required prefix for floating-point variables, for example if this rule is set to `f` then a correct variable may look like this: `fValue`.
 - **GlobalVariablePrefix** (string) - defines required prefix for global variables, this rule is applied before other prefix and case rules so you can have a "mixed" global variables names like "g_iMyVariable" where global prefix is "g_", int prefix is "i" and case is "Camel".
 
+- **ForceLineEnding** (string) - custom line ending, by default the formatter uses line ending according to the OS ("\r\n" for Windows and "\n" for everything else) but you can overwrite this setting by specifying the value, for example: "\n".
+
 # Temporary disabling formatting or checks
 
 Similar to `clang-tidy` you can use `NOLINT` comments to disable checks for certain parts of your code:

README.md

@@ -21,6 +21,7 @@ pub struct Config {
     pub int_prefix: Option<String>,
     pub float_prefix: Option<String>,
     pub global_variable_prefix: Option<String>,
+    pub force_line_ending: Option<String>,
     pub require_docs_on_functions: bool,
     pub require_docs_on_structs: bool,
     pub require_docs_on_fields: bool,
@@ -42,6 +43,7 @@ impl Default for Config {
             int_prefix: None,
             float_prefix: None,
             global_variable_prefix: None,
+            force_line_ending: None,
             require_docs_on_functions: false,
             require_docs_on_structs: false,
             require_docs_on_fields: false,
@@ -154,6 +156,10 @@ impl Config {
                     config.global_variable_prefix =
                         Some(Self::toml_value_to_string(&key, &value)?.to_string());
                 }
+                "ForceLineEnding" => {
+                    config.force_line_ending =
+                        Some(Self::toml_value_to_string(&key, &value)?.to_string());
+                }
                 "RequireDocsOnFunctions" => {
                     config.require_docs_on_functions = Self::toml_value_to_bool(&key, &value)?;
                 }

src/config.rs

@@ -17,11 +17,6 @@ pub const CHANGES_REQUIRED_ERR_MSG: &str = "changes required";
 const NOFORMAT_BEGIN_COMMENT: &str = " NOFORMATBEGIN";
 const NOFORMAT_END_COMMENT: &str = " NOFORMATEND";
 
-#[cfg(windows)]
-const LINE_ENDING: &str = "\r\n";
-#[cfg(not(windows))]
-const LINE_ENDING: &str = "\n";
-
 /// Applies rules on files.
 pub struct Formatter {
     config: Config,
@@ -144,6 +139,16 @@ impl Formatter {
             IndentationRule::FourSpaces => "    ",
         };
 
+        // Prepare line ending.
+        let mut _line_ending = "\n";
+        #[cfg(windows)]
+        {
+            _line_ending = "\r\n";
+        }
+        if let Some(custom_line_ending) = &self.config.force_line_ending {
+            _line_ending = custom_line_ending;
+        }
+
         let mut output = String::with_capacity(content.len());
 
         // Prepare some handy variables...
@@ -209,7 +214,7 @@ impl Formatter {
                         }
 
                         // Add a new line.
-                        output += LINE_ENDING;
+                        output += _line_ending;
                         output += &indentation_text.repeat(nesting_count);
 
                         consecutive_empty_new_line_count += 1;
@@ -490,7 +495,7 @@ impl Formatter {
                             }
                         } else {
                             // Just put bracket to a new line.
-                            output += LINE_ENDING;
+                            output += _line_ending;
                             output += &indentation_text.repeat(nesting_count);
                             output.push(_char);
                         }
@@ -502,7 +507,7 @@ impl Formatter {
                         if !prev_line_ended_with_backslash {
                             // Insert a new line.
                             is_on_new_line = true;
-                            output += LINE_ENDING;
+                            output += _line_ending;
                             output += &indentation_text.repeat(nesting_count);
                             consecutive_empty_new_line_count += 1;
                         }
@@ -519,7 +524,7 @@ impl Formatter {
 
                         // Insert a new line.
                         is_on_new_line = true;
-                        output += LINE_ENDING;
+                        output += _line_ending;
                         output += &indentation_text.repeat(nesting_count);
 
                         // Add brace.
@@ -531,7 +536,7 @@ impl Formatter {
 
                         // Add new line with increased nesting.
                         nesting_count += 1;
-                        output += LINE_ENDING;
+                        output += _line_ending;
                         output += &indentation_text.repeat(nesting_count);
                         consecutive_empty_new_line_count += 1;
                     }
@@ -559,7 +564,7 @@ impl Formatter {
                 // we likelly need to keep the code on the same line.
                 if !line_started_with_preprocessor {
                     // Add a new line.
-                    output += LINE_ENDING;
+                    output += _line_ending;
                     output += &indentation_text.repeat(nesting_count);
                 } else {
                     output.push(' '); // just add a space after text