lint-hotkeys: Use keyboard representation in hotkeys doc.

Applies
- Capitalization of all keys.
- Add Shift for uppercase keys.
- Fix "<kbd>page</kbd> + <kbd>up</kbd>" to "<kbd>PgUp</kbd>".

Author: Niloth-p

docs/hotkeys.md

@@ -6,96 +6,96 @@
 |Command|Key Combination|
 | :--- | :---: |
 |Show/hide help menu|<kbd>?</kbd>|
-|Show/hide markdown help menu|<kbd>meta</kbd> + <kbd>m</kbd>|
-|Show/hide about menu|<kbd>meta</kbd> + <kbd>?</kbd>|
-|Go Back|<kbd>esc</kbd>|
-|Open draft message saved in this session|<kbd>d</kbd>|
-|Redraw screen|<kbd>ctrl</kbd> + <kbd>l</kbd>|
-|Quit|<kbd>ctrl</kbd> + <kbd>c</kbd>|
-|View user information (From Users list)|<kbd>i</kbd>|
+|Show/hide markdown help menu|<kbd>Meta</kbd> + <kbd>M</kbd>|
+|Show/hide about menu|<kbd>Meta</kbd> + <kbd>?</kbd>|
+|Go Back|<kbd>Esc</kbd>|
+|Open draft message saved in this session|<kbd>D</kbd>|
+|Redraw screen|<kbd>Ctrl</kbd> + <kbd>L</kbd>|
+|Quit|<kbd>Ctrl</kbd> + <kbd>C</kbd>|
+|View user information (From Users list)|<kbd>I</kbd>|
 
 ## Navigation
 |Command|Key Combination|
 | :--- | :---: |
-|Go up / Previous message|<kbd>up</kbd> / <kbd>k</kbd>|
-|Go down / Next message|<kbd>down</kbd> / <kbd>j</kbd>|
-|Go left|<kbd>left</kbd> / <kbd>h</kbd>|
-|Go right|<kbd>right</kbd> / <kbd>l</kbd>|
-|Scroll up|<kbd>page</kbd> + <kbd>up</kbd> / <kbd>K</kbd>|
-|Scroll down|<kbd>page</kbd> + <kbd>down</kbd> / <kbd>J</kbd>|
-|Go to bottom / Last message|<kbd>end</kbd> / <kbd>G</kbd>|
-|Narrow to all messages|<kbd>a</kbd> / <kbd>esc</kbd>|
-|Narrow to all direct messages|<kbd>P</kbd>|
-|Narrow to all starred messages|<kbd>f</kbd>|
+|Go up / Previous message|<kbd>Up</kbd> / <kbd>K</kbd>|
+|Go down / Next message|<kbd>Down</kbd> / <kbd>J</kbd>|
+|Go left|<kbd>Left</kbd> / <kbd>H</kbd>|
+|Go right|<kbd>Right</kbd> / <kbd>L</kbd>|
+|Scroll up|<kbd>PgUp</kbd> / <kbd>Shift</kbd> + <kbd>K</kbd>|
+|Scroll down|<kbd>PgDn</kbd> / <kbd>Shift</kbd> + <kbd>J</kbd>|
+|Go to bottom / Last message|<kbd>End</kbd> / <kbd>Shift</kbd> + <kbd>G</kbd>|
+|Narrow to all messages|<kbd>A</kbd> / <kbd>Esc</kbd>|
+|Narrow to all direct messages|<kbd>Shift</kbd> + <kbd>P</kbd>|
+|Narrow to all starred messages|<kbd>F</kbd>|
 |Narrow to messages in which you're mentioned|<kbd>#</kbd>|
-|Next unread topic|<kbd>n</kbd>|
-|Next unread direct message|<kbd>p</kbd>|
-|Perform current action|<kbd>enter</kbd>|
+|Next unread topic|<kbd>N</kbd>|
+|Next unread direct message|<kbd>P</kbd>|
+|Perform current action|<kbd>Enter</kbd>|
 
 ## Searching
 |Command|Key Combination|
 | :--- | :---: |
-|Search Users|<kbd>w</kbd>|
+|Search Users|<kbd>W</kbd>|
 |Search Messages|<kbd>/</kbd>|
-|Search Streams|<kbd>q</kbd>|
-|Search topics in a stream|<kbd>q</kbd>|
-|Search emojis from Emoji-picker popup|<kbd>p</kbd>|
+|Search Streams|<kbd>Q</kbd>|
+|Search topics in a stream|<kbd>Q</kbd>|
+|Search emojis from Emoji-picker popup|<kbd>P</kbd>|
 
 ## Message actions
 |Command|Key Combination|
 | :--- | :---: |
