Skip to content

Commit c19cd50

Browse files
committed
docs(oxfmt): Improve docs for oxfmt config file fields.
Just improve them by using markdown code formatting for relevant values.
1 parent 569abe2 commit c19cd50

File tree

1 file changed

+17
-16
lines changed

1 file changed

+17
-16
lines changed

crates/oxc_formatter/src/service/oxfmtrc.rs

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -17,47 +17,48 @@ use crate::{
1717
#[derive(Debug, Default, Clone, Deserialize, Serialize, JsonSchema)]
1818
#[serde(rename_all = "camelCase", default)]
1919
pub struct Oxfmtrc {
20-
/// Use tabs for indentation or spaces. (Default: false)
20+
/// Use tabs for indentation or spaces. (Default: `false`)
2121
#[serde(skip_serializing_if = "Option::is_none")]
2222
pub use_tabs: Option<bool>,
23-
/// Number of spaces per indentation level. (Default: 2)
23+
/// Number of spaces per indentation level. (Default: `2`)
2424
#[serde(skip_serializing_if = "Option::is_none")]
2525
pub tab_width: Option<u8>,
26-
/// Which end of line characters to apply. (Default: "lf")
26+
/// Which end of line characters to apply. (Default: `"lf"`)
2727
#[serde(skip_serializing_if = "Option::is_none")]
2828
pub end_of_line: Option<EndOfLineConfig>,
29-
/// The line length that the printer will wrap on. (Default: 100)
29+
/// The line length that the printer will wrap on. (Default: `100`)
3030
#[serde(skip_serializing_if = "Option::is_none")]
3131
pub print_width: Option<u16>,
32-
/// Use single quotes instead of double quotes. (Default: false)
32+
/// Use single quotes instead of double quotes. (Default: `false`)
3333
#[serde(skip_serializing_if = "Option::is_none")]
3434
pub single_quote: Option<bool>,
35-
/// Use single quotes instead of double quotes in JSX. (Default: false)
35+
/// Use single quotes instead of double quotes in JSX. (Default: `false`)
3636
#[serde(skip_serializing_if = "Option::is_none")]
3737
pub jsx_single_quote: Option<bool>,
38-
/// Change when properties in objects are quoted. (Default: "as-needed")
38+
/// Change when properties in objects are quoted. (Default: `"as-needed"`)
3939
#[serde(skip_serializing_if = "Option::is_none")]
4040
pub quote_props: Option<QuotePropsConfig>,
41-
/// Print trailing commas wherever possible. (Default: "all")
41+
/// Print trailing commas wherever possible. (Default: `"all"`)
4242
#[serde(skip_serializing_if = "Option::is_none")]
4343
pub trailing_comma: Option<TrailingCommaConfig>,
44-
/// Print semicolons at the ends of statements. (Default: true)
44+
/// Print semicolons at the ends of statements. (Default: `true`)
4545
#[serde(skip_serializing_if = "Option::is_none")]
4646
pub semi: Option<bool>,
47-
/// Include parentheses around a sole arrow function parameter. (Default: "always")
47+
/// Include parentheses around a sole arrow function parameter. (Default: `"always"`)
4848
#[serde(skip_serializing_if = "Option::is_none")]
4949
pub arrow_parens: Option<ArrowParensConfig>,
50-
/// Print spaces between brackets in object literals. (Default: true)
50+
/// Print spaces between brackets in object literals. (Default: `true`)
5151
#[serde(skip_serializing_if = "Option::is_none")]
5252
pub bracket_spacing: Option<bool>,
53-
/// Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line. (Default: false)
53+
/// Put the `>` of a multi-line JSX element at the end of the last line
54+
/// instead of being alone on the next line. (Default: `false`)
5455
#[serde(skip_serializing_if = "Option::is_none")]
5556
pub bracket_same_line: Option<bool>,
56-
/// How to wrap object literals when they could fit on one line or span multiple lines. (Default: "preserve")
57-
/// NOTE: In addition to Prettier's "preserve" and "collapse", we also support "always".
57+
/// How to wrap object literals when they could fit on one line or span multiple lines. (Default: `"preserve"`)
58+
/// NOTE: In addition to Prettier's `"preserve"` and `"collapse"`, we also support `"always"`.
5859
#[serde(skip_serializing_if = "Option::is_none")]
5960
pub object_wrap: Option<ObjectWrapConfig>,
60-
/// Put each attribute on a new line in JSX. (Default: false)
61+
/// Put each attribute on a new line in JSX. (Default: `false`)
6162
#[serde(skip_serializing_if = "Option::is_none")]
6263
pub single_attribute_per_line: Option<bool>,
6364

@@ -70,7 +71,7 @@ pub struct Oxfmtrc {
7071
#[schemars(skip)]
7172
pub experimental_ternaries: Option<serde_json::Value>,
7273

73-
/// Control whether formats quoted code embedded in the file. (Default: "auto")
74+
/// Control whether formats quoted code embedded in the file. (Default: `"auto"`)
7475
#[serde(skip_serializing_if = "Option::is_none")]
7576
pub embedded_language_formatting: Option<EmbeddedLanguageFormattingConfig>,
7677

0 commit comments

Comments
 (0)