feat(cli): Add '-n' to dry-run

epage · epage · commit 033e06a1cc42 · 2023-09-12T13:42:00.000-05:00
This came from #12638 and my many small frustrations from wanting to use `-n` and not being able to. We do not have any existing `-n` flags for this to be confused with. I would wager that `-n` is such an entrenched short flag in build tools that it would not make sense for us to use it with any other flag. For a survey of where `-n` is used as a short, see https://www.gnu.org/prep/standards/html_node/Option-Table.html#Option-Table
diff --git a/src/cargo/util/command_prelude.rs b/src/cargo/util/command_prelude.rs
@@ -291,7 +291,7 @@ pub trait CommandExt: Sized {
     }
 
     fn arg_dry_run(self, dry_run: &'static str) -> Self {
-        self._arg(flag("dry-run", dry_run))
+        self._arg(flag("dry-run", dry_run).short('n'))
     }
 
     fn arg_ignore_rust_version(self) -> Self {
diff --git a/tests/testsuite/cargo_add/help/stdout.log b/tests/testsuite/cargo_add/help/stdout.log
@@ -42,7 +42,7 @@ Options:
       --ignore-rust-version
           Ignore `rust-version` specification in packages (unstable)
 
-      --dry-run
+  -n, --dry-run
           Don't actually write the manifest
 
   -q, --quiet
diff --git a/tests/testsuite/cargo_publish/help/stdout.log b/tests/testsuite/cargo_publish/help/stdout.log
@@ -3,7 +3,7 @@ Upload a package to the registry
 Usage: cargo[EXE] publish [OPTIONS]
 
 Options:
-      --dry-run              Perform all checks without uploading
+  -n, --dry-run              Perform all checks without uploading
       --index <INDEX>        Registry index URL to upload the package to
       --registry <REGISTRY>  Registry to publish to
       --token <TOKEN>        Token to use when uploading
diff --git a/tests/testsuite/cargo_remove/help/stdout.log b/tests/testsuite/cargo_remove/help/stdout.log
@@ -6,7 +6,7 @@ Arguments:
   <DEP_ID>...  Dependencies to be removed
 
 Options:
-      --dry-run             Don't actually write the manifest
+  -n, --dry-run             Don't actually write the manifest
   -q, --quiet               Do not print cargo log messages
   -v, --verbose...          Use verbose output (-vv very verbose/build.rs output)
       --color <WHEN>        Coloring: auto, always, never
diff --git a/tests/testsuite/cargo_update/help/stdout.log b/tests/testsuite/cargo_update/help/stdout.log
@@ -3,7 +3,7 @@ Update dependencies as recorded in the local lock file
 Usage: cargo[EXE] update [OPTIONS] [SPEC]...
 
 Options:
-      --dry-run             Don't actually write the lockfile
+  -n, --dry-run             Don't actually write the lockfile
       --recursive           Force updating all dependencies of [SPEC]... as well
       --precise <PRECISE>   Update [SPEC] to exactly PRECISE
   -q, --quiet               Do not print cargo log messages

Original file line number	Diff line number	Diff line change
`@@ -291,7 +291,7 @@ pub trait CommandExt: Sized {`
`291`	`291`	`}`
`292`	`292`
`293`	`293`	`fn arg_dry_run(self, dry_run: &'static str) -> Self {`
`294`		`- self._arg(flag("dry-run", dry_run))`
	`294`	`+ self._arg(flag("dry-run", dry_run).short('n'))`
`295`	`295`	`}`
`296`	`296`
`297`	`297`	`fn arg_ignore_rust_version(self) -> Self {`