Merge pull request #42 from Lee-W/feature/configurable-prompt-style

make style configurable for commit command

Author: woile

commitizen/commands/commit.py

@@ -36,7 +36,7 @@ def __call__(self):
             # Prompt user for the commit message
             cz = self.cz
             questions = cz.questions()
-            answers = questionary.prompt(questions)
+            answers = questionary.prompt(questions, style=cz.style)
             if not answers:
                 raise SystemExit(NO_ANSWERS)
             m = cz.message(answers)

commitizen/config.py

@@ -61,6 +61,10 @@ def read_raw_parser_conf(data: str) -> dict:
         "commitizen/__version__.py",
         "pyproject.toml"
         ]  # this tab at the end is important
+    style = [
+        ["pointer", "reverse"],
+        ["question", "underline"]
+        ]  # this tab at the end is important
     ```
     """
     config = configparser.ConfigParser(allow_no_value=True)
@@ -71,6 +75,10 @@ def read_raw_parser_conf(data: str) -> dict:
             files = _data["files"]
             _f = json.loads(files)
             _data.update({"files": _f})
+        if "style" in _data:
+            style = _data["style"]
+            _s = json.loads(style)
+            _data.update({"style": _s})
 
         return _data
 

commitizen/cz/base.py

@@ -1,13 +1,29 @@
-from typing import Optional
+from typing import Optional, List, Tuple
 from abc import ABCMeta, abstractmethod
 
+from prompt_toolkit.styles import merge_styles, Style
+
 
 class BaseCommitizen(metaclass=ABCMeta):
     bump_pattern: Optional[str] = None
     bump_map: Optional[dict] = None
+    default_style_config: List[Tuple[str, str]] = [
+        ("qmark", "fg:#ff9d00 bold"),
+        ("question", "bold"),
+        ("answer", "fg:#ff9d00 bold"),
+        ("pointer", "fg:#ff9d00 bold"),
+        ("highlighted", "fg:#ff9d00 bold"),
+        ("selected", "fg:#cc5454"),
+        ("separator", "fg:#cc5454"),
+        ("instruction", ""),
+        ("text", ""),
+        ("disabled", "fg:#858585 italic"),
+    ]
 
     def __init__(self, config: dict):
         self.config = config
+        if not self.config.get("style"):
+            self.config["style"] = BaseCommitizen.default_style_config
 
     @abstractmethod
     def questions(self) -> list:
@@ -17,6 +33,12 @@ def questions(self) -> list:
     def message(self, answers: dict) -> str:
         """Format your git message."""
 
+    @property
+    def style(self):
+        return merge_styles(
+            [Style(BaseCommitizen.default_style_config), Style(self.config["style"])]
+        )
+
     def example(self) -> str:
         """Example of the commit message."""
         raise NotImplementedError("Not Implemented yet")

docs/config.md

@@ -13,6 +13,18 @@ Add an entry to `pyproject.toml`. Recommended for **python** projects.
         "src/__version__.py",
         "pyproject.toml:version"
     ]
+    style = [
+        ["qmark", "fg:#ff9d00 bold"],
+        ["question", "bold"],
+        ["answer", "fg:#ff9d00 bold"],
+        ["pointer", "fg:#ff9d00 bold"],
+        ["highlighted", "fg:#ff9d00 bold"],
+        ["selected", "fg:#cc5454"],
+        ["separator", "fg:#cc5454"],
+        ["instruction", ""],
+        ["text", ""],
+        ["disabled", "fg:#858585 italic"]
+    ]
 
 ## INI files
 
@@ -28,6 +40,18 @@ Recommended for **other languages** projects (js, go, etc).
         "src/__version__.py",
         "pyproject.toml:version"
         ]
+    style = [
+        ["qmark", "fg:#ff9d00 bold"],
+        ["question", "bold"],
+        ["answer", "fg:#ff9d00 bold"],
+        ["pointer", "fg:#ff9d00 bold"],
+        ["highlighted", "fg:#ff9d00 bold"],
+        ["selected", "fg:#cc5454"],
+        ["separator", "fg:#cc5454"],
+        ["instruction", ""],
+        ["text", ""],
+        ["disabled", "fg:#858585 italic"]
+        ]
 
 The extra tab before the square brakets (`]`) at the end is required.
 
@@ -40,3 +64,4 @@ The extra tab before the square brakets (`]`) at the end is required.
 | `files` | `list` | `[ ]` | Files were the version will be updated. A pattern to match a line, can also be specified, separated by `:` [See more](https://woile.github.io/commitizen/bump#files) |
 | `tag_format` | `str` | `None` | Format for the git tag, useful for old projects, that use a convention like `"v1.2.1"`. [See more](https://woile.github.io/commitizen/bump#tag_format) |
 | `bump_message` | `str` | `None` | Create custom commit message, useful to skip ci. [See more](https://woile.github.io/commitizen/bump#bump_message) |
+| `style` | `list` | see above | Style for the prompts (It will merge this value with default style.) [See More (Styling your prompts with your favorite colors)](https://github.com/tmbo/questionary#additional-features) |

tests/test_conf.py

@@ -11,6 +11,10 @@
     "commitizen/__version__.py",
     "pyproject.toml"
 ]
+style = [
+    ["pointer", "reverse"],
+    ["question", "underline"]
+]
 
 [tool.black]
 line-length = 88
@@ -25,6 +29,10 @@
     "commitizen/__version__.py",
     "pyproject.toml"
     ]
+style = [
+    ["pointer", "reverse"],
+    ["question", "underline"]
+    ]
 """
 
 _config = {
@@ -33,6 +41,7 @@
     "tag_format": None,
     "bump_message": None,
     "files": ["commitizen/__version__.py", "pyproject.toml"],
+    "style": [["pointer", "reverse"], ["question", "underline"]]
 }
 
 _new_config = {
@@ -41,12 +50,14 @@
     "tag_format": None,
     "bump_message": None,
     "files": ["commitizen/__version__.py", "pyproject.toml"],
+    "style": [["pointer", "reverse"], ["question", "underline"]]
 }
 
 _read_conf = {
     "name": "cz_jira",
     "version": "1.0.0",
     "files": ["commitizen/__version__.py", "pyproject.toml"],
+    "style": [["pointer", "reverse"], ["question", "underline"]]
 }