riched 0.1.0__tar.gz

riched-0.1.0/.gitignore

@@ -0,0 +1,75 @@
+### JavaScript ###
+.DS_Store
+.env
+.env.*
+*.tsbuildinfo
+/build
+/coverage
+/dist
+/node_modules
+/out
+/tmp
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+.ruff_cache/
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# Environments
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+.env.local
+
+# mkdocs output
+site/
+
+# custom
+try*
+secrets.toml
+keys.log

riched-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

riched-0.1.0/AGENTS.md

@@ -0,0 +1,31 @@
+# Repository Guidelines
+
+## Project Structure & Module Organization
+
+This repository is a uv-managed Python project for `riched`, a Textual TUI editor. Application code lives in `src/riched/`: `cli.py` owns argument parsing, `app.py` owns the Textual app and file tree, `editor.py` customizes text editing, `screens.py` contains modal screens, `keybindings.py` loads shipped shortcut config and popup display rows, `bindings.yaml` defines shipped bindings, `settings.py` persists user settings such as theme, and `syntax.py` handles language detection/highlighting. End-to-end tests live in `tests/`. Root-level `foo.*` and `hello.txt` files are test fixtures/sample content. Avoid committing generated files such as `.venv/`, `__pycache__/`, `keys.log`, or build artifacts.
+
+## Build, Test, and Development Commands
+
+- `uv sync`: install project dependencies from `pyproject.toml` and `uv.lock`.
+- `uv run riched path/to/file.txt`: open or create a file in the editor.
+- `uv run python -m tests.runner`: run the Textual Pilot end-to-end suite.
+- `uv add <package>`: add runtime dependencies; do not use `pip`.
+
+## Coding Style & Naming Conventions
+
+Use Python 3.14-compatible code with type hints, `from __future__ import annotations`, `Path`, and small focused helpers. Use 4-space indentation. Keep constants in `UPPER_SNAKE_CASE`, classes in `PascalCase`, functions and methods in `snake_case`, and private helpers prefixed with `_`. Prefer Textual widgets and events over manual terminal control. Keep comments brief and only for non-obvious behavior.
+
+Keep key bindings in `src/riched/bindings.yaml`, not hardcoded in Python. The F1 hotkey popup is generated from this YAML and displays one user-facing key per binding, preferring `cmd` aliases over `super`.
+
+## Testing Guidelines
+
+Only add end-to-end tests in `tests/`; do not create unit tests. Tests use Textual's Pilot harness and should be named `test_<behavior>`. Keep each test focused on user-visible behavior such as file open/save, dirty prompts, file tree switching, or syntax highlighting. Use temporary files as existing tests do.
+
+## Commit & Pull Request Guidelines
+
+Use concise imperative commit messages, for example `Add file tree` or `Refactor editor package`. Pull requests should include a short summary, manual/e2e verification steps, related issue links if any, and terminal screenshots or recordings for visible TUI changes. When merging pull requests, use rebase and merge.
+
+## Agent-Specific Instructions
+
+Prefer `uv` for Python tasks. Keep changes scoped to requested behavior. Update `AGENTS.md` when commands, structure, or testing policy changes.
+Never change Ghostty settings or configuration, even when investigating Command-key behavior; only document suggested user-side settings when explicitly asked.

