config-schema: add --when and --scope keys

Author: senekor

cli/src/config-schema.json

@@ -904,6 +904,34 @@
                     "default": "none"
                 }
             }
+        },
+        "--when": {
+            "type": "object",
+            "description": "Conditions restriction the application of the configuration",
+            "properties": {
+                "repositories": {
+                    "type": "array",
+                    "description": "List of paths to match the repository path prefix",
+                    "items": {
+                        "type": "string"
+                    }
+                },
+                "commands": {
+                    "type": "array",
+                    "description": "List of subcommands to match",
+                    "items": {
+                        "type": "string"
+                    }
+                }
+            }
+        },
+        "--scope": {
+            "type": "array",
+            "description": "Scoped tables for conditional configuration",
+            "items": {
+                "$comment": "https://json-schema.org/understanding-json-schema/structuring#recursion",
+                "$ref": "#"
+            }
         }
     }
 }

cli/tests/sample-configs/invalid/scope_invalid_key.toml

@@ -0,0 +1,5 @@
+#:schema ../../../src/config-schema.json
+
+[[--scope]]
+--when.repositories = ["~/repos/employer"]
+user.email = 5 # should error because it's not a string

cli/tests/sample-configs/valid/scope.toml

@@ -0,0 +1,7 @@
+#:schema ../../../src/config-schema.json
+
+# configuring the formatting of timestamps only for the log command
+
+[[--scope]]
+--when.commands = ["log"]
+template-aliases.'format_timestamp(timestamp)' = 'timestamp.ago()'

cli/tests/sample-configs/valid/toplevel_when.toml

@@ -0,0 +1,10 @@
+#:schema ../../../src/config-schema.json
+
+# --when can be used at the top-level. This is useful when configuration is
+# organized over several files.
+--when.repositories = ["~/repos/employer"]
+
+# This might be a file that represents all configuration that should apply to
+# the set of repositories belonging to an employer. Setting a custom work email
+# could be a common use case.
+user.email = "[email protected]"