riched 0.2.1__tar.gz → 0.3.0__tar.gz

{riched-0.2.1 → riched-0.3.0}/AGENTS.md

@@ -9,7 +9,7 @@ This repository is a uv-managed Python project for `riched`, a Textual TUI edito
 - `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 build`: build the source distribution and wheel in `dist/`.
+- `rm -rf dist && uv build`: clear stale artifacts, then build the source distribution and wheel in `dist/`.
 - `set -a; source .env; set +a; uv publish --token "$PYPI_API"`: publish built distributions for a release using the PyPI API key from `.env`.
 - `uv add <package>`: add runtime dependencies; do not use `pip`.
 

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

@@ -1,7 +1,8 @@
 Metadata-Version: 2.4
 Name: riched
-Version: 0.2.1
+Version: 0.3.0
 Summary: TUI editor with VSCode keybindigs
+Project-URL: Repository, https://github.com/hoishing/riched
 Requires-Python: >=3.12
 Requires-Dist: pyyaml>=6.0.3
 Requires-Dist: textual[syntax]>=8.2.4
@@ -10,7 +11,7 @@ Description-Content-Type: text/markdown
 
 # Riched
 
-> TUI editor tailored for VSCode keybindigs in Ghostty terminal
+> 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.
 
@@ -32,6 +33,7 @@ Description-Content-Type: text/markdown
 ```sh
 uv tool install riched
 riched .
+riched --version
 ```
 
 ## Dev
@@ -53,7 +55,7 @@ App shortcuts:
 
 | Shortcut | Action |
 | --- | --- |
-| `⌃S` | Save |
+| `⌘S` | Save |
 | `⌃Q` | Quit |
 | `⌃W` | Close buffer |
 | `F1` | Key bindings |
@@ -89,6 +91,13 @@ config directory: `~/Library/Application Support/riched/settings.yaml`
 - File search prefers git-indexed files when available, follows symlinked files and directories, skips cache/build dependency folders, and caps indexing at 10,000 files.
 - Fuzzy ranking now prioritizes exact path and filename matches such as `.zshrc`.
 
-## Won't Implemented
+## Limitations
 
-`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` 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`.
+- `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.2.1 → riched-0.3.0}/README.md

@@ -1,6 +1,6 @@
 # Riched
 
-> TUI editor tailored for VSCode keybindigs in Ghostty terminal
+> 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.
 
@@ -22,6 +22,7 @@
 ```sh
 uv tool install riched
 riched .
+riched --version
 ```
 
 ## Dev
@@ -43,7 +44,7 @@ App shortcuts:
 
 | Shortcut | Action |
 | --- | --- |
-| `⌃S` | Save |
+| `⌘S` | Save |
 | `⌃Q` | Quit |
 | `⌃W` | Close buffer |
 | `F1` | Key bindings |
@@ -79,6 +80,13 @@ config directory: `~/Library/Application Support/riched/settings.yaml`
 - File search prefers git-indexed files when available, follows symlinked files and directories, skips cache/build dependency folders, and caps indexing at 10,000 files.
 - Fuzzy ranking now prioritizes exact path and filename matches such as `.zshrc`.
 
-## Won't Implemented
+## Limitations
 
-`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` 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`.
+- `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.2.1 → riched-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "riched"
-version = "0.2.1"
+version = "0.3.0"
 description = "TUI editor with VSCode keybindigs"
 readme = "README.md"
 requires-python = ">=3.12"
@@ -10,6 +10,9 @@ dependencies = [
     "tree-sitter-typescript>=0.23.2",
 ]
 
+[project.urls]
+Repository = "https://github.com/hoishing/riched"
+
 [project.scripts]
 riched = "riched.cli:main"
 

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

@@ -2,7 +2,7 @@ app:
   commands:
     - name: save
       description: Save
-      key: ctrl+s
+      key: cmd+s,super+s
     - name: quit_check
       description: Quit
       key: ctrl+q

riched-0.3.0/src/riched/cli.py

@@ -0,0 +1,39 @@
+from __future__ import annotations
+
+import argparse
+from importlib.metadata import version
+from pathlib import Path
+
+from .app import RichedApp
+from .keybindings import build_bindings
+
+
+def main() -> int:
+    parser = argparse.ArgumentParser(
+        prog="riched", description="A minimal Textual TUI text editor."
+    )
+    parser.add_argument(
+        "--version",
+        action="store_true",
+        help="Show the version and exit",
+    )
+    parser.add_argument("filename", nargs="?", help="File to open (created on save if missing)")
+    args = parser.parse_args()
+
+    if args.version:
+        if args.filename is not None:
+            parser.error("riched --version does not take arguments")
+        print(f"riched {version('riched')}")
+        return 0
+
+    if args.filename is None:
+        parser.error("the following arguments are required: filename")
+
+    path = Path(args.filename).expanduser()
+    root = path if path.is_dir() else Path.cwd()
+
+    class ConfiguredRichedApp(RichedApp):
+        BINDINGS = build_bindings()
+
+    ConfiguredRichedApp(path, root).run()
+    return 0

