feat(commit-input): support multiline input using backslash

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
+from commitizen.cz.utils import get_backup_file_path, get_input_with_continuation
 from commitizen.exceptions import (
     CommitError,
     CommitMessageLengthExceededError,
@@ -66,18 +66,41 @@ def _prompt_commit_questions(self) -> str:
         # Prompt user for the commit message
         cz = self.cz
         questions = cz.questions()
-        for question in (q for q in questions if q["type"] == "list"):
-            question["use_shortcuts"] = self.config.settings["use_shortcuts"]
-        try:
-            answers = questionary.prompt(questions, style=cz.style)
-        except ValueError as err:
-            root_err = err.__context__
-            if isinstance(root_err, CzException):
-                raise CustomError(root_err.__str__())
-            raise err
-
-        if not answers:
-            raise NoAnswersError()
+        answers = {}
+
+        # Handle questions one by one to support custom continuation
+        for question in questions:
+            if question["type"] == "list":
+                question["use_shortcuts"] = self.config.settings["use_shortcuts"]
+                try:
+                    answer = questionary.prompt([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
+            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
+            else:
+                try:
+                    answer = questionary.prompt([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
 
         message = cz.message(answers)
         message_len = len(message.partition("\n")[0].strip())

commitizen/cz/conventional_commits/conventional_commits.py

@@ -109,26 +109,23 @@ def questions(self) -> list[CzQuestion]:
             {
                 "type": "input",
                 "name": "scope",
-                "message": (
-                    "What is the scope of this change? (class or file name): (press [enter] to skip)\n"
-                ),
+                "message": "What is the scope of this change? (class or file name): (press [enter] to skip)",
                 "filter": _parse_scope,
+                "multiline": True,
             },
             {
                 "type": "input",
                 "name": "subject",
                 "filter": _parse_subject,
-                "message": (
-                    "Write a short and imperative summary of the code changes: (lower case and no period)\n"
-                ),
+                "message": "Write a short and imperative summary of the code changes: (lower case and no period)",
+                "multiline": True,
             },
             {
                 "type": "input",
                 "name": "body",
-                "message": (
-                    "Provide additional contextual information about the code changes: (press [enter] to skip)\n"
-                ),
-                "filter": multiple_line_breaker,
+                "message": "Provide additional contextual information about the code changes:\n(Type backslash and press Enter for line continuation, or use multiline input, or [Enter] to skip)",
+                "multiline": True,
+                "default": "",
             },
             {
                 "type": "confirm",
@@ -139,10 +136,8 @@ def questions(self) -> list[CzQuestion]:
             {
                 "type": "input",
                 "name": "footer",
-                "message": (
-                    "Footer. Information about Breaking Changes and "
-                    "reference issues that this commit closes: (press [enter] to skip)\n"
-                ),
+                "message": "Footer. Information about Breaking Changes and reference issues that this commit closes: (press [enter] to skip)",
+                "multiline": True,
             },
         ]
 

commitizen/cz/utils.py

@@ -2,6 +2,8 @@
 import re
 import tempfile
 
+import questionary
+
 from commitizen import git
 from commitizen.cz import exceptions
 
@@ -18,6 +20,30 @@ 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:
     return _RE_LOCAL_VERSION.sub("", version)
 

commitizen/question.py

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