Add no-cd setting (#2981)

Author: hans-d

README.md

@@ -950,6 +950,12 @@ $ just bar
 /subdir
 ```
 
+Use `set no-cd`<sup>master</sup> to make all recipes in the current module
+default to the same behavior.
+
+`set no-cd` and `set working-directory` can be overridden on a per-recipe basis
+with the `[no-cd]` and `[working-directory]` attributes.
+
 You can override the working directory for all recipes with
 `set working-directory := '…'`:
 
@@ -1043,6 +1049,7 @@ foo:
 | `ignore-comments` | boolean | `false` | Ignore recipe lines beginning with `#`. |
 | `no-exit-message`<sup>1.39.0</sup> | boolean | `false` | Don't print exit messages if recipes fail. |
 | `lazy`<sup>1.47.0</sup> | boolean | `false` | Don't evaluate unused variables. |
+| `no-cd`<sup>master</sup> | boolean | `false` | Don't change directory when executing recipes by recipe attribute. |
 | `positional-arguments` | boolean | `false` | Pass positional arguments. |
 | `quiet` | boolean | `false` | Disable echoing recipe lines before executing. |
 | `script-interpreter`<sup>1.33.0</sup> | `[COMMAND, ARGS…]` | `['sh', '-eu']` | Set command used to invoke recipes with empty `[script]` attribute. |

src/analyzer.rs

@@ -417,6 +417,24 @@ impl<'run, 'src> Analyzer<'run, 'src> {
       }));
     }
 
+    if let Some(second) = Keyword::from_lexeme(set.name.lexeme()) {
+      let first = match second {
+        Keyword::NoCd => Keyword::WorkingDirectory,
+        Keyword::WorkingDirectory => Keyword::NoCd,
+        _ => {
+          return Ok(());
+        }
+      };
+
+      if let Some(conflict) = self.sets.get(first.lexeme()) {
+        return Err(set.name.error(NoCdAndWorkingDirectorySetting {
+          first,
+          first_line: conflict.name.line,
+          second,
+        }));
+      }
+    }
+
     Ok(())
   }
 

src/compile_error.rs

@@ -254,6 +254,17 @@ impl Display for CompileError<'_> {
         f,
         "recipe `{recipe}` has both `[no-cd]` and `[working-directory]` attributes"
       ),
+      NoCdAndWorkingDirectorySetting {
+        first,
+        first_line,
+        second,
+      } => write!(
+        f,
+        "`{}` set on line {} is incompatible with `{}`",
+        first.lexeme(),
+        first_line.ordinal(),
+        second.lexeme()
+      ),
       OptionNameContainsEqualSign { parameter } => {
         write!(
           f,

src/compile_error_kind.rs

@@ -114,6 +114,11 @@ pub(crate) enum CompileErrorKind<'src> {
   NoCdAndWorkingDirectoryAttribute {
     recipe: &'src str,
   },
+  NoCdAndWorkingDirectorySetting {
+    first: Keyword,
+    first_line: usize,
+    second: Keyword,
+  },
   OptionNameContainsEqualSign {
     parameter: String,
   },

src/evaluator.rs

@@ -101,6 +101,9 @@ impl<'src, 'run> Evaluator<'src, 'run> {
         Setting::Lazy(value) => {
           settings.lazy = value;
         }
+        Setting::NoCd(value) => {
+          settings.no_cd = value;
+        }
         Setting::NoExitMessage(value) => {
           settings.no_exit_message = value;
         }

src/keyword.rs

@@ -24,6 +24,7 @@ pub(crate) enum Keyword {
   Import,
   Lazy,
   Mod,
+  NoCd,
   NoExitMessage,
   PositionalArguments,
   Quiet,

src/node.rs

@@ -283,6 +283,7 @@ impl<'src> Node<'src> for Set<'src> {
       | Setting::Guards(value)
       | Setting::IgnoreComments(value)
       | Setting::Lazy(value)
+      | Setting::NoCd(value)
       | Setting::NoExitMessage(value)
       | Setting::PositionalArguments(value)
       | Setting::Quiet(value)

src/parser.rs

@@ -1416,6 +1416,7 @@ impl<'run, 'src> Parser<'run, 'src> {
       Keyword::Guards => Some(Setting::Guards(self.parse_set_bool()?)),
       Keyword::IgnoreComments => Some(Setting::IgnoreComments(self.parse_set_bool()?)),
       Keyword::Lazy => Some(Setting::Lazy(self.parse_set_bool()?)),
+      Keyword::NoCd => Some(Setting::NoCd(self.parse_set_bool()?)),
       Keyword::NoExitMessage => Some(Setting::NoExitMessage(self.parse_set_bool()?)),
       Keyword::PositionalArguments => Some(Setting::PositionalArguments(self.parse_set_bool()?)),
       Keyword::Quiet => Some(Setting::Quiet(self.parse_set_bool()?)),
@@ -2650,6 +2651,12 @@ mod tests {
     tree: (justfile (set quiet false)),
   }
 
+  test! {
+    name: set_no_cd,
+    text: "set no-cd := true",
+    tree: (justfile (set no_cd true)),
+  }
+
   test! {
     name: set_positional_arguments_false,
     text: "set positional-arguments := false",

src/recipe.rs

@@ -169,8 +169,19 @@ impl<'src> Recipe<'src> {
         .contains(AttributeDiscriminant::PositionalArguments)
   }
 
-  pub(crate) fn change_directory(&self) -> bool {
-    !self.attributes.contains(AttributeDiscriminant::NoCd)
+  pub(crate) fn change_directory(&self, settings: &Settings) -> bool {
+    if self
+      .attributes
+      .contains(AttributeDiscriminant::WorkingDirectory)
+    {
+      return true;
+    }
+
+    if self.attributes.contains(AttributeDiscriminant::NoCd) {
+      return false;
+    }
+
+    !settings.no_cd
   }
 
   fn print_exit_message(&self, settings: &Settings) -> bool {
@@ -186,7 +197,7 @@ impl<'src> Recipe<'src> {
   }
 
   fn working_directory<'a>(&'a self, context: &'a ExecutionContext) -> Option<PathBuf> {
-    if !self.change_directory() {
+    if !self.change_directory(&context.module.settings) {
       return None;
     }
 

src/setting.rs

@@ -14,6 +14,7 @@ pub(crate) enum Setting<'src> {
   Guards(bool),
   IgnoreComments(bool),
   Lazy(bool),
+  NoCd(bool),
   NoExitMessage(bool),
   PositionalArguments(bool),
   Quiet(bool),
@@ -39,6 +40,7 @@ impl<'src> Setting<'src> {
       | Self::Guards(value)
       | Self::IgnoreComments(value)
       | Self::Lazy(value)
+      | Self::NoCd(value)
       | Self::NoExitMessage(value)
       | Self::PositionalArguments(value)
       | Self::Quiet(value)
@@ -88,6 +90,7 @@ impl Display for Setting<'_> {
       | Self::Guards(value)
       | Self::IgnoreComments(value)
       | Self::Lazy(value)
+      | Self::NoCd(value)
       | Self::NoExitMessage(value)
       | Self::PositionalArguments(value)
       | Self::Quiet(value)