Struct FormatterConfig 

pub struct FormatterConfig {
    pub indent_width: usize,
    pub use_tabs: bool,
    pub quote_variables: bool,
    pub use_double_brackets: bool,
    pub normalize_functions: bool,
    pub inline_then: bool,
    pub space_before_brace: bool,
    pub preserve_blank_lines: bool,
    pub max_blank_lines: usize,
    pub ignore_patterns: Vec<String>,
}

Configuration for bash script formatting

Examples

use bashrs::bash_quality::FormatterConfig;

let config = FormatterConfig::default();
assert_eq!(config.indent_width, 2);
assert!(!config.use_tabs);

Fields

indent_width: usize

Number of spaces per indentation level (default: 2, bash standard)

use_tabs: bool

Use tabs instead of spaces for indentation (default: false)

quote_variables: bool

Quote all variable expansions (default: true)

use_double_brackets: bool

Use [[ ]] instead of [ ] for tests (default: true)

normalize_functions: bool

Normalize function syntax to name() { } (default: true)

inline_then: bool

Put ‘then’ on same line as ‘if’ (default: true)

space_before_brace: bool

Add space before function braces (default: true)

preserve_blank_lines: bool

Preserve existing blank lines (default: true)

max_blank_lines: usize

Maximum consecutive blank lines (default: 2)

ignore_patterns: Vec<String>

Ignore files matching these patterns (default: empty)

Implementations

impl FormatterConfig

pub fn new() -> Self

Create a new configuration with default values

Examples

use bashrs::bash_quality::FormatterConfig;

let config = FormatterConfig::new();
assert_eq!(config.indent_width, 2);

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self, String>

Load configuration from a TOML file

Errors

Returns an error if:

• The file cannot be read
• The TOML is invalid

Examples

use bashrs::bash_quality::FormatterConfig;

let config = FormatterConfig::from_file(".bashrs-fmt.toml").unwrap();
println!("Indent width: {}", config.indent_width);

pub fn from_toml(toml_str: &str) -> Result<Self, String>

Load configuration from TOML string

Errors

Returns an error if the TOML is invalid

Examples

use bashrs::bash_quality::FormatterConfig;

let toml = r#"
indent_width = 4
use_tabs = true
"#;

let config = FormatterConfig::from_toml(toml).unwrap();
assert_eq!(config.indent_width, 4);
assert!(config.use_tabs);

pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<(), String>

Save configuration to a TOML file

Errors

Returns an error if the file cannot be written

Examples

use bashrs::bash_quality::FormatterConfig;

let config = FormatterConfig::default();
config.to_file(".bashrs-fmt.toml").unwrap();

pub fn to_toml(&self) -> Result<String, String>

Convert configuration to TOML string

Errors

Returns an error if serialization fails

Examples

use bashrs::bash_quality::FormatterConfig;

let config = FormatterConfig::default();
let toml = config.to_toml().unwrap();
assert!(toml.contains("indent_width"));

pub fn should_ignore(&self, path: &str) -> bool

Check if a file path should be ignored based on patterns

Examples

use bashrs::bash_quality::FormatterConfig;

let mut config = FormatterConfig::default();
config.ignore_patterns = vec!["**/test/**".to_string()];

assert!(config.should_ignore("src/test/example.sh"));
assert!(!config.should_ignore("src/main.sh"));

pub fn merge(&mut self, other: Self)

Merge with another configuration, preferring non-default values

Examples

use bashrs::bash_quality::FormatterConfig;

let mut base = FormatterConfig::default();
let mut override_config = FormatterConfig::default();
override_config.indent_width = 4;

base.merge(override_config);
assert_eq!(base.indent_width, 4);

Trait Implementations

impl Clone for FormatterConfig

fn clone(&self) -> FormatterConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FormatterConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FormatterConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FormatterConfig

where FormatterConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FormatterConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.