fix(config): default value for indent_width (#3096)

Author: ematipico

CHANGELOG.md

@@ -11,19 +11,37 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b
 
 ## Unreleased
 
+### Analyzer
+
 ### CLI
 
 #### Bug fixes
 
 - Fix [#3069](https://github.com/biomejs/biome/issues/3069), prevent overwriting paths when using `--staged` or `--changed` options. Contributed by @unvalley
 - Fix the bug where whitespace after the & character in CSS nesting was incorrectly trimmed, ensuring proper targeting of child classes [#3061](https://github.com/biomejs/biome/issues/3061). Contributed by @denbezrukov
 
+
+### Configuration
+
+#### Bug fixes
+
+- Fix [#3067](https://github.com/biomejs/biome/issues/3067), by assigning the correct default value to `indentWidth`. Contributed by @ematipico
+
+### Editors
+
+### Formatter
+
+### JavaScript APIs
+
 ### Linter
 
 #### Bug fixes
 
 - The `no-empty-block` css lint rule now treats empty blocks containing comments as valid ones. Contributed by @Sec-ant
 
+
+### Parser
+
 ## 1.8.0 (2024-06-04)
 
 ### Analyzer
@@ -306,8 +324,6 @@ our [guidelines for writing a good changelog entry](https://github.com/biomejs/b
 - Fix [#2782](https://github.com/biomejs/biome/issues/2782) by computing the enabled rules by taking the override settings into consideration. Contributed by @ematipico
 - Fix [https://github.com/biomejs/biome/issues/2877] by correctly handling line terminators in JSX string. Contributed by @ah-yu
 
-### JavaScript APIs
-
 ### Linter
 
 #### Promoted rules

crates/biome_cli/src/commands/rage.rs

@@ -215,7 +215,7 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Indent style", markup!({DebugDisplay(formatter_configuration.indent_style)}))}
                             {KeyValuePair("Indent width", markup!({DebugDisplay(formatter_configuration.indent_width)}))}
                             {KeyValuePair("Line ending", markup!({DebugDisplay(formatter_configuration.line_ending)}))}
-                            {KeyValuePair("Line width", markup!({DebugDisplay(formatter_configuration.line_width.get())}))}
+                            {KeyValuePair("Line width", markup!({DebugDisplay(formatter_configuration.line_width.value())}))}
                             {KeyValuePair("Attribute position", markup!({DebugDisplay(formatter_configuration.attribute_position)}))}
                             {KeyValuePair("Ignore", markup!({DebugDisplay(formatter_configuration.ignore.iter().collect::<Vec<_>>())}))}
                             {KeyValuePair("Include", markup!({DebugDisplay(formatter_configuration.include.iter().collect::<Vec<_>>())}))}
@@ -237,7 +237,7 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Indent style", markup!({DebugDisplayOption(javascript_formatter_configuration.indent_style)}))}
                             {KeyValuePair("Indent width", markup!({DebugDisplayOption(javascript_formatter_configuration.indent_width)}))}
                             {KeyValuePair("Line ending", markup!({DebugDisplayOption(javascript_formatter_configuration.line_ending)}))}
-                            {KeyValuePair("Line width", markup!({DebugDisplayOption(javascript_formatter_configuration.line_width.map(|lw| lw.get()))}))}
+                            {KeyValuePair("Line width", markup!({DebugDisplayOption(javascript_formatter_configuration.line_width.map(|lw| lw.value()))}))}
                             {KeyValuePair("Attribute position", markup!({DebugDisplay(javascript_formatter_configuration.attribute_position)}))}
                         )
                         .fmt(fmt)?;
@@ -250,7 +250,7 @@ impl Display for RageConfiguration<'_, '_> {
                             {KeyValuePair("Indent style", markup!({DebugDisplayOption(json_formatter_configuration.indent_style)}))}
                             {KeyValuePair("Indent width", markup!({DebugDisplayOption(json_formatter_configuration.indent_width)}))}
                             {KeyValuePair("Line ending", markup!({DebugDisplayOption(json_formatter_configuration.line_ending)}))}
-                            {KeyValuePair("Line width", markup!({DebugDisplayOption(json_formatter_configuration.line_width.map(|lw| lw.get()))}))}
+                            {KeyValuePair("Line width", markup!({DebugDisplayOption(json_formatter_configuration.line_width.map(|lw| lw.value()))}))}
                             {KeyValuePair("Trailing Commas", markup!({DebugDisplayOption(json_formatter_configuration.trailing_commas)}))}
                         ).fmt(fmt)?;
 

crates/biome_cli/src/execute/migrate.rs

@@ -8,7 +8,7 @@ use biome_deserialize::json::deserialize_from_json_ast;
 use biome_deserialize::Merge;
 use biome_diagnostics::Diagnostic;
 use biome_diagnostics::{category, PrintDiagnostic};
-use biome_formatter::LineWidthFromIntError;
+use biome_formatter::ParseFormatNumberError;
 use biome_fs::{BiomePath, ConfigName, FileSystemExt, OpenOptions};
 use biome_json_parser::{parse_json_with_cache, JsonParserOptions};
 use biome_json_syntax::{JsonFileSource, JsonRoot};
@@ -93,7 +93,7 @@ pub(crate) fn run(migrate_payload: MigratePayload) -> Result<(), CliDiagnostic>
             let prettier_biome_config =
                 prettier_config
                     .try_into()
-                    .map_err(|err: LineWidthFromIntError| {
+                    .map_err(|err: ParseFormatNumberError| {
                         CliDiagnostic::MigrateError(MigrationDiagnostic {
                             reason: err.to_string(),
                         })

crates/biome_cli/src/execute/migrate/prettier.rs

@@ -5,7 +5,7 @@ use biome_deserialize::{json::deserialize_from_json_str, StringSet};
 use biome_deserialize_macros::Deserializable;
 use biome_diagnostics::{DiagnosticExt, PrintDiagnostic};
 use biome_formatter::{
-    AttributePosition, LineEnding, LineWidth, LineWidthFromIntError, QuoteStyle,
+    AttributePosition, IndentWidth, LineEnding, LineWidth, ParseFormatNumberError, QuoteStyle,
 };
 use biome_fs::{FileSystem, OpenOptions};
 use biome_js_formatter::context::{ArrowParentheses, QuoteProperties, Semicolons, TrailingCommas};
@@ -187,18 +187,19 @@ impl From<QuoteProps> for QuoteProperties {
 }
 
 impl TryFrom<PrettierConfiguration> for biome_configuration::PartialConfiguration {
-    type Error = LineWidthFromIntError;
+    type Error = ParseFormatNumberError;
     fn try_from(value: PrettierConfiguration) -> Result<Self, Self::Error> {
         let mut result = biome_configuration::PartialConfiguration::default();
 
         let line_width = LineWidth::try_from(value.print_width)?;
+        let indent_width = IndentWidth::try_from(value.tab_width)?;
         let indent_style = if value.use_tabs {
             biome_configuration::PlainIndentStyle::Tab
         } else {
             biome_configuration::PlainIndentStyle::Space
         };
         let formatter = biome_configuration::PartialFormatterConfiguration {
-            indent_width: Some(value.tab_width),
+            indent_width: Some(indent_width),
             line_width: Some(line_width),
             indent_style: Some(indent_style),
             line_ending: Some(value.end_of_line.into()),
@@ -266,7 +267,7 @@ impl TryFrom<PrettierConfiguration> for biome_configuration::PartialConfiguratio
 }
 
 impl TryFrom<Override> for biome_configuration::OverridePattern {
-    type Error = LineWidthFromIntError;
+    type Error = ParseFormatNumberError;
     fn try_from(Override { files, options }: Override) -> Result<Self, Self::Error> {
         let mut result = biome_configuration::OverridePattern {
             include: Some(StringSet::new(files.into_iter().collect())),
@@ -283,6 +284,12 @@ impl TryFrom<Override> for biome_configuration::OverridePattern {
             } else {
                 None
             };
+            // are global options are set
+            let indent_width = if let Some(indent_width) = options.tab_width {
+                Some(IndentWidth::try_from(indent_width)?)
+            } else {
+                None
+            };
             let indent_style = options.use_tabs.map(|use_tabs| {
                 if use_tabs {
                     biome_configuration::PlainIndentStyle::Tab
@@ -291,7 +298,7 @@ impl TryFrom<Override> for biome_configuration::OverridePattern {
                 }
             });
             let formatter = biome_configuration::OverrideFormatterConfiguration {
-                indent_width: options.tab_width,
+                indent_width,
                 line_width,
                 indent_style,
                 line_ending: options.end_of_line.map(|end_of_line| end_of_line.into()),

crates/biome_cli/tests/cases/config_extends.rs

@@ -325,7 +325,7 @@ fn allows_reverting_fields_in_extended_config_to_default() {
         rome_json.into(),
         format!(
             r#"{{ "extends": ["format.json"], "formatter": {{ "lineWidth": {} }} }}"#,
-            LineWidth::default().get()
+            LineWidth::default().value()
         ),
     );
 

crates/biome_cli/tests/snap_test.rs

@@ -3,7 +3,7 @@ use biome_console::fmt::{Formatter, Termcolor};
 use biome_console::{markup, BufferConsole, Markup};
 use biome_diagnostics::termcolor::NoColor;
 use biome_diagnostics::{print_diagnostic_to_string, Error};
-use biome_formatter::IndentStyle;
+use biome_formatter::{IndentStyle, IndentWidth};
 use biome_fs::{ConfigName, FileSystemExt, MemoryFileSystem};
 use biome_json_formatter::context::JsonFormatOptions;
 use biome_json_formatter::format_node;
@@ -69,7 +69,7 @@ impl CliSnapshot {
             let formatted = format_node(
                 JsonFormatOptions::default()
                     .with_indent_style(IndentStyle::Space)
-                    .with_indent_width(2.into()),
+                    .with_indent_width(IndentWidth::default()),
                 &parsed.syntax(),
             )
             .expect("formatted JSON")

crates/biome_cli/tests/snapshots/main_commands_rage/with_formatter_configuration.snap

@@ -112,9 +112,9 @@ JSON Formatter:
 CSS Formatter:
   Enabled:                      false
   Indent style:                 Tab
-  Indent width:                 0
+  Indent width:                 2
   Line ending:                  Lf
-  Line width:                   LineWidth(80)
+  Line width:                   80
   Quote style:                  Double
 
 Server:

crates/biome_configuration/src/css.rs

@@ -1,6 +1,6 @@
 use crate::PlainIndentStyle;
 use biome_deserialize_macros::{Deserializable, Merge, Partial};
-use biome_formatter::{LineEnding, LineWidth, QuoteStyle};
+use biome_formatter::{IndentWidth, LineEnding, LineWidth, QuoteStyle};
 use bpaf::Bpaf;
 use serde::{Deserialize, Serialize};
 
@@ -54,7 +54,7 @@ pub struct CssFormatter {
 
     /// The size of the indentation applied to CSS (and its super languages) files. Default to 2.
     #[partial(bpaf(long("css-formatter-indent-width"), argument("NUMBER"), optional))]
-    pub indent_width: u8,
+    pub indent_width: IndentWidth,
 
     /// The type of line ending applied to CSS (and its super languages) files.
     #[partial(bpaf(long("css-formatter-line-ending"), argument("lf|crlf|cr"), optional))]
@@ -100,3 +100,11 @@ impl PartialCssLinter {
         }
     }
 }
+
+#[test]
+fn default_css() {
+    let css_configuration = CssFormatter::default();
+
+    assert_eq!(css_configuration.indent_width, IndentWidth::default());
+    assert_eq!(css_configuration.indent_width.value(), 2);
+}

crates/biome_configuration/src/editorconfig.rs

@@ -13,7 +13,7 @@ use std::{collections::HashMap, str::FromStr};
 
 use biome_deserialize::StringSet;
 use biome_diagnostics::{adapters::IniError, Error};
-use biome_formatter::{LineEnding, LineWidth};
+use biome_formatter::{IndentWidth, LineEnding, LineWidth};
 use indexmap::IndexSet;
 use serde::{Deserialize, Deserializer};
 
@@ -83,8 +83,8 @@ impl EditorConfig {
 #[serde(default)]
 pub struct EditorConfigOptions {
     indent_style: Option<PlainIndentStyle>,
-    #[serde(deserialize_with = "deserialize_optional_u8_from_string")]
-    indent_size: Option<u8>,
+    #[serde(deserialize_with = "deserialize_optional_indent_width_from_string")]
+    indent_size: Option<IndentWidth>,
     end_of_line: Option<LineEnding>,
     #[serde(deserialize_with = "deserialize_optional_line_width_from_string")]
     max_line_length: Option<LineWidth>,
@@ -146,17 +146,16 @@ where
     deserialize_bool_from_string(deserializer).map(Some)
 }
 
-fn deserialize_optional_u8_from_string<'de, D>(deserializer: D) -> Result<Option<u8>, D::Error>
+fn deserialize_optional_indent_width_from_string<'de, D>(
+    deserializer: D,
+) -> Result<Option<IndentWidth>, D::Error>
 where
     D: Deserializer<'de>,
 {
     let s = String::deserialize(deserializer)?;
-    match s.parse() {
-        Ok(n) => Ok(Some(n)),
-        Err(_) => Err(serde::de::Error::custom(
-            "expected a number between 0 and 255",
-        )),
-    }
+    IndentWidth::from_str(s.as_str())
+        .map_err(serde::de::Error::custom)
+        .map(Some)
 }
 
 fn deserialize_optional_line_width_from_string<'de, D>(
@@ -225,20 +224,20 @@ root = true
 
 [*]
 insert_final_newline = true
-end_of_line = lf
-indent_style = tab
+end_of_line = crlf
+indent_style = space
 indent_size = 4
-max_line_length = 120
+max_line_length = 80
 "#;
 
         let conf = parse_str(input).expect("Failed to parse editorconfig");
         let (conf, _) = conf.to_biome();
         let conf = conf.expect("Failed to convert editorconfig to biome");
         let formatter = conf.formatter.expect("Formatter not set");
-        assert_eq!(formatter.indent_style, Some(PlainIndentStyle::Tab));
-        assert_eq!(formatter.indent_width, Some(4));
-        assert_eq!(formatter.line_ending, Some(LineEnding::Lf));
-        assert_eq!(formatter.line_width.map(|v| v.get()), Some(120));
+        assert_eq!(formatter.indent_style, Some(PlainIndentStyle::Space));
+        assert_eq!(formatter.indent_width.unwrap().value(), 4);
+        assert_eq!(formatter.line_ending, Some(LineEnding::Crlf));
+        assert_eq!(formatter.line_width.map(|v| v.value()), Some(80));
     }
 
     #[test]

crates/biome_configuration/src/formatter.rs

@@ -1,6 +1,6 @@
 use biome_deserialize::StringSet;
 use biome_deserialize_macros::{Deserializable, Merge, Partial};
-use biome_formatter::{AttributePosition, IndentStyle, LineEnding, LineWidth};
+use biome_formatter::{AttributePosition, IndentStyle, IndentWidth, LineEnding, LineWidth};
 use bpaf::Bpaf;
 use serde::{Deserialize, Serialize};
 use std::str::FromStr;
@@ -27,11 +27,11 @@ pub struct FormatterConfiguration {
     /// The size of the indentation, 2 by default (deprecated, use `indent-width`)
     #[partial(bpaf(long("indent-size"), argument("NUMBER"), optional))]
     #[partial(deserializable(deprecated(use_instead = "formatter.indentWidth")))]
-    pub indent_size: u8,
+    pub indent_size: IndentWidth,
 
     /// The size of the indentation, 2 by default
     #[partial(bpaf(long("indent-width"), argument("NUMBER"), optional))]
-    pub indent_width: u8,
+    pub indent_width: IndentWidth,
 
     /// The type of line ending.
     #[partial(bpaf(long("line-ending"), argument("lf|crlf|cr"), optional))]
@@ -82,8 +82,8 @@ impl Default for FormatterConfiguration {
         Self {
             enabled: true,
             format_with_errors: false,
-            indent_size: 2,
-            indent_width: 2,
+            indent_size: IndentWidth::default(),
+            indent_width: IndentWidth::default(),
             indent_style: PlainIndentStyle::default(),
             line_ending: LineEnding::default(),
             line_width: LineWidth::default(),