riched-0.1.0/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: riched
+Version: 0.1.0
+Summary: A Textual TUI editor
+Requires-Python: >=3.14
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: textual[syntax]>=8.2.4
+Requires-Dist: tree-sitter-typescript>=0.23.2
+Description-Content-Type: text/markdown
+
+# Riched
+
+`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.
+
+> [!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.
+
+## Key Features
+
+- Syntax highlighting
+- Resizable project file tree
+- VS Code-style text editing key bindings
+
+## Usage
+
+```sh
+uv sync
+uv run riched . 
+uv run python -m tests.runner
+```
+
+## Key Bindings
+
+Key bindings are generated from the YAML in `src/riched/bindings.yaml`.
+
+App shortcuts:
+
+| Shortcut | Action |
+| --- | --- |
+| `Ctrl+S` | Save |
+| `Ctrl+Q` | Quit |
+| `Ctrl+W` | Close buffer |
+| `F1` | Key bindings |
+| `Cmd+B` / `Super+B` | Toggle file tree |
+| `Cmd+P` / `Super+P` | Quick open |
+
+Editor shortcuts:
+
+| Shortcut | Action |
+| --- | --- |
+| `Alt+Up` | Move line up |
+| `Alt+Down` | Move line down |
+| `Alt+Shift+Up` / `Shift+Alt+Up` | Copy line up |
+| `Alt+Shift+Down` / `Shift+Alt+Down` | Copy line down |
+| `Alt+Backspace` | Delete word left |
+| `Alt+Shift+Left` / `Shift+Alt+Left` | Select word left |
+| `Alt+Shift+Right` / `Shift+Alt+Right` | Select word right |
+| `Super+L` / `Cmd+L` | Select line |
+| `Shift+Super+Left` / `Super+Shift+Left` / `Shift+Cmd+Left` / `Cmd+Shift+Left` | Select to line start |
+| `Shift+Super+Right` / `Super+Shift+Right` / `Shift+Cmd+Right` / `Cmd+Shift+Right` | Select to line end |
+
+## Settings
+
+`riched` persists the selected Textual theme in `settings.yaml` under the user
+config directory: `~/Library/Application Support/riched/settings.yaml`
+
+## Won't Implemented
+
+`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 environments.
+

riched-0.1.0/README.md

@@ -0,0 +1,62 @@
+# Riched
+
+`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.
+
+> [!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.
+
+## Key Features
+
+- Syntax highlighting
+- Resizable project file tree
+- VS Code-style text editing key bindings
+
+## Usage
+
+```sh
+uv sync
+uv run riched . 
+uv run python -m tests.runner
+```
+
+## Key Bindings
+
+Key bindings are generated from the YAML in `src/riched/bindings.yaml`.
+
+App shortcuts:
+
+| Shortcut | Action |
+| --- | --- |
+| `Ctrl+S` | Save |
+| `Ctrl+Q` | Quit |
+| `Ctrl+W` | Close buffer |
+| `F1` | Key bindings |
+| `Cmd+B` / `Super+B` | Toggle file tree |
+| `Cmd+P` / `Super+P` | Quick open |
+
+Editor shortcuts:
+
+| Shortcut | Action |
+| --- | --- |
+| `Alt+Up` | Move line up |
+| `Alt+Down` | Move line down |
+| `Alt+Shift+Up` / `Shift+Alt+Up` | Copy line up |
+| `Alt+Shift+Down` / `Shift+Alt+Down` | Copy line down |
+| `Alt+Backspace` | Delete word left |
+| `Alt+Shift+Left` / `Shift+Alt+Left` | Select word left |
+| `Alt+Shift+Right` / `Shift+Alt+Right` | Select word right |
+| `Super+L` / `Cmd+L` | Select line |
+| `Shift+Super+Left` / `Super+Shift+Left` / `Shift+Cmd+Left` / `Cmd+Shift+Left` | Select to line start |
+| `Shift+Super+Right` / `Super+Shift+Right` / `Shift+Cmd+Right` / `Cmd+Shift+Right` | Select to line end |
+
+## Settings
+
+`riched` persists the selected Textual theme in `settings.yaml` under the user
+config directory: `~/Library/Application Support/riched/settings.yaml`
+
+## Won't Implemented
+
+`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 environments.
+

riched-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "riched"
+version = "0.1.0"
+description = "A Textual TUI editor"
+readme = "README.md"
+requires-python = ">=3.14"
+dependencies = [
+    "pyyaml>=6.0.3",
+    "textual[syntax]>=8.2.4",
+    "tree-sitter-typescript>=0.23.2",
+]
+
+[project.scripts]
+riched = "riched.cli:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/riched"]

riched-0.1.0/src/riched/__init__.py

@@ -0,0 +1,2 @@
+"""Riched package."""
+

riched-0.1.0/src/riched/app.py

