cli: config list: show origin of config values

Adds a `templates.config.list` config option to control whether the
detailed list is shown or not.

The `builtin_config_list_detailed` template adds the config origin to
the end of the line for each config value in the list. Options coming
from files will show the file path.

CHANGELOG.md

···
 
 ### New features
 
+* The command `jj config list` now supports showing the origin of each variable
+  via the `builtin_config_list_detailed` template.
+
 * `jj config {edit,set,unset}` now prompt when multiple config files are found.
 
 * `jj diff -r` now allows multiple revisions (as long as there are no gaps in

cli/src/commands/config/list.rs

···
     pub include_overridden: bool,
     #[command(flatten)]
     pub level: ConfigLevelArgs,
-    // TODO(#1047): Support --show-origin using StackedConfig.
     /// Render each variable using the given template
     ///
     /// The following keywords are available in the template expression:
···
     /// * `name: String`: Config name.
     /// * `value: ConfigValue`: Value to be formatted in TOML syntax.
     /// * `overridden: Boolean`: True if the value is shadowed by other.
+    /// * `source: String`: Source of the value.
+    /// * `path: String`: Path to the config file.
+    ///
+    /// Can be overridden by the `templates.config_list` setting. To
+    /// see a detailed config list, use the `builtin_config_list_detailed`
+    /// template.
     ///
     /// See [`jj help -k templates`] for more information.
     ///
···
 ) -> Result<(), CommandError> {
     let template = {
         let language = config_template_language(command.settings());
-        let text = match &args.template {
-            Some(value) => value.to_owned(),
+        let template_string = match &args.template {
+            Some(value) => value.to_string(),
             None => command.settings().get_string("templates.config_list")?,
         };
         command
-            .parse_template(ui, &language, &text, GenericTemplateLanguage::wrap_self)?
+            .parse_template(
+                ui,
+                &language,
+                &template_string,
+                GenericTemplateLanguage::wrap_self,
+            )?
             .labeled("config_list")
     };
 
···
         // .decorated("", "") to trim leading/trailing whitespace
         let out_property = self_property.map(|annotated| annotated.value.decorated("", ""));
         Ok(L::wrap_config_value(out_property))
+    });
+    language.add_keyword("source", |self_property| {
+        let out_property = self_property.map(|annotated| annotated.source.to_string());
+        Ok(L::wrap_string(out_property))
+    });
+    language.add_keyword("path", |self_property| {
+        let out_property = self_property.map(|annotated| {
+            annotated
+                .path
+                .as_ref()
+                .map_or_else(String::new, |path| path.to_string_lossy().to_string())
+        });
+        Ok(L::wrap_string(out_property))
     });
     language.add_keyword("overridden", |self_property| {
         let out_property = self_property.map(|annotated| annotated.is_overridden);

cli/src/config.rs

···
     pub value: ConfigValue,
     /// Source of the configuration value.
     pub source: ConfigSource,
-    // TODO: add source file path
+    /// Path to the source file, if available.
+    pub path: Option<PathBuf>,
     /// True if this value is overridden in higher precedence layers.
     pub is_overridden: bool,
 }
···
                     name,
                     value,
                     source: layer.source,
+                    path: layer.path.clone(),
                     is_overridden,
                 });
             }
···
                     },
                 ),
                 source: EnvBase,
+                path: None,
                 is_overridden: false,
             },
             AnnotatedValue {
···
                     },
                 ),
                 source: EnvBase,
+                path: None,
                 is_overridden: true,
             },
             AnnotatedValue {
···
                     },
                 ),
                 source: Repo,
+                path: None,
                 is_overridden: false,
             },
         ]
···
                     },
                 ),
                 source: User,
+                path: None,
                 is_overridden: false,
             },
             AnnotatedValue {
···
                     },
                 ),
                 source: Repo,
+                path: None,
                 is_overridden: false,
             },
         ]

cli/src/config/colors.toml

···
 
 "config_list name" = "green"
 "config_list value" = "yellow"
