feat(command): open in terminal editor command in composing message

On OPEN_IN_TERMINAL_EDITOR command allow to edit the current message in terminal editor with python tempfile.

Author: mek-yt

docs/hotkeys.md

@@ -96,4 +96,5 @@
 |Jump to the previous line|<kbd>up</kbd> / <kbd>ctrl</kbd> + <kbd>p</kbd>|
 |Jump to the next line|<kbd>down</kbd> / <kbd>ctrl</kbd> + <kbd>n</kbd>|
 |Clear compose box|<kbd>ctrl</kbd> + <kbd>l</kbd>|
+|Open the message in external editor|<kbd>ctrl</kbd> + <kbd>o</kbd>|
 

zulipterminal/config/keys.py

@@ -385,6 +385,11 @@ class KeyBinding(TypedDict):
         'help_text': 'Clear compose box',
         'key_category': 'msg_compose',
     },
+    'OPEN_EXTERNAL_EDITOR': {
+        'keys': ['ctrl o'],
+        'help_text': 'Open the message in external editor',
+        'key_category': 'msg_compose',
+    },
     'FULL_RENDERED_MESSAGE': {
         'keys': ['f'],
         'help_text': 'Show/hide full rendered message (from message information)',

zulipterminal/ui_tools/boxes.py

@@ -2,10 +2,14 @@
 UI boxes for entering text: WriteBox, MessageSearchBox, PanelSearchBox
 """
 
+import os
 import re
+import shutil
+import subprocess
 import unicodedata
 from collections import Counter
 from datetime import datetime, timedelta
+from tempfile import NamedTemporaryFile
 from time import sleep
 from typing import Any, Callable, Dict, List, NamedTuple, Optional, Tuple
 
@@ -810,6 +814,40 @@ def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         elif is_command_key("MARKDOWN_HELP", key):
             self.view.controller.show_markdown_help()
             return key
+        elif is_command_key("OPEN_EXTERNAL_EDITOR", key):
+            editor = os.environ.get("ZULIP_EDITOR_COMMAND", os.environ.get("EDITOR"))
+            if editor is None:
+                self.view.controller.report_error(
+                    "Configure $EDITOR or $ZULIP_EDITOR_COMMAND shell environment."
+                )
+                return key
+            editor_splits = editor.split(" ")
+            if len(editor_splits) >= 1:
+                fullpath_program = shutil.which(editor_splits[0])
+                if fullpath_program is None:
+                    self.view.controller.report_error(
+                        "Editor program not found, check $EDITOR "
+                        "or $ZULIP_EDITOR_COMMAND."
+                    )
+                    return key
+                editor_splits[0] = fullpath_program
+            edit_tempfile = NamedTemporaryFile(suffix=".md")
+            with open(edit_tempfile.name, mode="w") as edit_writer:
+                edit_writer.write(self.msg_write_box.edit_text)
+            self.view.controller.loop.screen.stop()
+            if "TEMPFILE" not in editor:
+                editor_splits.append(edit_tempfile.name)
+            else:
+                editor_splits = [
+                    part if part != "TEMPFILE" else edit_tempfile.name
+                    for part in editor_splits
+                ]
+            subprocess.call(editor_splits)
+            with open(edit_tempfile.name, mode="r") as edit_reader:
+                self.msg_write_box.edit_text = edit_reader.read()
+            edit_tempfile.close()
+            self.view.controller.loop.screen.start()
+            return key
         elif is_command_key("SAVE_AS_DRAFT", key):
             if self.msg_edit_state is None:
                 if self.compose_box_status == "open_with_private":