Add workspace config

This adds support for per-workspace configuration as was described as a TODO in the LayeredConfig struct. Like repo configuration in `.jj/repo/config.toml`, the workspace config goes in `.jj/config.toml` in the workspace root, and its settings take precedence over repo, user and default configs. The config subcommands that take `--user` and `--repo` are additionally given `--workspace` which behaves as one would expect.
jj-vcs · Jul 10, 2024 · 9bcbe94 · 9bcbe94
1 parent 503771c
commit 9bcbe94
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -46,6 +46,10 @@ to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
   address unconditionally. Only ASCII case folding is currently implemented,
   but this will likely change in the future.
 
+* Workspaces may have an additional layered configuration, located at
+  `.jj/config.toml`. `jj config` subcommands which took layer options like
+  `--repo` now also support `--workspace`.
+
 ### Fixed bugs
 
 ## [0.19.0] - 2024-07-03

diff --git a/cli/src/cli_util.rs b/cli/src/cli_util.rs
@@ -2133,6 +2133,11 @@ pub fn get_new_config_file_path(
             new_config_path()?.ok_or_else(|| user_error("No repo config path found to edit"))?
         }
         ConfigSource::Repo => command.workspace_loader()?.repo_path().join("config.toml"),
+        ConfigSource::Workspace => command
+            .workspace_loader()?
+            .workspace_root()
+            .join(".jj")
+            .join("config.toml"),
         _ => {
             return Err(user_error(format!(
                 "Can't get path for config source {config_source:?}"
@@ -2836,14 +2841,17 @@ impl CliRunner {
             .map_err(|err| map_workspace_load_error(err, None));
         layered_configs.read_user_config()?;
         let mut repo_config_path = None;
+        let mut workspace_config_path = None;
         if let Ok(loader) = &maybe_cwd_workspace_loader {
             layered_configs.read_repo_config(loader.repo_path())?;
+            layered_configs.read_workspace_config(loader.workspace_root())?;
             repo_config_path = Some(layered_configs.repo_config_path(loader.repo_path()));
+            workspace_config_path = Some(layered_configs.workspace_config_path(loader.workspace_root()));
         }
         let config = layered_configs.merge();
         ui.reset(&config).map_err(|e| {
             let user_config_path = layered_configs.user_config_path().unwrap_or(None);
-            let paths = [repo_config_path, user_config_path]
+            let paths = [repo_config_path, user_config_path, workspace_config_path]
                 .into_iter()
                 .flatten()
                 .map(|path| format!("- {}", path.display()))
@@ -2869,6 +2877,7 @@ impl CliRunner {
             let loader = WorkspaceLoader::init(&cwd.join(path))
                 .map_err(|err| map_workspace_load_error(err, Some(path)))?;
             layered_configs.read_repo_config(loader.repo_path())?;
+            layered_configs.read_workspace_config(&loader.workspace_root())?;
             Ok(loader)
         } else {
             maybe_cwd_workspace_loader

diff --git a/cli/src/commands/config.rs b/cli/src/commands/config.rs
@@ -36,6 +36,10 @@ pub(crate) struct ConfigLevelArgs {
     /// Target the repo-level config
     #[arg(long, group = "config_level")]
     repo: bool,
+
+    /// Target the workspace-level config
+    #[arg(long, group = "config_level")]
+    workspace: bool,
 }
 
 impl ConfigLevelArgs {
@@ -48,6 +52,8 @@ impl ConfigLevelArgs {
             Some(ConfigSource::User)
         } else if self.repo {
             Some(ConfigSource::Repo)
+        } else if self.workspace {
+            Some(ConfigSource::Workspace)
         } else {
             None
         }

diff --git a/cli/src/config.rs b/cli/src/config.rs
@@ -176,6 +176,7 @@ pub enum ConfigSource {
     // TODO: Track explicit file paths, especially for when user config is a dir.
     User,
     Repo,
+    Workspace,
     CommandArg,
 }
 
@@ -194,7 +195,7 @@ pub struct AnnotatedValue {
 /// 2. Base environment variables
 /// 3. [User config](https://github.com/martinvonz/jj/blob/main/docs/config.md#configuration)
 /// 4. Repo config `.jj/repo/config.toml`
-/// 5. TODO: Workspace config `.jj/config.toml`
+/// 5. Workspace config `.jj/config.toml`
 /// 6. Override environment variables
 /// 7. Command-line arguments `--config-toml`
 #[derive(Clone, Debug)]
@@ -203,6 +204,7 @@ pub struct LayeredConfigs {
     env_base: config::Config,
     user: Option<config::Config>,
     repo: Option<config::Config>,
+    workspace: Option<config::Config>,
     env_overrides: config::Config,
     arg_overrides: Option<config::Config>,
 }
@@ -215,6 +217,7 @@ impl LayeredConfigs {
             env_base: env_base(),
             user: None,
             repo: None,
+            workspace: None,
             env_overrides: env_overrides(),
             arg_overrides: None,
         }
@@ -238,10 +241,20 @@ impl LayeredConfigs {
         Ok(())
     }
 
+    #[instrument]
+    pub fn read_workspace_config(&mut self, workspace_root: &Path) -> Result<(), ConfigError> {
+        self.workspace = Some(read_config_file(&self.workspace_config_path(workspace_root))?);
+        Ok(())
+    }
+
     pub fn repo_config_path(&self, repo_path: &Path) -> PathBuf {
         repo_path.join("config.toml")
     }
 
+    pub fn workspace_config_path(&self, workspace_root: &Path) -> PathBuf {
+        workspace_root.join(".jj").join("config.toml")
+    }
+
     pub fn parse_config_args(&mut self, toml_strs: &[String]) -> Result<(), ConfigError> {
         let config = toml_strs
             .iter()
@@ -271,6 +284,7 @@ impl LayeredConfigs {
             (ConfigSource::Env, Some(&self.env_base)),
             (ConfigSource::User, self.user.as_ref()),
             (ConfigSource::Repo, self.repo.as_ref()),
+            (ConfigSource::Workspace, self.workspace.as_ref()),
             (ConfigSource::Env, Some(&self.env_overrides)),
             (ConfigSource::CommandArg, self.arg_overrides.as_ref()),
         ];
@@ -880,6 +894,7 @@ mod tests {
             env_base: empty_config.to_owned(),
             user: None,
             repo: None,
+            workspace: None,
             env_overrides: empty_config,
             arg_overrides: None,
         };
@@ -911,6 +926,7 @@ mod tests {
             env_base: env_base_config,
             user: None,
             repo: Some(repo_config),
+            workspace: None,
             env_overrides: empty_config,
             arg_overrides: None,
         };
@@ -1034,6 +1050,7 @@ mod tests {
             env_base: empty_config.to_owned(),
             user: Some(user_config),
             repo: Some(repo_config),
+            workspace: None,
             env_overrides: empty_config,
             arg_overrides: None,
         };

diff --git a/cli/tests/[email protected] b/cli/tests/[email protected]
@@ -473,12 +473,13 @@ Start an editor on a jj config file.
 
 Creates the file if it doesn't already exist regardless of what the editor does.
 
-**Usage:** `jj config edit <--user|--repo>`
+**Usage:** `jj config edit <--user|--repo|--workspace>`
 
 ###### **Options:**
 
 * `--user` — Target the user-level config
 * `--repo` — Target the repo-level config
+* `--workspace` — Target the workspace-level config
 
 
 
@@ -518,6 +519,7 @@ List variables set in config file, along with their values
 * `--include-overridden` — Allow printing overridden values
 * `--user` — Target the user-level config
 * `--repo` — Target the repo-level config
+* `--workspace` — Target the workspace-level config
 * `-T`, `--template <TEMPLATE>` — Render each variable using the given template
 
    The following keywords are defined:
@@ -538,20 +540,21 @@ A config file at that path may or may not exist.
 
 See `jj config edit` if you'd like to immediately edit the file.
 
-**Usage:** `jj config path <--user|--repo>`
+**Usage:** `jj config path <--user|--repo|--workspace>`
 
 ###### **Options:**
 
 * `--user` — Target the user-level config
 * `--repo` — Target the repo-level config
+* `--workspace` — Target the workspace-level config
 
 
 
 ## `jj config set`
 
 Update config file to set the given option to a given value
 
-**Usage:** `jj config set <--user|--repo> <NAME> <VALUE>`
+**Usage:** `jj config set <--user|--repo|--workspace> <NAME> <VALUE>`
 
 ###### **Arguments:**
 
@@ -562,6 +565,7 @@ Update config file to set the given option to a given value
 
 * `--user` — Target the user-level config
 * `--repo` — Target the repo-level config
+* `--workspace` — Target the workspace-level config
 
 
 

diff --git a/cli/tests/test_config_command.rs b/cli/tests/test_config_command.rs
@@ -203,10 +203,22 @@ fn test_config_list_layer() {
         ],
     );
 
+    test_env.jj_cmd_ok(
+        &repo_path,
+        &[
+            "config",
+            "set",
+            "--user",
+            "test-layered-workspace-key",
+            "test-original-val",
+        ],
+    );
+
     let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", "--user"]);
     insta::assert_snapshot!(stdout, @r###"
     test-key = "test-val"
     test-layered-key = "test-original-val"
+    test-layered-workspace-key = "test-original-val"
     "###);
 
     // Repo
@@ -221,6 +233,18 @@ fn test_config_list_layer() {
         ],
     );
 
+    // Workspace
+    test_env.jj_cmd_ok(
+        &repo_path,
+        &[
+            "config",
+            "set",
+            "--workspace",
+            "test-layered-workspace-key",
+            "test-layered-val",
+        ],
+    );
+
     let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", "--user"]);
     insta::assert_snapshot!(stdout, @r###"
     test-key = "test-val"
@@ -230,6 +254,11 @@ fn test_config_list_layer() {
     insta::assert_snapshot!(stdout, @r###"
     test-layered-key = "test-layered-val"
     "###);
+
+    let stdout = test_env.jj_cmd_success(&repo_path, &["config", "list", "--workspace"]);
+    insta::assert_snapshot!(stdout, @r###"
+    test-layered-workspace-key = "test-layered-val"
+    "###);
 }
 
 #[test]
@@ -408,16 +437,26 @@ fn test_config_layer_workspace() {
     // Repo
     std::fs::write(
         main_path.join(".jj/repo/config.toml"),
-        format!("{config_key} = {value:?}\n", value = "main-repo"),
+        format!(
+            "ui.merge-editor = \"foo\"\n{config_key} = {value:?}\n",
+            value = "main-repo"
+        ),
+    )
+    .unwrap();
+    // Secondary workspace
+    std::fs::write(
+        secondary_path.join(".jj/config.toml"),
+        format!("{config_key} = {value:?}\n", value = "main-workspace"),
     )
     .unwrap();
+
     let stdout = test_env.jj_cmd_success(&main_path, &["config", "list", config_key]);
     insta::assert_snapshot!(stdout, @r###"
     ui.editor = "main-repo"
     "###);
     let stdout = test_env.jj_cmd_success(&secondary_path, &["config", "list", config_key]);
     insta::assert_snapshot!(stdout, @r###"
-    ui.editor = "main-repo"
+    ui.editor = "main-workspace"
     "###);
 }
 
@@ -427,11 +466,11 @@ fn test_config_set_bad_opts() {
     let stderr = test_env.jj_cmd_cli_error(test_env.env_root(), &["config", "set"]);
     insta::assert_snapshot!(stderr, @r###"
     error: the following required arguments were not provided:
-      <--user|--repo>
+      <--user|--repo|--workspace>
       <NAME>
       <VALUE>
 
-    Usage: jj config set <--user|--repo> <NAME> <VALUE>
+    Usage: jj config set <--user|--repo|--workspace> <NAME> <VALUE>
 
     For more information, try '--help'.
     "###);
@@ -608,9 +647,9 @@ fn test_config_edit_missing_opt() {
     let stderr = test_env.jj_cmd_cli_error(test_env.env_root(), &["config", "edit"]);
     insta::assert_snapshot!(stderr, @r###"
     error: the following required arguments were not provided:
-      <--user|--repo>
+      <--user|--repo|--workspace>
 
-    Usage: jj config edit <--user|--repo>
+    Usage: jj config edit <--user|--repo|--workspace>
 
     For more information, try '--help'.
     "###);

diff --git a/docs/config.md b/docs/config.md
@@ -17,6 +17,10 @@ config path --user`.
 - The repo settings. These can be edited with `jj config edit --repo` and are
 located in `.jj/repo/config.toml`.
 
+- The workspace settings. These can be edited with `jj config edit --workspace`
+and are located in `.jj/config.toml` in the workspace root. The first working
+directory created in a fresh `jj` repo is itself a workspace.
+
 - Settings [specified in the command-line](#specifying-config-on-the-command-line).
 
 These are listed in the order they are loaded; the settings from earlier items