+"config_list source" = "blue"
+"config_list path" = "magenta"
 "config_list overridden" = "bright black"
 "config_list overridden name" = "bright black"
 "config_list overridden value" = "bright black"
+"config_list overridden source" = "bright black"
+"config_list overridden path" = "bright black"
 
 "diff header" = "yellow"
 "diff empty" = "cyan"

cli/src/config/templates.toml

···
 ) ++ ": " ++ content
 '''
 
-config_list = '''
-if(overridden,
-  label("overridden", indent("# ", name ++ " = " ++ value)),
-  name ++ " = " ++ value,
-) ++ "\n"
-'''
+config_list = 'builtin_config_list'
 
 draft_commit_description = '''
 concat(
···
 '''
 
 [template-aliases]
+
+builtin_config_item = '''
+if(overridden,
+  label("overridden", indent("# ", name ++ " = " ++ value)),
+  name ++ " = " ++ value,
+)
+'''
+
+builtin_config_list = 'builtin_config_item ++ "\n"'
+
+builtin_config_list_detailed = '''
+if(overridden,
+  label("overridden", builtin_config_item ++ " # " ++ separate(" ", source, path)),
+  builtin_config_item ++ " # " ++ separate(" ", source, path),
+) ++ "\n"
+'''
+
 builtin_log_oneline = '''
 if(root,
   format_root_commit(self),

cli/tests/cli-reference@.md.snap

···
    * `name: String`: Config name.
    * `value: ConfigValue`: Value to be formatted in TOML syntax.
    * `overridden: Boolean`: True if the value is shadowed by other.
+   * `source: String`: Source of the value.
+   * `path: String`: Path to the config file.
+
+   Can be overridden by the `templates.config_list` setting. To
+   see a detailed config list, use the `builtin_config_list_detailed`
+   template.
 
    See [`jj help -k templates`] for more information.
 

cli/tests/test_completion.rs

···
 
     let output = test_env.run_jj_in(dir, ["--", "jj", "log", "-T", ""]);
     insta::assert_snapshot!(output, @r"
+    builtin_config_item
+    builtin_config_list
+    builtin_config_list_detailed
     builtin_log_comfortable
     builtin_log_compact
     builtin_log_compact_full_description

cli/tests/test_config_command.rs

···
 }
 
 #[test]
+fn test_config_list_origin() {
+    let mut test_env = TestEnvironment::default();
+    test_env.run_jj_in(".", ["git", "init", "repo"]).success();
+    // Test with fresh new config file
+    let user_config_path = test_env.config_path().join("config.toml");
+    test_env.set_config_path(&user_config_path);
+    let repo_path = test_env.env_root().join("repo");
+
+    // User
+    test_env
+        .run_jj_in(
+            &repo_path,
+            ["config", "set", "--user", "test-key", "test-val"],
+        )
+        .success();
+
+    test_env
+        .run_jj_in(
+            &repo_path,
+            [
+                "config",
+                "set",
+                "--user",
+                "test-layered-key",
+                "test-original-val",
+            ],
+        )
+        .success();
+
+    // Repo
+    test_env
+        .run_jj_in(
+            &repo_path,
+            [
+                "config",
+                "set",
+                "--repo",
+                "test-layered-key",
+                "test-layered-val",
+            ],
+        )
+        .success();
+
+    let output = test_env.run_jj_in(
+        &repo_path,
+        [
+            "config",
+            "list",
+            "-Tbuiltin_config_list_detailed",
+            "--config",
+            "test-cli-key=test-cli-val",
+        ],
+    );
+    insta::assert_snapshot!(output, @r#"
+    test-key = "test-val" # user $TEST_ENV/config/config.toml
+    test-layered-key = "test-layered-val" # repo $TEST_ENV/repo/.jj/repo/config.toml
+    user.name = "Test User" # env
+    user.email = "[e-mail]" # env
+    debug.commit-timestamp = "2001-02-03T04:05:11+07:00" # env
+    debug.randomness-seed = 5 # env
+    debug.operation-timestamp = "2001-02-03T04:05:11+07:00" # env
+    operation.hostname = "host.example.com" # env
+    operation.username = "test-username" # env
+    test-cli-key = "test-cli-val" # cli
+    [EOF]
+    "#);
+}
+
+#[test]
 fn test_config_layer_override_default() {
     let test_env = TestEnvironment::default();
     test_env.run_jj_in(".", ["git", "init", "repo"]).success();

cli/tests/test_evolog_command.rs

···
 
     For more information, try '--help'.
     Hint: The following template aliases are defined:
+    - builtin_config_item
+    - builtin_config_list
+    - builtin_config_list_detailed
     - builtin_log_comfortable
     - builtin_log_compact
     - builtin_log_compact_full_description

cli/tests/test_log_command.rs

···
 
     For more information, try '--help'.
     Hint: The following template aliases are defined:
+    - builtin_config_item
+    - builtin_config_list
+    - builtin_config_list_detailed
     - builtin_log_comfortable
     - builtin_log_compact
     - builtin_log_compact_full_description

cli/tests/test_operations.rs

···
 
     For more information, try '--help'.
     Hint: The following template aliases are defined:
+    - builtin_config_item
+    - builtin_config_list
+    - builtin_config_list_detailed
     - builtin_log_comfortable
     - builtin_log_compact
     - builtin_log_compact_full_description

cli/tests/test_show_command.rs

···
 
     For more information, try '--help'.
     Hint: The following template aliases are defined:
+    - builtin_config_item
+    - builtin_config_list
+    - builtin_config_list_detailed
     - builtin_log_comfortable
     - builtin_log_compact
     - builtin_log_compact_full_description

cli/tests/test_templater.rs

···
       | ^-----^
       |
       = Keyword `builtin` doesn't exist
-    Hint: Did you mean `builtin_log_comfortable`, `builtin_log_compact`, `builtin_log_compact_full_description`, `builtin_log_detailed`, `builtin_log_node`, `builtin_log_node_ascii`, `builtin_log_oneline`, `builtin_op_log_comfortable`, `builtin_op_log_compact`, `builtin_op_log_node`, `builtin_op_log_node_ascii`, `builtin_op_log_oneline`?
+    Hint: Did you mean `builtin_config_item`, `builtin_config_list`, `builtin_config_list_detailed`, `builtin_log_comfortable`, `builtin_log_compact`, `builtin_log_compact_full_description`, `builtin_log_detailed`, `builtin_log_node`, `builtin_log_node_ascii`, `builtin_log_oneline`, `builtin_op_log_comfortable`, `builtin_op_log_compact`, `builtin_op_log_node`, `builtin_op_log_node_ascii`, `builtin_op_log_oneline`?
     [EOF]
     [exit status: 1]
     ");

docs/config.md

···
 You can pass the `--no-edit` flag to `prev` and `next` if you find yourself
 needing the original behavior.
 
+## List
+
+### Default Template
+
+You can configure the template used when no `-T` is specified.
+
+- `templates.config_list` for `jj config list`
+
+```toml
+[templates]
+# Use builtin config list template
+config_list = "builtin_config_list"
+```
+
+If you want to see the config variable origin (type and path) when you do `jj config list`
+you can add this to your config:
+
+```toml
+[templates]
+config_list = "builtin_config_list_detailed"
+```
+
+
 ## Log
 
 ### Default revisions

lib/src/config.rs

···
 use std::borrow::Borrow;
 use std::convert::Infallible;
 use std::fmt;
+use std::fmt::Display;
 use std::fs;
 use std::io;
 use std::ops::Range;
···
     EnvOverrides,
     /// Command-line arguments (which has the highest precedence.)
     CommandArg,
+}
+
+impl Display for ConfigSource {
+    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
+        use ConfigSource::*;
+        let c = match self {
+            Default => "default",
+            User => "user",
+            Repo => "repo",
+            CommandArg => "cli",
+            EnvBase | EnvOverrides => "env",
+        };
+        write!(f, "{c}")
+    }
 }
 
 /// Set of configuration variables with source information.