-|Reply to the current message|<kbd>r</kbd> / <kbd>enter</kbd>|
+|Reply to the current message|<kbd>R</kbd> / <kbd>Enter</kbd>|
 |Reply mentioning the sender of the current message|<kbd>@</kbd>|
 |Reply quoting the current message text|<kbd>></kbd>|
-|Reply directly to the sender of the current message|<kbd>R</kbd>|
-|Edit message's content or topic|<kbd>e</kbd>|
-|New message to a stream|<kbd>c</kbd>|
-|New message to a person or group of people|<kbd>x</kbd>|
+|Reply directly to the sender of the current message|<kbd>Shift</kbd> + <kbd>R</kbd>|
+|Edit message's content or topic|<kbd>E</kbd>|
+|New message to a stream|<kbd>C</kbd>|
+|New message to a person or group of people|<kbd>X</kbd>|
 |Show/hide Emoji picker popup for current message|<kbd>:</kbd>|
-|Narrow to the stream of the current message|<kbd>s</kbd>|
-|Narrow to the topic of the current message|<kbd>S</kbd>|
-|Narrow to a topic/direct-chat, or stream/all-direct-messages|<kbd>z</kbd>|
+|Narrow to the stream of the current message|<kbd>S</kbd>|
+|Narrow to the topic of the current message|<kbd>Shift</kbd> + <kbd>S</kbd>|
+|Narrow to a topic/direct-chat, or stream/all-direct-messages|<kbd>Z</kbd>|
 |Toggle first emoji reaction on selected message|<kbd>=</kbd>|
 |Add/remove thumbs-up reaction to the current message|<kbd>+</kbd>|
-|Add/remove star status of the current message|<kbd>ctrl</kbd> + <kbd>s</kbd> / <kbd>*</kbd>|
-|Show/hide message information|<kbd>i</kbd>|
-|Show/hide message sender information|<kbd>u</kbd>|
-|Show/hide edit history (from message information)|<kbd>e</kbd>|
-|View current message in browser (from message information)|<kbd>v</kbd>|
-|Show/hide full rendered message (from message information)|<kbd>f</kbd>|
-|Show/hide full raw message (from message information)|<kbd>r</kbd>|
+|Add/remove star status of the current message|<kbd>Ctrl</kbd> + <kbd>S</kbd> / <kbd>*</kbd>|
+|Show/hide message information|<kbd>I</kbd>|
+|Show/hide message sender information|<kbd>U</kbd>|
+|Show/hide edit history (from message information)|<kbd>E</kbd>|
+|View current message in browser (from message information)|<kbd>V</kbd>|
+|Show/hide full rendered message (from message information)|<kbd>F</kbd>|
+|Show/hide full raw message (from message information)|<kbd>R</kbd>|
 
 ## Stream list actions
 |Command|Key Combination|
 | :--- | :---: |
-|Toggle topics in a stream|<kbd>t</kbd>|
-|Mute/unmute Streams|<kbd>m</kbd>|
-|Show/hide stream information & modify settings|<kbd>i</kbd>|
-|Show/hide stream members (from stream information)|<kbd>m</kbd>|
-|Copy stream email to clipboard (from stream information)|<kbd>c</kbd>|
+|Toggle topics in a stream|<kbd>T</kbd>|
+|Mute/unmute Streams|<kbd>M</kbd>|
+|Show/hide stream information & modify settings|<kbd>I</kbd>|
+|Show/hide stream members (from stream information)|<kbd>M</kbd>|
+|Copy stream email to clipboard (from stream information)|<kbd>C</kbd>|
 
 ## Composing a Message
 |Command|Key Combination|
 | :--- | :---: |
