riched 0.3.0__tar.gz → 0.4.0__tar.gz

{riched-0.3.0 → riched-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: riched
-Version: 0.3.0
+Version: 0.4.0
 Summary: TUI editor with VSCode keybindigs
 Project-URL: Repository, https://github.com/hoishing/riched
 Requires-Python: >=3.12
@@ -11,22 +11,18 @@ Description-Content-Type: text/markdown
 
 # Riched
 
-> TUI editor with VSCode keybindigs
-
-`riched` is a TUI editor powered by the [Rich](https://github.com/Textualize/rich) package and the [Textual](https://github.com/Textualize/textual) framework, the name is a nod to Rich.
+[Rich](https://github.com/Textualize/rich) powered editor, so the name `riched`, that implement vscode keybinding in TUI with best effort.
 
 > [!NOTE]
-> `riched` targets Ghostty on macOS. Some key bindings, especially shortcuts
-> that use the Command key, may not work in other terminals or on other
-> operating systems.
+> `riched` is designed to work with [ghostty](https://ghostty.org) in macOS only
 
 ## Key Features
 
-- VS Code-style text editing key bindings
-- Syntax highlighting
-- Resizable project file tree
-- Quick open with git-aware indexing, bounded large-folder scanning
-- fuzzy matching, symlink traversal
+- vscode text editing key bindings
+- macOS style key bindings work in ssh session to linux host also
+- multiple built-in theme(atom, drcula, nordic ...etc)
+- syntax highlighting for major file formats
+- quick file open with fuzzy search
 
 ## Usage
 
@@ -42,14 +38,11 @@ riched --version
 uv sync
 uv run riched .
 uv run python -m tests.runner
-uv build
-uv publish
 ```
 
 ## Key Bindings
 
 Key bindings are generated from the YAML in `src/riched/bindings.yaml`.
-Symbols: `⌘` = Command, `⌃` = Control, `⌥` = Option, `⇧` = Shift.
 
 App shortcuts:
 
@@ -57,8 +50,7 @@ App shortcuts:
 | --- | --- |
 | `⌘S` | Save |
 | `⌃Q` | Quit |
-| `⌃W` | Close buffer |
-| `F1` | Key bindings |
+| `F1` | Command palette |
 | `⌘B` | Toggle file tree |
 | `⌘P` | Quick open |
 
@@ -71,6 +63,12 @@ Editor shortcuts:
 | `⌥⇧↑` | Copy line up |
 | `⌥⇧↓` | Copy line down |
 | `⌥⌫` | Delete word left |
+| `⌘⌫` | Delete to line start |
+| `⌘Z` | Undo |
+| `⌘⇧Z` | Redo |
+| `⌘X` | Cut |
+| `⌘/` | Toggle line comment |
+| `⌥Z` | Toggle word wrap |
 | `⌥⇧←` | Select word left |
 | `⌥⇧→` | Select word right |
 | `⌘L` | Select line |
@@ -96,7 +94,8 @@ config directory: `~/Library/Application Support/riched/settings.yaml`
 - `riched` does not support multi-cursor editing because Textual `TextArea`
   currently models one active cursor/selection.
 - Some Command-key shortcuts can conflict with Ghostty or terminal-level
-  bindings, for example `⌘⇧P`, `⌘W`, and `⌘Q`.
+  bindings, for example `⌘C`, `⌘Enter`, `⌘⇧Enter`, `⌘[`, `⌘]`, `⌘⌫`,
+  `⌘Z`, `⌘⇧Z`, `⌘⇧P`, `⌘W`, and `⌘Q`.
 - `riched` will not implement key bindings that require users to modify the
   Ghostty terminal configuration, since terminal-specific configuration makes
   shortcuts harder to document, test, and support consistently across

{riched-0.3.0 → riched-0.4.0}/README.md

@@ -1,21 +1,17 @@
 # Riched
 
-> TUI editor with VSCode keybindigs
-
-`riched` is a TUI editor powered by the [Rich](https://github.com/Textualize/rich) package and the [Textual](https://github.com/Textualize/textual) framework, the name is a nod to Rich.
+[Rich](https://github.com/Textualize/rich) powered editor, so the name `riched`, that implement vscode keybinding in TUI with best effort.
 
 > [!NOTE]
-> `riched` targets Ghostty on macOS. Some key bindings, especially shortcuts
-> that use the Command key, may not work in other terminals or on other
-> operating systems.
+> `riched` is designed to work with [ghostty](https://ghostty.org) in macOS only
 
 ## Key Features
 
-- VS Code-style text editing key bindings
-- Syntax highlighting
-- Resizable project file tree
-- Quick open with git-aware indexing, bounded large-folder scanning
-- fuzzy matching, symlink traversal
+- vscode text editing key bindings
+- macOS style key bindings work in ssh session to linux host also
+- multiple built-in theme(atom, drcula, nordic ...etc)
+- syntax highlighting for major file formats
+- quick file open with fuzzy search
 
 ## Usage
 
@@ -31,14 +27,11 @@ riched --version
 uv sync
 uv run riched .
 uv run python -m tests.runner
-uv build
-uv publish
 ```
 
 ## Key Bindings
 
 Key bindings are generated from the YAML in `src/riched/bindings.yaml`.
-Symbols: `⌘` = Command, `⌃` = Control, `⌥` = Option, `⇧` = Shift.
 
 App shortcuts:
 
@@ -46,8 +39,7 @@ App shortcuts:
 | --- | --- |
 | `⌘S` | Save |
 | `⌃Q` | Quit |
-| `⌃W` | Close buffer |
-| `F1` | Key bindings |
+| `F1` | Command palette |
 | `⌘B` | Toggle file tree |
 | `⌘P` | Quick open |
 
@@ -60,6 +52,12 @@ Editor shortcuts:
 | `⌥⇧↑` | Copy line up |
 | `⌥⇧↓` | Copy line down |
 | `⌥⌫` | Delete word left |
+| `⌘⌫` | Delete to line start |
+| `⌘Z` | Undo |
+| `⌘⇧Z` | Redo |
+| `⌘X` | Cut |
+| `⌘/` | Toggle line comment |
+| `⌥Z` | Toggle word wrap |
 | `⌥⇧←` | Select word left |
 | `⌥⇧→` | Select word right |
 | `⌘L` | Select line |
@@ -85,7 +83,8 @@ config directory: `~/Library/Application Support/riched/settings.yaml`
 - `riched` does not support multi-cursor editing because Textual `TextArea`
   currently models one active cursor/selection.
 - Some Command-key shortcuts can conflict with Ghostty or terminal-level
-  bindings, for example `⌘⇧P`, `⌘W`, and `⌘Q`.
+  bindings, for example `⌘C`, `⌘Enter`, `⌘⇧Enter`, `⌘[`, `⌘]`, `⌘⌫`,
+  `⌘Z`, `⌘⇧Z`, `⌘⇧P`, `⌘W`, and `⌘Q`.
 - `riched` will not implement key bindings that require users to modify the
   Ghostty terminal configuration, since terminal-specific configuration makes
   shortcuts harder to document, test, and support consistently across

{riched-0.3.0 → riched-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "riched"
-version = "0.3.0"
+version = "0.4.0"
 description = "TUI editor with VSCode keybindigs"
 readme = "README.md"
 requires-python = ">=3.12"

{riched-0.3.0 → riched-0.4.0}/src/riched/app.py

@@ -23,7 +23,12 @@ from .quick_open import (
     git_quick_open_entries,
     scan_quick_open_entries,
 )
-from .screens import KeysHelpScreen, QuickOpenScreen, UnsavedChangesScreen
+from .screens import (
+    KeysHelpScreen,
+    QuickOpenScreen,
+    QuitConfirmationScreen,
+    UnsavedChangesScreen,
+)
 from .settings import load_theme, save_theme
 from .syntax import apply_language
 
@@ -49,6 +54,7 @@ class RichedDirectoryTree(DirectoryTree):
         Binding("left", "collapse_cursor", "Collapse folder", show=False),
         Binding("right", "expand_cursor", "Expand folder", show=False),
         Binding("space", "activate_cursor", "Open file or toggle folder", show=False),
+        Binding("escape", "quit_check", "Quit", show=False),
     ]
 
     def _cursor_dir_node(self) -> Any | None:
@@ -76,6 +82,11 @@ class RichedDirectoryTree(DirectoryTree):
             return
         self.action_select_cursor()
 
+    def action_quit_check(self) -> None:
+        app = self.app
+        if isinstance(app, RichedApp):
+            app.action_file_tree_quit_check()
+
 
 class FileTreeResizeHandle(Static):
     """Mouse handle for resizing the file tree."""
@@ -124,6 +135,8 @@ class FileTreeResizeHandle(Static):
 class RichedApp(App):
     """TUI text editor with a project file tree."""
 
+    COMMAND_PALETTE_BINDING = "f1"
+
     CSS = """
     #workspace {
         height: 1fr;
@@ -192,13 +205,13 @@ class RichedApp(App):
             if command.title == "Maximize":
                 continue
             if command.title == "Keys":
-                yield SystemCommand(
-                    "Keys",
-                    "Show key bindings",
-                    self.action_show_keys_popup,
-                )
                 continue
             yield command
+        yield SystemCommand(
+            "Show key bindings",
+            "Open the key bindings reference",
+            self.action_show_keys_popup,
+        )
 
     def get_key_display(self, binding: Binding) -> str:
         if binding.key_display:
@@ -501,6 +514,17 @@ class RichedApp(App):
 
         self.push_screen(UnsavedChangesScreen(), handle)
 
+    def action_file_tree_quit_check(self) -> None:
+        if self._is_dirty():
+            self.action_quit_check()
+            return
+
+        def handle(choice: str) -> None:
+            if choice == "quit":
+                self.exit()
+
+        self.push_screen(QuitConfirmationScreen(), handle)
+
     def action_close_buffer(self) -> None:
         if self.path is None:
             return

{riched-0.3.0 → riched-0.4.0}/src/riched/bindings.yaml

@@ -6,11 +6,8 @@ app:
     - name: quit_check
       description: Quit
       key: ctrl+q
-    - name: close_buffer
-      description: Close buffer
-      key: ctrl+w
-    - name: show_keys_popup
-      description: Key bindings
+    - name: command_palette
+      description: Command palette
       key: f1
     - name: toggle_file_tree
       description: Toggle file tree
@@ -40,6 +37,30 @@ editor:
     action: delete_word_left
     description: Delete word left
     show: false
+  - key: cmd+backspace,super+backspace,ctrl+u
+    action: delete_to_start_of_line_or_delete_left
+    description: Delete to line start
+    show: false
+  - key: cmd+z,super+z
+    action: undo
+    description: Undo
+    show: false
+  - key: cmd+shift+z,shift+cmd+z,super+shift+z,shift+super+z
+    action: redo
+    description: Redo
+    show: false
+  - key: cmd+x,super+x
+    action: cut
+    description: Cut
+    show: false
+  - key: cmd+/,super+/
+    action: toggle_line_comment
+    description: Toggle line comment
+    show: false
+  - key: alt+z
+    action: toggle_word_wrap
+    description: Toggle word wrap
+    show: false
   - key: alt+shift+left,shift+alt+left
     action: cursor_word_left(True)
     description: Select word left
@@ -70,6 +91,10 @@ editor:
     show: false
 
 screens:
+  quit_confirmation:
+    - key: escape
+      action: cancel
+      description: Cancel
   unsaved_changes:
     - key: escape
       action: cancel

riched-0.4.0/src/riched/editor.py

@@ -0,0 +1,254 @@
+from __future__ import annotations
+
+from textual.widgets import TextArea
+
+from .keybindings import build_static_bindings
+
+LINE_COMMENT_MARKERS = {
+    "bash": "#",
+    "go": "//",
+    "java": "//",
+    "javascript": "//",
+    "python": "#",
+    "rust": "//",
+    "toml": "#",
+    "tsx": "//",
+    "typescript": "//",
+    "yaml": "#",
+}
+BLOCK_COMMENT_MARKERS = {
+    "css": ("/*", "*/"),
+    "html": ("<!--", "-->"),
+    "markdown": ("<!--", "-->"),
+    "xml": ("<!--", "-->"),
+}
+
+
+class RichedTextArea(TextArea):
+    """TextArea with VS Code-style line-edit shortcuts."""
+
+    BINDINGS = build_static_bindings("editor")
+
+    def _clamp_location(self, location: tuple[int, int]) -> tuple[int, int]:
+        row, column = location
+        row = max(0, min(row, self.document.line_count - 1))
+        column = max(0, min(column, len(self.document.get_line(row))))
+        return row, column
+
+    def _clamp_selection(self) -> None:
+        start, end = self.selection
+        clamped_start = self._clamp_location(start)
+        clamped_end = self._clamp_location(end)
+        if (clamped_start, clamped_end) != (start, end):
+            self.selection = type(self.selection)(clamped_start, clamped_end)
+
+    def _refresh_size(self) -> None:
+        self._clamp_selection()
+        super()._refresh_size()
+
+    def _line_selection_end(self, row: int) -> tuple[int, int]:
+        if row + 1 < self.document.line_count:
+            return (row + 1, 0)
+        return (row, len(self.document.get_line(row)))
+
+    def _has_whole_line_selection(self) -> bool:
+        start, end = self.selection
+        if start > end:
+            return False
+        if start[1] != 0:
+            return False
+        if end[1] == 0 and end[0] > start[0]:
+            return True
+        last_row = self.document.line_count - 1
+        return end[0] == last_row and end[1] == len(self.document.get_line(last_row))
+
+    def action_select_line(self) -> None:
+        start, end = self.selection
+        if self._has_whole_line_selection():
+            selection_start = start
+            row = min(end[0], self.document.line_count - 1)
+        else:
+            row, _column = self.cursor_location
+            selection_start = (row, 0)
+
+        selection_end = self._line_selection_end(row)
+        self.selection = type(self.selection)(selection_start, selection_end)
+
+    def action_move_line_down(self) -> None:
+        row, col = self.cursor_location
+        if row + 1 >= self.document.line_count:
+            return
+        line_a = self.document.get_line(row)
+        line_b = self.document.get_line(row + 1)
+        self.replace(
+            line_b + "\n" + line_a,
+            (row, 0),
+            (row + 1, len(line_b)),
+            maintain_selection_offset=False,
+        )
+        self.move_cursor((row + 1, col))
+
+    def action_move_line_up(self) -> None:
+        row, col = self.cursor_location
+        if row == 0:
+            return
+        line_a = self.document.get_line(row - 1)
+        line_b = self.document.get_line(row)
+        self.replace(
+            line_b + "\n" + line_a,
+            (row - 1, 0),
+            (row, len(line_b)),
+            maintain_selection_offset=False,
+        )
+        self.move_cursor((row - 1, col))
+
+    def action_copy_line_down(self) -> None:
+        row, col = self.cursor_location
+        line = self.document.get_line(row)
+        self.insert("\n" + line, (row, len(line)), maintain_selection_offset=False)
+        self.move_cursor((row + 1, col))
+
+    def action_copy_line_up(self) -> None:
+        row, col = self.cursor_location
+        line = self.document.get_line(row)
+        self.insert(line + "\n", (row, 0), maintain_selection_offset=False)
+        self.move_cursor((row, col))
+
+    def action_delete_to_start_of_line_or_delete_left(self) -> None:
+        if not self.selection.is_empty or self.cursor_location[1] == 0:
+            self.action_delete_left()
+            return
+        self.action_delete_to_start_of_line()
+
+    def action_toggle_word_wrap(self) -> None:
+        self.soft_wrap = not self.soft_wrap
+
+    def action_toggle_line_comment(self) -> None:
+        language = self.language
+        if language in LINE_COMMENT_MARKERS:
+            self._toggle_line_comment(LINE_COMMENT_MARKERS[language])
+            return
+        if language in BLOCK_COMMENT_MARKERS:
+            self._toggle_block_comment(*BLOCK_COMMENT_MARKERS[language])
+            return
+        self.app.notify(
+            "Line comments are not supported for this file type.",
+            severity="warning",
+        )
+
+    def _selected_row_range(self) -> tuple[int, int]:
+        if self.selection.is_empty:
+            row, _column = self.cursor_location
+            return row, row
+
+        start, end = sorted(self.selection)
+        start_row = start[0]
+        end_row = end[0]
+        if end[1] == 0 and end_row > start_row:
+            end_row -= 1
+        return start_row, end_row
+
+    def _target_lines(self) -> tuple[int, int, list[str]]:
+        start_row, end_row = self._selected_row_range()
+        lines = [
+            self.document.get_line(row)
+            for row in range(start_row, end_row + 1)
+        ]
+        return start_row, end_row, lines
+
+    def _replace_target_lines(
+        self,
+        start_row: int,
+        end_row: int,
+        lines: list[str],
+    ) -> None:
+        text = "\n".join(lines)
+        self.replace(
+            text,
+            (start_row, 0),
+            (end_row, len(self.document.get_line(end_row))),
+            maintain_selection_offset=False,
+        )
+        self.move_cursor((start_row, 0))
+
+    def _toggle_line_comment(self, marker: str) -> None:
+        start_row, end_row, lines = self._target_lines()
+        non_blank = [line for line in lines if line.strip()]
+        if not non_blank:
+            return
+
+        should_uncomment = all(
+            line.lstrip().startswith(marker)
+            for line in non_blank
+        )
+        updated = [
+            _uncomment_line(line, marker)
+            if should_uncomment
+            else _comment_line(line, marker)
+            for line in lines
+        ]
+        self._replace_target_lines(start_row, end_row, updated)
+
+    def _toggle_block_comment(self, open_marker: str, close_marker: str) -> None:
+        start_row, end_row, lines = self._target_lines()
+        non_blank = [line for line in lines if line.strip()]
+        if not non_blank:
+            return
+
+        should_uncomment = all(
+            line.lstrip().startswith(open_marker)
+            and line.rstrip().endswith(close_marker)
+            for line in non_blank
+        )
+        updated = [
+            _uncomment_block_line(line, open_marker, close_marker)
+            if should_uncomment
+            else _comment_block_line(line, open_marker, close_marker)
+            for line in lines
+        ]
+        self._replace_target_lines(start_row, end_row, updated)
+
+    def action_ignore(self) -> None:
+        pass
+
+
+def _leading_spaces(line: str) -> str:
+    return line[: len(line) - len(line.lstrip())]
+
+
+def _comment_line(line: str, marker: str) -> str:
+    if not line.strip():
+        return line
+    indent = _leading_spaces(line)
+    return f"{indent}{marker} {line[len(indent):]}"
+
+
+def _uncomment_line(line: str, marker: str) -> str:
+    if not line.strip():
+        return line
+    indent = _leading_spaces(line)
+    rest = line[len(indent):]
+    if not rest.startswith(marker):
+        return line
+    rest = rest[len(marker):]
+    if rest.startswith(" "):
+        rest = rest[1:]
+    return f"{indent}{rest}"
+
+
+def _comment_block_line(line: str, open_marker: str, close_marker: str) -> str:
+    if not line.strip():
+        return line
+    indent = _leading_spaces(line)
+    return f"{indent}{open_marker} {line[len(indent):]} {close_marker}"
+
+
+def _uncomment_block_line(line: str, open_marker: str, close_marker: str) -> str:
+    if not line.strip():
+        return line
+    indent = _leading_spaces(line)
+    rest = line[len(indent):].strip()
+    if not rest.startswith(open_marker) or not rest.endswith(close_marker):
+        return line
+    rest = rest[len(open_marker): -len(close_marker)].strip()
+    return f"{indent}{rest}"

{riched-0.3.0 → riched-0.4.0}/src/riched/quick_open.py

@@ -48,7 +48,6 @@ def git_quick_open_entries(
                 "ls-files",
                 "--cached",
                 "--others",
-                "--exclude-standard",
             ],
             stdout=subprocess.PIPE,
             stderr=subprocess.DEVNULL,

{riched-0.3.0 → riched-0.4.0}/src/riched/screens.py

@@ -68,6 +68,57 @@ class UnsavedChangesScreen(ModalScreen[str]):
         self.dismiss("cancel")
 
 
+class QuitConfirmationScreen(ModalScreen[str]):
+    """Prompt asking whether to quit a clean session."""
+
+    BINDINGS = build_screen_bindings("quit_confirmation")
+
+    CSS = """
+    QuitConfirmationScreen {
+        align: center middle;
+    }
+    QuitConfirmationScreen > #dialog {
+        width: 44;
+        height: auto;
+        padding: 1 2;
+        background: $panel;
+        border: tall $accent;
+    }
+    QuitConfirmationScreen Label {
+        width: 100%;
+        content-align: center middle;
+        padding-bottom: 1;
+    }
+    QuitConfirmationScreen #buttons {
+        height: auto;
+        align: center middle;
+    }
+    QuitConfirmationScreen Button {
+        margin: 0 1;
+    }
+    """
+
+    def compose(self) -> ComposeResult:
+        with Vertical(id="dialog"):
+            yield Label("Quit riched?")
+            with Horizontal(id="buttons"):
+                yield Button("Quit", variant="error", id="quit")
+                yield Button("Cancel", id="cancel")
+
+    def on_button_pressed(self, event: Button.Pressed) -> None:
+        self.dismiss(event.button.id or "cancel")
+
+    def on_key(self, event: events.Key) -> None:
+        focused = self.focused
+        if event.key == "space" and isinstance(focused, Button):
+            event.stop()
+            event.prevent_default()
+            focused.action_press()
+
+    def action_cancel(self) -> None:
+        self.dismiss("cancel")
+
+
 class QuickOpenScreen(ModalScreen[Path | None]):
     """Fuzzy file picker."""
 

{riched-0.3.0 → riched-0.4.0}/tests/helpers.py

@@ -16,6 +16,7 @@ from riched.keybindings import (  # noqa: E402
     build_bindings,
 )
 from riched.screens import (  # noqa: E402
+    QuitConfirmationScreen,
     UnsavedChangesScreen,
 )
 
@@ -23,6 +24,7 @@ mod = SimpleNamespace(
     COMMANDS=COMMANDS,
     DEFAULT_BINDINGS=DEFAULT_BINDINGS,
     RichedApp=RichedApp,
+    QuitConfirmationScreen=QuitConfirmationScreen,
     UnsavedChangesScreen=UnsavedChangesScreen,
     build_bindings=build_bindings,
 )