@@ -0,0 +1,433 @@
+from __future__ import annotations
+
+from collections.abc import Iterable
+from pathlib import Path
+from typing import Any
+
+from textual import events
+from textual.app import App, ComposeResult, SystemCommand
+from textual.binding import Binding
+from textual.command import CommandPalette
+from textual.containers import Container, Horizontal
+from textual.keys import format_key
+from textual.screen import Screen
+from textual.widgets import DirectoryTree, Footer, Header, Static, TextArea
+
+from .editor import RichedTextArea
+from .keybindings import display_key
+from .screens import KeysHelpScreen, QuickOpenScreen, UnsavedChangesScreen
+from .settings import load_theme, save_theme
+from .syntax import apply_language
+
+FILE_TREE_DEFAULT_WIDTH = 30
+FILE_TREE_MIN_WIDTH = 18
+FILE_TREE_MAX_WIDTH = 44
+QUICK_OPEN_SKIP_DIRS = {
+    ".git",
+    ".venv",
+    "__pycache__",
+    "build",
+    "dist",
+    "node_modules",
+}
+KEY_MODIFIER_SYMBOLS = {
+    "cmd": "⌘",
+    "super": "⌘",
+    "ctrl": "⌃",
+    "control": "⌃",
+    "alt": "⌥",
+    "option": "⌥",
+    "shift": "⇧",
+}
+
+
+class RichedDirectoryTree(DirectoryTree):
+    """Directory tree with editor-style keyboard affordances."""
+
+    BINDINGS = [
+        *(binding for binding in DirectoryTree.BINDINGS if binding.key != "space"),
+        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),
+    ]
+
+    def _cursor_dir_node(self) -> Any | None:
+        node = self.cursor_node
+        if node is None or node.data is None or not node.allow_expand:
+            return None
+        return node
+
+    def action_collapse_cursor(self) -> None:
+        node = self._cursor_dir_node()
+        if node is not None:
+            node.collapse()
+
+    def action_expand_cursor(self) -> None:
+        node = self._cursor_dir_node()
+        if node is not None:
+            node.expand()
+
+    def action_activate_cursor(self) -> None:
+        node = self.cursor_node
+        if node is None:
+            return
+        if node.allow_expand:
+            node.toggle()
+            return
+        self.action_select_cursor()
+
+
+class FileTreeResizeHandle(Static):
+    """Mouse handle for resizing the file tree."""
+
+    can_focus = False
+
+    def __init__(self) -> None:
+        super().__init__("", id="file-tree-resize-handle")
+        self._drag_start_x: int | None = None
+        self._drag_start_width: int | None = None
+
+    def on_mouse_down(self, event: events.MouseDown) -> None:
+        if event.button != 1 or event.screen_x is None:
+            return
+        tree = self.app.query_one("#file-tree", DirectoryTree)
+        self._drag_start_x = int(event.screen_x)
+        self._drag_start_width = tree.region.width
+        self.capture_mouse()
+        self.add_class("dragging")
+        event.stop()
+        event.prevent_default()
+
+    def on_mouse_move(self, event: events.MouseMove) -> None:
+        if self._drag_start_x is None or self._drag_start_width is None:
+            return
+        if event.screen_x is None:
+            return
+        delta = int(event.screen_x) - self._drag_start_x
+        app = self.app
+        if isinstance(app, RichedApp):
+            app.set_file_tree_width(self._drag_start_width + delta)
+        event.stop()
+        event.prevent_default()
+
+    def on_mouse_up(self, event: events.MouseUp) -> None:
+        if self._drag_start_x is None:
+            return
+        self._drag_start_x = None
+        self._drag_start_width = None
+        self.release_mouse()
+        self.remove_class("dragging")
+        event.stop()
+        event.prevent_default()
+
+
+class RichedApp(App):
+    """TUI text editor with a project file tree."""
+
+    CSS = """
+    #workspace {
+        height: 1fr;
+    }
+    #file-tree {
+        width: 30;
+        min-width: 18;
+        max-width: 44;
+    }
+    #file-tree-resize-handle {
+        width: 1;
+        min-width: 1;
+        max-width: 1;
+        height: 1fr;
+        background: $panel;
+    }
+    #file-tree-resize-handle:hover,
+    #file-tree-resize-handle.dragging {
+        background: $accent;
+    }
+    #editor {
+        height: 1fr;
+        width: 1fr;
+    }
+    #editor-slot {
+        height: 1fr;
+        width: 1fr;
+    }
+    HeaderIcon {
+        display: none;
+    }
+    """
+
+    BINDINGS: list[Binding] = []
+
+    def __init__(
+        self,
+        path: Path,
+        root: Path | None = None,
+    ) -> None:
+        super().__init__()
+        saved_theme = load_theme()
+        if saved_theme in self.available_themes:
+            self.theme = saved_theme
+        self.watch(self, "theme", self._save_theme, init=False)
+        initial_path = path.expanduser()
+        self._initial_path = None if initial_path.is_dir() else initial_path
+        self.path: Path | None = self._initial_path
+        self.root = root or Path.cwd()
+        self._saved_text = ""
+
+    def _save_theme(self, theme: str) -> None:
+        try:
+            save_theme(theme)
+        except Exception as exc:
+            self.notify(f"Could not save theme: {exc}", severity="warning")
+
+    def get_system_commands(self, screen: Screen) -> Iterable[SystemCommand]:
+        for command in super().get_system_commands(screen):
+            if command.title == "Maximize":
+                continue
+            if command.title == "Keys":
+                yield SystemCommand(
+                    "Keys",
+                    "Show key bindings",
+                    self.action_show_keys_popup,
+                )
+                continue
+            yield command
+
+    def get_key_display(self, binding: Binding) -> str:
+        if binding.key_display:
+            return binding.key_display
+
+        key = display_key(binding.key)
+        parts = key.split("+")
+        base_key = format_key(parts[-1])
+        if len(base_key) == 1:
+            base_key = base_key.upper()
+        else:
+            base_key = base_key.title()
+        modifiers = "".join(
+            KEY_MODIFIER_SYMBOLS.get(part, part) for part in parts[:-1]
+        )
+        return f"{modifiers}{base_key}"
+
+    def compose(self) -> ComposeResult:
+        yield Header()
+        with Horizontal(id="workspace"):
+            yield RichedDirectoryTree(str(self.root), id="file-tree")
+            yield FileTreeResizeHandle()
+            yield Container(id="editor-slot")
+        yield Footer()
+
+    def on_mount(self) -> None:
+        self.title = "riched"
+        self.set_file_tree_width(FILE_TREE_DEFAULT_WIDTH)
+        if self._initial_path is None:
+            self.sub_title = ""
+            self.query_one("#file-tree", DirectoryTree).focus()
+            return
+        self._open_path(self._initial_path)
+
+    def _editor_or_none(self) -> TextArea | None:
+        editors = list(self.query("#editor"))
+        return editors[0] if editors else None
+
+    def _file_tree(self) -> DirectoryTree:
+        return self.query_one("#file-tree", DirectoryTree)
+
+    def _file_tree_resize_handle(self) -> Static:
+        return self.query_one("#file-tree-resize-handle", Static)
+
+    def _is_file_tree_visible(self) -> bool:
+        return self._file_tree().styles.display != "none"
+
+    def _show_file_tree(self) -> None:
+        self._file_tree().styles.display = "block"
+        self._file_tree_resize_handle().styles.display = "block"
+
+    def _hide_file_tree(self) -> None:
+        self._file_tree().styles.display = "none"
+        self._file_tree_resize_handle().styles.display = "none"
+
+    def set_file_tree_width(self, width: int) -> None:
+        clamped_width = max(FILE_TREE_MIN_WIDTH, min(FILE_TREE_MAX_WIDTH, width))
+        tree = self._file_tree()
+        tree.styles.width = clamped_width
+        tree.refresh(layout=True)
+
+    def _get_or_create_editor(self) -> TextArea:
+        editor = self._editor_or_none()
+        if editor is not None:
+            return editor
+        editor = RichedTextArea.code_editor(id="editor", theme="css")
+        self.query_one("#editor-slot", Container).mount(editor)
+        return editor
+
+    def _close_buffer(self) -> None:
+        self.query_one("#editor-slot", Container).remove_children()
+        self.path = None
+        self.sub_title = ""
+        self._saved_text = ""
+        self._show_file_tree()
+        self._file_tree().focus()
+
+    def _open_path(self, path: Path) -> None:
+        self.path = path.expanduser()
+        self.sub_title = str(self.path)
+        editor = self._get_or_create_editor()
+        if self.path.exists():
+            try:
+                content = self.path.read_text()
+            except Exception as exc:
+                self.notify(f"Could not read: {exc}", severity="error")
+                content = ""
+        else:
+            content = ""
+        editor.load_text(content)
+        self._saved_text = content
+        try:
+            apply_language(editor, self.path.suffix)
+        except Exception as exc:
+            self.notify(f"Syntax highlight off: {exc}", severity="warning")
+        editor.focus()
+
+    def _is_dirty(self) -> bool:
+        editor = self._editor_or_none()
+        return self.path is not None and editor is not None and editor.text != self._saved_text
+
+    def on_directory_tree_file_selected(
+        self, event: DirectoryTree.FileSelected
+    ) -> None:
+        event.stop()
+        selected = Path(event.path)
+        if selected == self.path:
+            editor = self._editor_or_none()
+            if editor is not None:
+                editor.focus()
+            return
+        self._switch_path(selected)
+
+    def _switch_path(self, selected: Path) -> None:
+        if not self._is_dirty():
+            self._open_path(selected)
+            return
+
+        def handle(choice: str) -> None:
+            if choice == "save":
+                self.action_save()
+                if not self._is_dirty():
+                    self._open_path(selected)
+            elif choice == "discard":
+                self._open_path(selected)
+
+        self.push_screen(UnsavedChangesScreen(), handle)
+
+    def _quick_open_files(self) -> list[Path]:
+        root = self.root.expanduser()
+        files: list[Path] = []
+        stack = [root]
+        while stack:
+            directory = stack.pop()
+            try:
+                entries = sorted(directory.iterdir(), key=lambda path: path.name.lower())
+            except OSError:
+                continue
+            for entry in entries:
+                try:
+                    if entry.is_dir():
+                        if entry.name not in QUICK_OPEN_SKIP_DIRS and not entry.is_symlink():
+                            stack.append(entry)
+                    elif entry.is_file():
+                        files.append(entry)
+                except OSError:
+                    continue
+        return sorted(files, key=lambda path: path.relative_to(root).as_posix().lower())
+
+    def action_quick_open(self) -> None:
+        def handle(selected: Path | None) -> None:
+            if selected is not None:
+                self._switch_path(selected)
+
+        self.push_screen(
+            QuickOpenScreen(self.root.expanduser(), self._quick_open_files()),
+            handle,
+        )
+
+    def action_toggle_command_palette(self) -> None:
+        if CommandPalette.is_open(self):
+            self.pop_screen()
+            return
+        self.action_command_palette()
+
+    def action_show_keys_popup(self) -> None:
+        self.push_screen(KeysHelpScreen())
+
+    def action_save(self) -> None:
+        if self.path is None:
+            self.notify("No file open", severity="warning")
+            return
+        editor = self._editor_or_none()
+        if editor is None:
+            self.notify("No file open", severity="warning")
+            return
+        try:
+            self.path.write_text(editor.text)
+        except Exception as exc:
+            self.notify(f"Save failed: {exc}", severity="error")
+            return
+        self._saved_text = editor.text
+        self.notify(f"Saved {self.path}")
+
+    def action_quit_check(self) -> None:
+        if not self._is_dirty():
+            self.exit()
+            return
+
+        def handle(choice: str) -> None:
+            if choice == "save":
+                self.action_save()
+                if not self._is_dirty():
+                    self.exit()
+            elif choice == "discard":
+                self.exit()
+
+        self.push_screen(UnsavedChangesScreen(), handle)
+
+    def action_close_buffer(self) -> None:
+        if self.path is None:
+            return
+        if not self._is_dirty():
+            self._close_buffer()
+            return
+
+        def handle(choice: str) -> None:
+            if choice == "save":
+                self.action_save()
+                if not self._is_dirty():
+                    self._close_buffer()
+            elif choice == "discard":
+                self._close_buffer()
+
+        self.push_screen(UnsavedChangesScreen(), handle)
+
+    def action_toggle_file_tree(self) -> None:
+        editor = self._editor_or_none()
+        if self._is_file_tree_visible():
+            if editor is None:
+                return
+            self._hide_file_tree()
+            editor.focus()
+            return
+        self._show_file_tree()
+
+    def action_toggle_file_tree_focus(self) -> None:
+        tree = self._file_tree()
+        if not self._is_file_tree_visible():
+            self._show_file_tree()
+            tree.focus()
+            return
+        editor = self._editor_or_none()
+        if tree.has_focus:
+            if editor is not None:
+                editor.focus()
+            return
+        tree.focus()