{riched-0.2.1 → riched-0.3.0}/tests/runner.py

@@ -8,6 +8,7 @@ from .test_command_palette import (
     test_command_palette_button_is_hidden,
     test_command_palette_omits_maximize,
 )
+from .test_cli import test_version_flag_prints_current_version, test_version_flag_rejects_filename
 from .test_dirty_buffers import (
     test_close_buffer_clean_enters_no_buffer_state_via_ctrl_w,
     test_close_buffer_dirty_shows_wide_modal_then_cancel,
@@ -72,6 +73,8 @@ TESTS: list[tuple[str, Callable[[], Awaitable[None]]]] = [
     ("open missing file", test_open_missing_file),
     ("open directory starts with no buffer", test_open_directory_starts_with_no_buffer),
     ("save writes file", test_save_writes_file),
+    ("cli: version flag prints current version", test_version_flag_prints_current_version),
+    ("cli: version flag rejects filename", test_version_flag_rejects_filename),
     ("command palette: button hidden", test_command_palette_button_is_hidden),
     ("command palette: omit maximize", test_command_palette_omits_maximize),
     ("quit clean exits", test_quit_clean_exits),

riched-0.3.0/tests/test_cli.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+from importlib.metadata import version
+
+
+async def test_version_flag_prints_current_version() -> None:
+    result = subprocess.run(
+        [
+            sys.executable,
+            "-c",
+            "from riched.cli import main; raise SystemExit(main())",
+            "--version",
+        ],
+        check=False,
+        capture_output=True,
+        text=True,
+    )
+    assert result.returncode == 0, result.stderr
+    assert result.stdout == f"riched {version('riched')}\n", result.stdout
+    assert result.stderr == "", result.stderr
+
+
+async def test_version_flag_rejects_filename() -> None:
+    result = subprocess.run(
+        [
+            sys.executable,
+            "-c",
+            "from riched.cli import main; raise SystemExit(main())",
+            "--version",
+            "notes.txt",
+        ],
+        check=False,
+        capture_output=True,
+        text=True,
+    )
+    assert result.returncode == 2, result.stdout
+    assert result.stdout == "", result.stdout
+    assert "riched --version does not take arguments" in result.stderr, result.stderr

{riched-0.2.1 → riched-0.3.0}/tests/test_file_io.py

@@ -58,7 +58,6 @@ async def test_save_writes_file() -> None:
         await pilot.pause()
         app.query_one("#editor", TextArea).load_text("typed content")
         await pilot.pause()
-        await pilot.press("ctrl+s")
+        await pilot.press("cmd+s")
         await pilot.pause()
     assert f.read_text() == "typed content"
-

{riched-0.2.1 → riched-0.3.0}/tests/test_footer.py

@@ -18,7 +18,7 @@ async def test_footer_uses_macos_modifier_symbols() -> None:
             for child in footer.children
             if hasattr(child, "key_display")
         }
-        assert labels["Save"] == "⌃S"
+        assert labels["Save"] == "⌘S"
         assert labels["Close buffer"] == "⌃W"
         assert labels["Toggle file tree"] == "⌘B"
         assert labels["Quick open"] == "⌘P"

{riched-0.2.1 → riched-0.3.0}/uv.lock

@@ -131,7 +131,7 @@ wheels = [
 
 [[package]]
 name = "riched"
-version = "0.2.1"
+version = "0.3.0"
 source = { editable = "." }
 dependencies = [
     { name = "pyyaml" },

riched-0.2.1/src/riched/cli.py

@@ -1,24 +0,0 @@
-from __future__ import annotations
-
-import argparse
-from pathlib import Path
-
-from .app import RichedApp
-from .keybindings import build_bindings
-
-
-def main() -> int:
-    parser = argparse.ArgumentParser(
-        prog="riched", description="A minimal Textual TUI text editor."
-    )
-    parser.add_argument("filename", help="File to open (created on save if missing)")
-    args = parser.parse_args()
-
-    path = Path(args.filename).expanduser()
-    root = path if path.is_dir() else Path.cwd()
-
-    class ConfiguredRichedApp(RichedApp):
-        BINDINGS = build_bindings()
-
-    ConfiguredRichedApp(path, root).run()
-    return 0