Skip to content

Commit 9783fca

Browse files
committed
cargo-rail: cleaning up the CLI and config outputs/comments
1 parent 19b48c4 commit 9783fca

File tree

5 files changed

+110
-173
lines changed

5 files changed

+110
-173
lines changed

src/commands/cli.rs

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ pub enum Commands {
182182
/// Show which crates are affected by changes
183183
#[command(after_long_help = AFFECTED_HELP)]
184184
Affected {
185-
/// Git ref to compare against (auto-detects origin/main or origin/master)
185+
/// Git ref to compare against (auto-detects default branch)
186186
#[arg(long)]
187187
since: Option<String>,
188188
/// Start ref (for SHA pair mode)
@@ -200,8 +200,8 @@ pub enum Commands {
200200
/// Show all workspace crates (ignore changes)
201201
#[arg(long, short = 'a')]
202202
all: bool,
203-
/// Write output to file (e.g., $GITHUB_OUTPUT)
204-
#[arg(long, short = 'o')]
203+
/// Write output to file (appends to existing content)
204+
#[arg(long, short = 'o', value_name = "PATH")]
205205
output: Option<PathBuf>,
206206
/// Explain why each crate is affected
207207
#[arg(long)]
@@ -211,7 +211,7 @@ pub enum Commands {
211211
/// Run tests for affected crates only
212212
#[command(after_long_help = TEST_HELP)]
213213
Test {
214-
/// Git ref to compare against (auto-detects origin/main or origin/master)
214+
/// Git ref to compare against (auto-detects default branch)
215215
#[arg(long)]
216216
since: Option<String>,
217217
/// Use merge-base with default branch (better for feature branches)
@@ -358,7 +358,7 @@ pub enum Commands {
358358
#[command(after_long_help = COMPLETIONS_HELP)]
359359
Completions {
360360
/// Shell to generate completions for
361-
#[arg(value_enum)]
361+
#[arg(value_enum, value_name = "SHELL")]
362362
shell: Shell,
363363
},
364364
}
@@ -381,7 +381,7 @@ pub enum ConfigCommand {
381381
/// any unset fields. Useful for debugging and understanding what
382382
/// cargo-rail will actually use.
383383
Print {
384-
/// Output format (default: toml, or json with -f json)
384+
/// Output format
385385
#[arg(long, short = 'f', default_value_t, value_enum)]
386386
format: OutputFormat,
387387
},
@@ -438,6 +438,7 @@ pub enum SplitCommand {
438438
/// Configure split for crate(s)
439439
Init {
440440
/// Crate name(s) to configure
441+
#[arg(value_name = "CRATE")]
441442
crate_names: Vec<String>,
442443
/// Preview generated config without writing
443444
#[arg(long, short = 'c')]
@@ -446,7 +447,7 @@ pub enum SplitCommand {
446447
/// Execute split operation
447448
Run {
448449
/// Crate name to split (mutually exclusive with --all)
449-
#[arg(conflicts_with = "all")]
450+
#[arg(conflicts_with = "all", value_name = "CRATE")]
450451
crate_name: Option<String>,
451452
/// Split all configured crates
452453
#[arg(short, long)]
@@ -475,6 +476,7 @@ pub enum ReleaseCommand {
475476
/// Configure release settings
476477
Init {
477478
/// Crate name(s) to configure (optional)
479+
#[arg(value_name = "CRATE")]
478480
crate_names: Vec<String>,
479481
/// Preview generated config without writing
480482
#[arg(long, short = 'c')]
@@ -483,7 +485,7 @@ pub enum ReleaseCommand {
483485
/// Execute release (plan or publish)
484486
Run {
485487
/// Crate name(s) to release (mutually exclusive with --all)
486-
#[arg(conflicts_with = "all")]
488+
#[arg(conflicts_with = "all", value_name = "CRATE")]
487489
crate_names: Vec<String>,
488490
/// Release all workspace crates
489491
#[arg(short, long)]
@@ -510,7 +512,7 @@ pub enum ReleaseCommand {
510512
/// Validate release readiness
511513
Check {
512514
/// Crate name(s) to check (mutually exclusive with --all)
513-
#[arg(conflicts_with = "all")]
515+
#[arg(conflicts_with = "all", value_name = "CRATE")]
514516
crate_names: Vec<String>,
515517
/// Check all workspace crates (mutually exclusive with crate names)
516518
#[arg(short, long)]

src/split/engine.rs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -286,9 +286,6 @@ impl<'a> SplitEngine<'a> {
286286
}
287287
}
288288

289-
// Auxiliary files are handled separately via AuxiliaryFiles::discover
290-
// This section has been removed as it was redundant
291-
292289
// Create commit using git command for determinism
293290
// Map parent SHAs from monorepo to split repo
294291
let mut mapped_parents: Vec<String> = params

0 commit comments

Comments
 (0)