Stabilize modules (#2250)

Author: casey

README.md

@@ -667,10 +667,10 @@ $ cat foo.just
 mod bar
 $ cat bar.just
 baz:
-$ just --unstable foo bar
+$ just foo bar
 Available recipes:
     baz
-$ just --unstable foo::bar
+$ just foo::bar
 Available recipes:
     baz
 ```
@@ -3154,9 +3154,11 @@ Missing source files for optional imports do not produce an error.
 
 ### Modules<sup>1.19.0</sup>
 
-A `justfile` can declare modules using `mod` statements. `mod` statements are
-currently unstable, so you'll need to use the `--unstable` flag,
-`set unstable`, or set the `JUST_UNSTABLE` environment variable to use them.
+A `justfile` can declare modules using `mod` statements.
+
+`mod` statements were stabilized in `just`<sup>master</sup>. In earlier
+versions, you'll need to use the `--unstable` flag, `set unstable`, or set the
+`JUST_UNSTABLE` environment variable to use them.
 
 If you have the following `justfile`:
 
@@ -3181,14 +3183,14 @@ uses its own settings.
 Recipes in submodules can be invoked as subcommands:
 
 ```sh
-$ just --unstable bar b
+$ just bar b
 B
 ```
 
 Or with path syntax:
 
 ```sh
-$ just --unstable bar::b
+$ just bar::b
 B
 ```
 

src/analyzer.rs

@@ -37,8 +37,6 @@ impl<'src> Analyzer<'src> {
 
     let mut warnings = Vec::new();
 
-    let mut unstable = BTreeSet::new();
-
     let mut modules: Table<Justfile> = Table::new();
 
     let mut unexports: HashSet<String> = HashSet::new();
@@ -94,8 +92,6 @@ impl<'src> Analyzer<'src> {
             doc,
             ..
           } => {
-            unstable.insert(Unstable::Modules);
-
             if let Some(absolute) = absolute {
               define(*name, "module", false)?;
               modules.insert(Self::analyze(
@@ -198,7 +194,7 @@ impl<'src> Analyzer<'src> {
       settings,
       source: root.into(),
       unexports,
-      unstable,
+      unstable_features: BTreeSet::new(),
       warnings,
     })
   }

src/config.rs

@@ -720,13 +720,15 @@ impl Config {
     })
   }
 
-  pub(crate) fn require_unstable(&self, message: &str) -> RunResult<'static> {
-    if self.unstable {
+  pub(crate) fn require_unstable(
+    &self,
+    justfile: &Justfile,
+    unstable_feature: UnstableFeature,
+  ) -> RunResult<'static> {
+    if self.unstable || justfile.settings.unstable {
       Ok(())
     } else {
-      Err(Error::Unstable {
-        message: message.to_owned(),
-      })
+      Err(Error::UnstableFeature { unstable_feature })
     }
   }
 

src/error.rs

@@ -174,8 +174,8 @@ pub(crate) enum Error<'src> {
     recipe: String,
     suggestion: Option<Suggestion<'src>>,
   },
-  Unstable {
-    message: String,
+  UnstableFeature {
+    unstable_feature: UnstableFeature,
   },
   WriteJustfile {
     justfile: PathBuf,
@@ -459,8 +459,8 @@ impl<'src> ColorDisplay for Error<'src> {
           write!(f, "\n{suggestion}")?;
         }
       }
-      Unstable { message } => {
-        write!(f, "{message} Invoke `just` with `--unstable`, set the `JUST_UNSTABLE` environment variable, or add `set unstable` to your `justfile` to enable unstable features.")?;
+      UnstableFeature { unstable_feature } => {
+        write!(f, "{unstable_feature} Invoke `just` with `--unstable`, set the `JUST_UNSTABLE` environment variable, or add `set unstable` to your `justfile` to enable unstable features.")?;
       }
       WriteJustfile { justfile, io_error } => {
         let justfile = justfile.display();

src/justfile.rs

@@ -26,9 +26,9 @@ pub(crate) struct Justfile<'src> {
   #[serde(skip)]
   pub(crate) source: PathBuf,
   pub(crate) unexports: HashSet<String>,
-  pub(crate) warnings: Vec<Warning>,
   #[serde(skip)]
-  pub(crate) unstable: BTreeSet<Unstable>,
+  pub(crate) unstable_features: BTreeSet<UnstableFeature>,
+  pub(crate) warnings: Vec<Warning>,
 }
 
 impl<'src> Justfile<'src> {
@@ -228,12 +228,8 @@ impl<'src> Justfile<'src> {
   }
 
   pub(crate) fn check_unstable(&self, config: &Config) -> RunResult<'src> {
-    if !config.unstable && !self.settings.unstable {
-      if let Some(unstable) = self.unstable.iter().next() {
-        return Err(Error::Unstable {
-          message: unstable.message(),
-        });
-      }
+    if let Some(&unstable_feature) = self.unstable_features.iter().next() {
+      config.require_unstable(self, unstable_feature)?;
     }
 
     for module in self.modules.values() {

src/lib.rs

@@ -42,7 +42,7 @@ pub(crate) use {
     shell::Shell, show_whitespace::ShowWhitespace, source::Source, string_kind::StringKind,
     string_literal::StringLiteral, subcommand::Subcommand, suggestion::Suggestion, table::Table,
     thunk::Thunk, token::Token, token_kind::TokenKind, unresolved_dependency::UnresolvedDependency,
-    unresolved_recipe::UnresolvedRecipe, unstable::Unstable, use_color::UseColor,
+    unresolved_recipe::UnresolvedRecipe, unstable_feature::UnstableFeature, use_color::UseColor,
     variables::Variables, verbosity::Verbosity, warning::Warning,
   },
   camino::Utf8Path,
@@ -204,7 +204,7 @@ mod token_kind;
 mod unindent;
 mod unresolved_dependency;
 mod unresolved_recipe;
-mod unstable;
+mod unstable_feature;
 mod use_color;
 mod variables;
 mod verbosity;

src/subcommand.rs

@@ -79,7 +79,7 @@ impl Subcommand {
         justfile.run(config, &search, overrides, &[])?;
       }
       Dump => Self::dump(config, ast, justfile)?,
-      Format => Self::format(config, &search, src, ast)?,
+      Format => Self::format(config, &search, src, ast, justfile)?,
       Groups => Self::groups(config, justfile),
       List { path } => Self::list(config, justfile, path)?,
       Show { path } => Self::show(config, justfile, path)?,
@@ -337,8 +337,14 @@ impl Subcommand {
     Ok(())
   }
 
-  fn format(config: &Config, search: &Search, src: &str, ast: &Ast) -> RunResult<'static> {
-    config.require_unstable("The `--fmt` command is currently unstable.")?;
+  fn format(
+    config: &Config,
+    search: &Search,
+    src: &str,
+    ast: &Ast,
+    justfile: &Justfile,
+  ) -> RunResult<'static> {
+    config.require_unstable(justfile, UnstableFeature::FormatSubcommand)?;
 
     let formatted = ast.to_string();
 

src/unstable.rs

@@ -0,0 +1,14 @@
+use super::*;
+
+#[derive(Copy, Clone, Debug, PartialEq, Ord, Eq, PartialOrd)]
+pub(crate) enum UnstableFeature {
+  FormatSubcommand,
+}
+
+impl Display for UnstableFeature {
+  fn fmt(&self, f: &mut Formatter) -> fmt::Result {
+    match self {
+      Self::FormatSubcommand => write!(f, "The `--fmt` command is currently unstable."),
+    }
+  }
+}

src/unstable_feature.rs

@@ -86,7 +86,6 @@ fn recipes_in_submodules_can_be_chosen() {
     .args(["--unstable", "--choose"])
     .env("JUST_CHOOSER", "head -n10")
     .write("bar.just", "baz:\n echo BAZ")
-    .test_round_trip(false)
     .justfile(
       "
         mod bar