docs(customization): add a json config file as a example for the new implementation

danvergara · Lee-W · commit 987107aa22a0 · 2020-12-02T16:40:15.000+08:00
120
diff --git a/docs/customization.md b/docs/customization.md
@@ -3,7 +3,7 @@ We have two different ways to do so.
 
 ## 1. Customize in configuration file
 
-**This is only supported when configuring through `toml` (e.g., `pyproject.toml`, `.cz`, and `.cz.toml`)**
+**This is only supported when configuring through `toml` or `json` (e.g., `pyproject.toml`, `.cz.toml`, `.cz.toml`, `.cz.json`, and `cz.json`)**
 
 The basic steps are:
 
@@ -46,6 +46,58 @@ name = "show_message"
 message = "Do you want to add body message in commit?"
 ```
 
+The equivalent example for a json config file:
+
+```json
+{
+    "commitizen": {
+	"name": "cz_customize",
+        "customize": {
+            "message_template": "{{change_type}}:{% if show_message %} {{message}}{% endif %}",
+            "example": "feature: this feature enable customize through config file",
+            "schema": "<type>: <body>",
+            "schema_pattern": "(feature|bug fix):(\\s.*)",
+            "bump_pattern": "^(break|new|fix|hotfix)",
+            "bump_map": {
+                "break": "MAJOR",
+                "new": "MINOR",
+                "fix": "PATCH",
+                "hotfix": "PATCH"
+            },
+	    "info_path": "cz_customize_info.txt",
+            "info": "This is customized info",
+            "questions": [
+                {
+                    "type": "list",
+                    "name": "change_type",
+                    "choices": [
+                        {
+                            "value": "feature",
+                            "name": "feature: A new feature."
+                        },
+                        {
+                            "value": "bug fix",
+                            "name": "bug fix: A bug fix."
+                        }
+                    ],
+                    "message": "Select the type of change you are committing"
+                },
+                {
+                    "type": "input",
+                    "name": "message",
+                    "message": "Body."
+                },
+                {
+                    "type": "confirm",
+                    "name": "show_message",
+                    "message": "Do you want to add body message in commit?"
+                }
+            ]
+        }
+    }
+}
+```
+
 ### Customize configuration
 
 | Parameter          | Type   | Default | Description                                                                                                                                                                                                                                                            |
