Stabilize --fmt subcommand (#3301)

Author: casey

README.md

@@ -4283,7 +4283,7 @@ Each `justfile` has a canonical formatting with respect to whitespace and
 newlines.
 
 You can overwrite the current justfile with a canonically-formatted version
-using the currently-unstable `--fmt` flag:
+using the `--fmt` flag:
 
 ```console
 $ cat justfile
@@ -4295,15 +4295,18 @@ $ cat justfile
 
 some-recipe:
   echo "foo"
-$ just --fmt --unstable
+$ just --fmt
 $ cat justfile
 # A lot of blank lines
 
 some-recipe:
     echo "foo"
 ```
 
-Invoking `just --fmt --check --unstable` runs `--fmt` in check mode. Instead of
+Note that formatting is not covered by any backwards compatibility guarantee
+and is subject to change from time to time.
+
+Invoking `just --fmt --check` runs `--fmt` in check mode. Instead of
 overwriting the `justfile`, `just` will exit with an exit code of 0 if it is
 formatted correctly, and will exit with 1 and print a diff if it is not.
 

src/subcommand.rs

@@ -360,23 +360,6 @@ impl Subcommand {
       src,
     )?;
 
-    let unstable = config.unstable
-      || ast.items.iter().any(|item| {
-        matches!(
-          item,
-          Item::Set(Set {
-            value: Setting::Unstable(true),
-            ..
-          })
-        )
-      });
-
-    if !unstable {
-      return Err(Error::UnstableFeature {
-        unstable_feature: UnstableFeature::FormatSubcommand,
-      });
-    }
-
     let formatted = ast
       .color_display(config.color.use_color(UseColor::Never))
       .to_string();

src/unstable_feature.rs

@@ -2,7 +2,6 @@ use super::*;
 
 #[derive(Copy, Clone, Debug, PartialEq, Ord, Eq, PartialOrd)]
 pub(crate) enum UnstableFeature {
-  FormatSubcommand,
   LogicalOperators,
   UserDefinedFunction,
   WhichFunction,
@@ -11,7 +10,6 @@ pub(crate) enum UnstableFeature {
 impl Display for UnstableFeature {
   fn fmt(&self, f: &mut Formatter) -> fmt::Result {
     match self {
-      Self::FormatSubcommand => write!(f, "The `--fmt` command is currently unstable."),
       Self::LogicalOperators => write!(
         f,
         "The logical operators `&&` and `||` are currently unstable."

tests/choose.rs

@@ -83,7 +83,7 @@ fn skip_private_recipes() {
 #[test]
 fn recipes_in_submodules_can_be_chosen() {
   Test::new()
-    .args(["--unstable", "--choose"])
+    .arg("--choose")
     .env("JUST_CHOOSER", "head -n10")
     .write("bar.just", "baz:\n echo BAZ")
     .justfile(

tests/format.rs

@@ -1,14 +1,5 @@
 use super::*;
 
-#[test]
-fn unstable_not_passed() {
-  Test::new()
-    .arg("--fmt")
-    .justfile("")
-    .stderr_regex("error: The `--fmt` command is currently unstable..*")
-    .failure();
-}
-
 #[test]
 fn check_without_fmt() {
   Test::new()
@@ -25,7 +16,6 @@ fn check_without_fmt() {
 #[test]
 fn check_ok() {
   Test::new()
-    .arg("--unstable")
     .arg("--fmt")
     .arg("--check")
     .justfile(
@@ -50,7 +40,6 @@ fn check_ok() {
 #[test]
 fn check_found_diff() {
   Test::new()
-    .arg("--unstable")
     .arg("--fmt")
     .arg("--check")
     .justfile("x:=``\n")
@@ -71,7 +60,6 @@ fn check_found_diff() {
 #[test]
 fn check_found_diff_quiet() {
   Test::new()
-    .arg("--unstable")
     .arg("--fmt")
     .arg("--check")
     .arg("--quiet")
@@ -83,7 +71,6 @@ fn check_found_diff_quiet() {
 fn check_diff_color() {
   Test::new()
         .justfile("x:=``\n")
-        .arg("--unstable")
         .arg("--fmt")
         .arg("--check")
         .arg("--color")
@@ -93,30 +80,6 @@ fn check_diff_color() {
         .failure();
 }
 
-#[test]
-fn unstable_passed() {
-  let tmp = tempdir();
-
-  let justfile = tmp.path().join("justfile");
-
-  fs::write(&justfile, "x    :=    'hello'   ").unwrap();
-
-  let output = Command::new(JUST)
-    .current_dir(tmp.path())
-    .arg("--fmt")
-    .arg("--unstable")
-    .output()
-    .unwrap();
-
-  if !output.status.success() {
-    eprintln!("{}", String::from_utf8_lossy(&output.stderr));
-    eprintln!("{}", String::from_utf8_lossy(&output.stdout));
-    panic!("justfile failed with status: {}", output.status);
-  }
-
-  assert_eq!(fs::read_to_string(&justfile).unwrap(), "x := 'hello'\n");
-}
-
 #[test]
 fn write_error() {
   // skip this test if running as root, since root can write files even if
@@ -132,7 +95,7 @@ fn write_error() {
 
   let test = Test::with_tempdir(tempdir)
     .no_justfile()
-    .args(["--fmt", "--unstable"])
+    .arg("--fmt")
     .stderr_regex(if cfg!(windows) {
       r"error: Failed to write justfile to `.*`: Access is denied. \(os error 5\)\n"
     } else {
@@ -1438,17 +1401,13 @@ fn multi_argument_attribute() {
   Test::new()
     .justfile(
       "
-        set unstable
-
         [script('a', 'b', 'c')]
         foo:
       ",
     )
     .arg("--dump")
     .stdout(
       "
-        set unstable
-
         [script('a', 'b', 'c')]
         foo:
       ",
@@ -1461,8 +1420,6 @@ fn doc_attribute_suppresses_comment() {
   Test::new()
     .justfile(
       "
-        set unstable
-
         # COMMENT
         [doc('ATTRIBUTE')]
         foo:
@@ -1471,8 +1428,6 @@ fn doc_attribute_suppresses_comment() {
     .arg("--dump")
     .stdout(
       "
-        set unstable
-
         # COMMENT
         [doc('ATTRIBUTE')]
         foo:
@@ -1493,10 +1448,7 @@ fn unchanged_justfiles_are_not_written_to_disk() {
   permissions.set_readonly(true);
   fs::set_permissions(&justfile, permissions).unwrap();
 
-  Test::with_tempdir(tmp)
-    .no_justfile()
-    .args(["--fmt", "--unstable"])
-    .success();
+  Test::with_tempdir(tmp).no_justfile().arg("--fmt").success();
 }
 
 #[test]
@@ -1656,7 +1608,7 @@ fn arg_attribute_help() {
 #[test]
 fn missing_import_file() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check"])
+    .args(["--fmt", "--check"])
     .justfile("import 'foo'\n")
     .test_round_trip(false)
     .success();
@@ -1665,7 +1617,7 @@ fn missing_import_file() {
 #[test]
 fn missing_module_file() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check"])
+    .args(["--fmt", "--check"])
     .justfile("mod foo\n")
     .test_round_trip(false)
     .success();
@@ -1674,7 +1626,7 @@ fn missing_module_file() {
 #[test]
 fn undefined_variable() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check"])
+    .args(["--fmt", "--check"])
     .justfile(
       "
         foo:
@@ -1688,7 +1640,7 @@ fn undefined_variable() {
 #[test]
 fn indentation_two_spaces() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check", "--indentation", "  "])
+    .args(["--fmt", "--check", "--indentation", "  "])
     .justfile("foo:\n  echo bar\n")
     .test_round_trip(false)
     .success();
@@ -1697,7 +1649,7 @@ fn indentation_two_spaces() {
 #[test]
 fn indentation_tab() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check", "--indentation", "\t"])
+    .args(["--fmt", "--check", "--indentation", "\t"])
     .justfile("foo:\n\techo bar\n")
     .test_round_trip(false)
     .success();
@@ -1706,7 +1658,7 @@ fn indentation_tab() {
 #[test]
 fn indentation_check_with_custom() {
   Test::new()
-    .args(["--unstable", "--fmt", "--check", "--indentation", "  "])
+    .args(["--fmt", "--check", "--indentation", "  "])
     .justfile("foo:\n    echo bar\n")
     .test_round_trip(false)
     .stdout(" foo:\n-    echo bar\n+  echo bar\n")

tests/unstable.rs

@@ -16,20 +16,20 @@ fn set_unstable_true_with_env_var() {
 fn set_unstable_false_with_env_var() {
   for val in ["0", "", "false"] {
     Test::new()
-      .justfile("")
-      .args(["--fmt"])
+      .justfile("f(a) := a")
+      .arg("--dump")
       .env("JUST_UNSTABLE", val)
-      .stderr_regex("error: The `--fmt` command is currently unstable.*")
+      .stderr_regex("error: User-defined functions are currently unstable.*")
       .failure();
   }
 }
 
 #[test]
 fn set_unstable_false_with_env_var_unset() {
   Test::new()
-    .justfile("")
-    .args(["--fmt"])
-    .stderr_regex("error: The `--fmt` command is currently unstable.*")
+    .justfile("f(a) := a")
+    .arg("--dump")
+    .stderr_regex("error: User-defined functions are currently unstable.*")
     .failure();
 }