Struct stylua_lib::Config

pub struct Config {
    pub column_width: usize,
    pub line_endings: LineEndings,
    pub indent_type: IndentType,
    pub indent_width: usize,
    pub quote_style: QuoteStyle,
    pub no_call_parentheses: bool,
    pub call_parentheses: CallParenType,
    pub collapse_simple_statement: CollapseSimpleStatement,
    pub sort_requires: SortRequiresConfig,
}

The configuration to use when formatting.

Fields

column_width: usize

The approximate line length to use when printing the code. This is used as a guide to determine when to wrap lines, but note that this is not a hard upper bound.

line_endings: LineEndings

The type of line endings to use.

indent_type: IndentType

The type of indents to use.

indent_width: usize

The width of a single indentation level. If indent_type is set to IndentType::Spaces, then this is the number of spaces to use. If indent_type is set to IndentType::Tabs, then this is used as a heuristic to guide when to wrap lines.

quote_style: QuoteStyle

The style of quotes to use in string literals.

no_call_parentheses: bool

👎Deprecated: use call_parentheses instead

Whether to omit parentheses around function calls which take a single string literal or table. This is added for adoption reasons only, and is not recommended for new work.

call_parentheses: CallParenType

When to use call parentheses. if call_parentheses is set to CallParenType::Always call parentheses is always applied. if call_parentheses is set to CallParenType::NoSingleTable call parentheses is omitted when function is called with only one string argument. if call_parentheses is set to CallParenType::NoSingleTable call parentheses is omitted when function is called with only one table argument. if call_parentheses is set to CallParenType::None call parentheses is omitted when function is called with only one table or string argument (same as no_call_parentheses).

collapse_simple_statement: CollapseSimpleStatement

Whether we should collapse simple structures like functions or guard statements if set to [CollapseSimpleStatement::None] structures are never collapsed. if set to CollapseSimpleStatement::FunctionOnly then simple functions (i.e., functions with a single laststmt) can be collapsed

sort_requires: SortRequiresConfig

Configuration for the sort requires codemod

Implementations

impl Config

pub fn new() -> Self

Creates a new Config with the default values

pub fn column_width(&self) -> usize

👎Deprecated since 0.19.0: access .column_width directly instead

Returns the current configured column width

pub fn line_endings(&self) -> LineEndings

👎Deprecated since 0.19.0: access .line_endings directly instead

Returns the current configured line endings

pub fn indent_type(&self) -> IndentType

👎Deprecated since 0.19.0: access .indent_type directly instead

Returns the current configured indent type

pub fn indent_width(&self) -> usize

👎Deprecated since 0.19.0: access .indent_width directly instead

Returns the current configured indent width

pub fn quote_style(&self) -> QuoteStyle

👎Deprecated since 0.19.0: access .quote_style directly instead

Returns the current configured quote style

pub fn call_parentheses(&self) -> CallParenType

👎Deprecated since 0.19.0: access .call_parentheses directly instead

Returns the current configured call parentheses style

pub fn collapse_simple_statement(&self) -> CollapseSimpleStatement

👎Deprecated since 0.19.0: access .collapse_simple_statement directly instead

pub fn sort_requires(&self) -> SortRequiresConfig

👎Deprecated since 0.19.0: access .sort_requires directly instead

Returns the current sort requires codemod configuration

pub fn with_column_width(self, column_width: usize) -> Self

👎Deprecated since 0.19.0: modify .column_width directly instead

Returns a new config with the given column width

pub fn with_line_endings(self, line_endings: LineEndings) -> Self

👎Deprecated since 0.19.0: modify .line_endings directly instead

Returns a new config with the given line endings

pub fn with_indent_type(self, indent_type: IndentType) -> Self

👎Deprecated since 0.19.0: modify .indent_type directly instead

Returns a new config with the given indent type

pub fn with_indent_width(self, indent_width: usize) -> Self

👎Deprecated since 0.19.0: modify .indent_width directly instead

Returns a new config with the given indent width

pub fn with_quote_style(self, quote_style: QuoteStyle) -> Self

👎Deprecated since 0.19.0: modify .quote_style directly instead

Returns a new config with the given quote style

pub fn with_no_call_parentheses(self, no_call_parentheses: bool) -> Self

👎Deprecated: use `call_parentheses

Returns a new config with the given value for no_call_parentheses

pub fn with_call_parentheses(self, call_parentheses: CallParenType) -> Self

👎Deprecated since 0.19.0: modify .call_parentheses directly instead

Returns a new config with the given call parentheses type

pub fn with_collapse_simple_statement( self, collapse_simple_statement: CollapseSimpleStatement ) -> Self

👎Deprecated since 0.19.0: modify .collapse_simple_statement directly instead

pub fn with_sort_requires(self, sort_requires: SortRequiresConfig) -> Self

👎Deprecated since 0.19.0: modify .sort_requires directly instead

Returns a new config with the given sort requires configuration

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configwhere Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Copy for Config