-|Cycle through recipient and content boxes|<kbd>tab</kbd>|
-|Send a message|<kbd>ctrl</kbd> + <kbd>d</kbd> / <kbd>meta</kbd> + <kbd>enter</kbd>|
-|Save current message as a draft|<kbd>meta</kbd> + <kbd>s</kbd>|
-|Autocomplete @mentions, #stream_names, :emoji: and topics|<kbd>ctrl</kbd> + <kbd>f</kbd>|
-|Cycle through autocomplete suggestions in reverse|<kbd>ctrl</kbd> + <kbd>r</kbd>|
-|Narrow to compose box message recipient|<kbd>meta</kbd> + <kbd>.</kbd>|
-|Jump to the beginning of line|<kbd>ctrl</kbd> + <kbd>a</kbd>|
-|Jump to the end of line|<kbd>ctrl</kbd> + <kbd>e</kbd>|
-|Jump backward one word|<kbd>meta</kbd> + <kbd>b</kbd>|
-|Jump forward one word|<kbd>meta</kbd> + <kbd>f</kbd>|
-|Delete previous character (to left)|<kbd>ctrl</kbd> + <kbd>h</kbd>|
-|Transpose characters|<kbd>ctrl</kbd> + <kbd>t</kbd>|
-|Cut forwards to the end of the line|<kbd>ctrl</kbd> + <kbd>k</kbd>|
-|Cut backwards to the start of the line|<kbd>ctrl</kbd> + <kbd>u</kbd>|
-|Cut forwards to the end of the current word|<kbd>meta</kbd> + <kbd>d</kbd>|
-|Cut backwards to the start of the current word|<kbd>ctrl</kbd> + <kbd>w</kbd>|
-|Paste last cut section|<kbd>ctrl</kbd> + <kbd>y</kbd>|
-|Undo last action|<kbd>ctrl</kbd> + <kbd>_</kbd>|
-|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>|
+|Cycle through recipient and content boxes|<kbd>Tab</kbd>|
+|Send a message|<kbd>Ctrl</kbd> + <kbd>D</kbd> / <kbd>Meta</kbd> + <kbd>Enter</kbd>|
+|Save current message as a draft|<kbd>Meta</kbd> + <kbd>S</kbd>|
+|Autocomplete @mentions, #stream_names, :emoji: and topics|<kbd>Ctrl</kbd> + <kbd>F</kbd>|
+|Cycle through autocomplete suggestions in reverse|<kbd>Ctrl</kbd> + <kbd>R</kbd>|
+|Narrow to compose box message recipient|<kbd>Meta</kbd> + <kbd>.</kbd>|
+|Jump to the beginning of line|<kbd>Ctrl</kbd> + <kbd>A</kbd>|
+|Jump to the end of line|<kbd>Ctrl</kbd> + <kbd>E</kbd>|
+|Jump backward one word|<kbd>Meta</kbd> + <kbd>B</kbd>|
+|Jump forward one word|<kbd>Meta</kbd> + <kbd>F</kbd>|
+|Delete previous character (to left)|<kbd>Ctrl</kbd> + <kbd>H</kbd>|
+|Transpose characters|<kbd>Ctrl</kbd> + <kbd>T</kbd>|
+|Cut forwards to the end of the line|<kbd>Ctrl</kbd> + <kbd>K</kbd>|
+|Cut backwards to the start of the line|<kbd>Ctrl</kbd> + <kbd>U</kbd>|
+|Cut forwards to the end of the current word|<kbd>Meta</kbd> + <kbd>D</kbd>|
+|Cut backwards to the start of the current word|<kbd>Ctrl</kbd> + <kbd>W</kbd>|
+|Paste last cut section|<kbd>Ctrl</kbd> + <kbd>Y</kbd>|
+|Undo last action|<kbd>Ctrl</kbd> + <kbd>_</kbd>|
+|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>|
 

tools/lint-hotkeys

@@ -6,7 +6,11 @@ from collections import defaultdict
 from pathlib import Path, PurePath
 from typing import Dict, List, Tuple
 
-from zulipterminal.config.keys import HELP_CATEGORIES, KEY_BINDINGS
+from zulipterminal.config.keys import (
+    HELP_CATEGORIES,
+    KEY_BINDINGS,
+    display_keys_for_command,
+)
 
 
 KEYS_FILE = (
@@ -104,7 +108,16 @@ def get_hotkeys_file_string() -> str:
         for help_text, key_combinations_list in categories[action]:
             various_key_combinations = " / ".join(
                 [
-                    " + ".join([f"<kbd>{key}</kbd>" for key in key_combination.split()])
+                    " + ".join(
+                        [
+                            f"<kbd>Shift</kbd> + <kbd>{key}</kbd>"
+                            if len(key) == 1 and key.isupper()
+                            else f"<kbd>{key.capitalize()}</kbd>"
+                            if len(key) == 1
+                            else f"<kbd>{key}</kbd>"
+                            for key in key_combination.split()
+                        ]
+                    )
                     for key_combination in key_combinations_list
                 ]
             )
@@ -129,8 +142,10 @@ def read_help_categories() -> Dict[str, List[Tuple[str, List[str]]]]:
     Get all help categories from KEYS_FILE
     """
     categories = defaultdict(list)
-    for item in KEY_BINDINGS.values():
-        categories[item["key_category"]].append((item["help_text"], item["keys"]))
+    for cmd, item in KEY_BINDINGS.items():
+        categories[item["key_category"]].append(
+            (item["help_text"], display_keys_for_command(cmd))
+        )
     return categories