docs: auto generated CLI reference

rome · Jul 9, 2023 · 144de4b · 144de4b
1 parent 8f46efb
commit 144de4b
Show file tree

Hide file tree

Showing 9 changed files with 578 additions and 124 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -64,7 +64,7 @@ tests_macros                = { path = "./crates/tests_macros" }
 
 # Crates needed in the workspace
 bitflags    = "2.3.1"
-bpaf        = { version = "0.9.1", features = ["derive"] }
+bpaf        = { version = "0.9.1", git = "https://github.com/pacak/bpaf", branch = "md", features = ["derive"] }
 countme     = "3.0.1"
 dashmap     = "5.4.0"
 indexmap    = "1.9.3"

diff --git a/crates/rome_cli/Cargo.toml b/crates/rome_cli/Cargo.toml
@@ -59,3 +59,6 @@ rome_js_formatter   = { workspace = true }
 rome_json_formatter = { workspace = true }
 rome_json_parser    = { workspace = true }
 tokio               = { workspace = true, features = ["io-util"] }
+
+[features]
+docgen = ["bpaf/docgen"]
diff --git a/crates/rome_cli/src/commands/mod.rs b/crates/rome_cli/src/commands/mod.rs
@@ -21,8 +21,6 @@ pub(crate) mod version;
 
 #[derive(Debug, Clone, Bpaf)]
 #[bpaf(options, version(VERSION))]
-/// Rome CLI
-///
 /// Rome official CLI. Use it to check the health of your project or run it to check single files.
 pub enum RomeCommand {
     /// Shows the Rome version information and quit

diff --git a/crates/rome_service/src/configuration/formatter.rs b/crates/rome_service/src/configuration/formatter.rs
@@ -22,6 +22,10 @@ pub struct FormatterConfiguration {
     pub format_with_errors: Option<bool>,
 
     /// The indent style.
+    ///
+    /// ```shell
+    /// rome format --indent-style=tab
+    /// ```
     #[serde(skip_serializing_if = "Option::is_none")]
     #[bpaf(long("indent-style"), argument("tab|space"), optional)]
     pub indent_style: Option<PlainIndentStyle>,