Merge pull request #2064 from adity982/agent/remove-misleading-in-place-aliases

fix(cli): remove misleading in-place aliases

Author: harehare

README.md

@@ -226,7 +226,7 @@ Options:
   -F, --output-format <OUTPUT_FORMAT>
           Set output format [default: markdown] [possible values: markdown, html, text, json, table, grep, raw, none]
   -U, --update
-          Update the input markdown (aliases: -i, --in-place, --inplace)
+          Update matching Markdown nodes and write the result to stdout
       --unbuffered
           Unbuffered output
       --list-style <LIST_STYLE>

crates/mq-run/src/cli.rs

@@ -381,14 +381,8 @@ struct OutputArgs {
     #[arg(short = 'F', long, value_enum, default_value_t)]
     output_format: OutputFormat,
 
-    /// Update the input markdown (aliases: -i, --in-place, --inplace)
-    #[arg(
-        short = 'U',
-        long = "update",
-        short_alias='i',
-        aliases=["in-place", "inplace"],
-        default_value_t = false
-    )]
+    /// Update matching Markdown nodes and write the result to stdout
+    #[arg(short = 'U', long = "update", default_value_t = false)]
     update: bool,
 
     /// Unbuffered output

crates/mq-run/tests/integration_tests.rs

@@ -28,6 +28,16 @@ fn test_cli_run_with_stdin() -> Result<(), Box<dyn std::error::Error>> {
     Ok(())
 }
 
+#[rstest]
+#[case("-i")]
+#[case("--in-place")]
+#[case("--inplace")]
+fn update_does_not_accept_misleading_in_place_aliases(#[case] alias: &str) {
+    let mut cmd = cargo::cargo_bin_cmd!("mq");
+
+    cmd.arg(alias).arg("self").write_stdin("# Title\n").assert().failure();
+}
+
 #[rstest]
 #[case::json(
     vec!["--unbuffered", "-F", "json", ".code_inline"],

docs/books/src/reference/cli.md

@@ -51,7 +51,7 @@ Options:
   -F, --output-format <OUTPUT_FORMAT>
           Set output format [default: markdown] [possible values: markdown, html, text, json, table, grep, raw, none]
   -U, --update
-          Update the input markdown (aliases: -i, --in-place, --inplace)
+          Update matching Markdown nodes and write the result to stdout
       --unbuffered
           Unbuffered output
       --list-style <LIST_STYLE>