feat(commit-input): enhance multiline input to behave like an editor

Author: anasalaqeel

commitizen/commands/commit.py

@@ -13,7 +13,7 @@
 from commitizen import factory, git, out
 from commitizen.config import BaseConfig
 from commitizen.cz.exceptions import CzException
-from commitizen.cz.utils import get_backup_file_path, get_input_with_continuation
+from commitizen.cz.utils import get_backup_file_path
 from commitizen.exceptions import (
     CommitError,
     CommitMessageLengthExceededError,
@@ -82,14 +82,20 @@ def _prompt_commit_questions(self) -> str:
                     if isinstance(root_err, CzException):
                         raise CustomError(root_err.__str__())
                     raise err
-            elif question["type"] == "input" and question.get("continuation", False):
-                print(f"\033[90m💡 Type backslash and press Enter for line continuation\033[0m")
-                raw_answer = get_input_with_continuation(question["message"])
-                if "filter" in question:
-                    processed_answer = question["filter"](raw_answer)
-                else:
-                    processed_answer = raw_answer
-                answers[question["name"]] = processed_answer
+            elif question["type"] == "input" and question.get("multiline", False):
+                print(f"\033[90m💡 Multiline input:\n Press Enter for new lines and Esc+Enter to finish\033[0m \n \033[90mor (Finish with 'Alt+Enter' or 'Esc then Enter')\033[0m")
+                multiline_question = question.copy()
+                multiline_question["multiline"] = True
+                try:
+                    answer = questionary.prompt([multiline_question], style=cz.style)
+                    if not answer:
+                        raise NoAnswersError()
+                    answers.update(answer)
+                except ValueError as err:
+                    root_err = err.__context__
+                    if isinstance(root_err, CzException):
+                        raise CustomError(root_err.__str__())
+                    raise err
             else:
                 try:
                     answer = questionary.prompt([question], style=cz.style)

commitizen/cz/utils.py

@@ -20,28 +20,6 @@ def multiple_line_breaker(answer: str, sep: str = "|") -> str:
     return "\n".join(line.strip() for line in answer.split(sep) if line)
 
 
-def get_input_with_continuation(message: str) -> str:
-    """Get input with shell-like backslash line continuation."""
-    lines = []
-    prompt_msg = message + "\n"
-
-    while True:
-        try:
-            line = questionary.text(prompt_msg).ask()
-            if line is None:
-                return ""
-
-            if line.rstrip().endswith("\\"):
-                lines.append(line.rstrip()[:-1].rstrip())
-                prompt_msg = ">"
-            else:
-                lines.append(line)
-                break
-
-        except KeyboardInterrupt:
-            return ""
-
-    return "\n".join(lines)
 
 
 def strip_local_version(version: str) -> str:

commitizen/question.py

@@ -22,7 +22,6 @@ class InputQuestion(TypedDict, total=False):
     filter: Callable[[str], str]
     multiline: bool
     default: str
-    continuation: bool
 
 
 class ConfirmQuestion(TypedDict):

docs/customization.md

@@ -176,7 +176,6 @@ commitizen:
 | `choices`   | `list` | `None`  | (OPTIONAL) The choices when `type = list` or `type = select`. Either use a list of values or a list of dictionaries with `name` and `value` keys. Keyboard shortcuts can be defined via `key`. See examples above. |
 | `default`   | `Any`  | `None`  | (OPTIONAL) The default value for this question.                                                                                                                                                 |
 | `filter`    | `str`  | `None`  | (OPTIONAL) Validator for user's answer. **(Work in Progress)**                                                                                                                                  |
-| `multiline` | `bool` | `False` | (OPTIONAL) Enable multiline support when `type = input`.                                                                                                                                        |
 | `use_search_filter` | `bool` | `False` | (OPTIONAL) Enable search/filter functionality for list/select type questions. This allows users to type and filter through the choices.                                                  |
 | `use_jk_keys` | `bool` | `True` | (OPTIONAL) Enable/disable j/k keys for navigation in list/select type questions. Set to false if you prefer arrow keys only.                                                                    |