side-vim 0.1.0__tar.gz

side_vim-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 sprytnyk.dev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

side_vim-0.1.0/PKG-INFO

@@ -0,0 +1,212 @@
+Metadata-Version: 2.4
+Name: side-vim
+Version: 0.1.0
+Summary: Vim mode for PySide6's QPlainTextEdit
+Author: sprytnyk.dev
+License-Expression: MIT
+License-File: LICENSE
+Requires-Dist: pyside6-essentials>=6.8
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/sprytnyk/side-vim
+Description-Content-Type: text/markdown
+
+# side-vim
+
+A Vim mode for PySide6's `QPlainTextEdit`. Attach it to an existing editor to add
+Normal, Insert, Visual and Visual Line modes.
+
+![The demo in Visual mode, with text selected and the mode in the status bar](https://raw.githubusercontent.com/sprytnyk/side-vim/main/docs/demo.png)
+
+## Install
+
+Requires Python 3.12 or newer and PySide6 6.8 or newer. Installing side-vim also
+installs PySide6-Essentials.
+
+```sh
+uv add side-vim
+```
+
+## Usage
+
+```python
+import sys
+
+from PySide6.QtWidgets import QApplication, QLabel, QPlainTextEdit, QVBoxLayout, QWidget
+
+from side_vim import VimMode
+
+app = QApplication(sys.argv)
+window = QWidget()
+editor = QPlainTextEdit("Try w, i, Esc, v and y.")
+status = QLabel()
+layout = QVBoxLayout(window)
+layout.addWidget(editor)
+layout.addWidget(status)
+
+vim = VimMode(editor)  # Starts in Normal mode. Qt deletes it with the editor.
+status.setText(vim.mode.value)
+vim.mode_changed.connect(lambda mode: status.setText(mode.value))
+
+window.resize(800, 500)
+window.show()
+editor.setFocus()
+sys.exit(app.exec())
+```
+
+Attach one `VimMode` per editor. Import `Mode` to compare `vim.mode` with
+`Mode.NORMAL`, `Mode.INSERT`, `Mode.VISUAL` or `Mode.VISUAL_LINE`.
+
+| API | Behavior |
+| --- | --- |
+| `vim.mode_changed.connect(callback)` | Calls `callback(mode)` when the mode changes. |
+| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. |
+| `vim.escape_hook = callback` | Calls `callback()` before handling Esc. Return `True` if the app used it, for example to close a popup. |
+| `vim.search_hook = callback` | `/` calls `callback(True)`; `?` calls `callback(False)`. The app opens its search UI. |
+| `vim.set_search("rent", forward=True)` | Saves the search text and jumps to the next match. `n` repeats in that direction; `N` reverses it. |
+| `vim.normal()` | Goes to Normal mode as Esc does, from Insert or Visual mode. |
+| `vim.clipboard = True` | Uses the system clipboard for yank, delete, change and paste. Defaults to `False`. |
+| `vim.layout_map = UKRAINIAN` | Maps Ukrainian letters to Vim keys. This is the default; import `UKRAINIAN` from `side_vim`. Set `None` to disable it, or pass your own dictionary. |
+| `vim.set_enabled(False)` | Restores the plain editor and its cursor. `True` enables Vim in Normal mode. Read the setting through `vim.enabled`. |
+| `vim.detach()` | Removes Vim from the editor. To turn it off for a while, use `set_enabled(False)`. |
+
+When the app accepts a search, call `set_search` with its text and direction,
+after `normal()` if the search was opened from Insert mode.
+Search is case-sensitive, wraps around the document, and uses plain text rather
+than regular expressions. Each editor keeps its own search. An empty string
+clears it. In Insert mode or while disabled, `set_search` saves the search without
+moving the cursor. The [demo](https://github.com/sprytnyk/side-vim/blob/main/side_vim/__main__.py)
+shows a find bar and an Esc hook together.
+
+The unnamed register is shared between editors in the same process. With
+`clipboard=False`, yank in one editor and paste in another. With `clipboard=True`,
+text copied in another app pastes as whole lines if it ends in a newline.
+
+## Supported keys
+
+Counts work with motions and edits: `3w`, `5G`, `2dd`, `y3j`. A counted insert
+repeats the typed text: `3ix<Esc>` inserts `xxx`.
+
+| Action | Keys |
+| --- | --- |
+| Move | `h j k l`, `w b e`, `W B E`, `0 ^ $`, `gg G` |
+| Insert | `i a I A o O` |
+| Delete, change, yank | `d c y` followed by a motion; `dd cc yy`, `x D C` |
+| Paste, join | `p P`, `J` |
+| Undo, redo | `u`, `Ctrl+R` |
+| Select | `v` for characters, `V` for lines; motions extend the selection |
+| Edit a selection | `d c y x p`; `o` switches its ends |
+| Search | `/ ?` through the app hook, then `n N` |
+| Scroll a line | `Ctrl+E`, `Ctrl+Y` |
+| Scroll half a screen | `Ctrl+D`, `Ctrl+U` |
+| Scroll a screen | `Ctrl+F`, `Ctrl+B` |
+| Return to Normal | `Esc`, `Ctrl+[` |
+
+In Normal and Visual modes, the Ctrl keys above take priority over app shortcuts.
+`j` and `k` keep the screen column across tabs and wide characters, and a wrapped
+line counts as one line, as in Vim.
+
+This release has only the keys above. It has no repeat (`.`), text objects,
+`f t r ~`, colon commands, macros, marks, named registers or block selection.
+
+## Differences from Vim
+
+side-vim follows Vim 9.1 with its default settings, except for these:
+
+- Joined emoji and flags, such as 👨‍👩‍👧 and 🇺🇦, are one character. Vim splits
+  them into their parts. Accents, CJK and single emoji work as in Vim.
+- Search uses plain text, not regular expressions. There is no command line.
+  `/` and `?` call `search_hook`, then the app shows its own search box and
+  passes the text to `set_search`.
+- `J` puts one space after a period, like Vim with `nojoinspaces`. Vim's default
+  puts two.
+- Qt stops scrolling when the last line reaches the bottom of the editor. Vim
+  scrolls on until the last line is at the top, so `Ctrl+F` and `Ctrl+E` stop
+  sooner near the end. The cursor still goes to the line Vim picks.
+- In Insert mode the editor handles every key except Esc and `Ctrl+[`. Arrows,
+  Backspace and app shortcuts work as in any Qt editor. Vim's Insert mode keys,
+  such as `Ctrl+W`, `Ctrl+U` and `Ctrl+O`, are not there.
+- In Normal and Visual modes, Ctrl keys that side-vim doesn't use go to the
+  editor or the app, and so do PageUp, PageDown and the function keys. `Ctrl+A`
+  selects all, for example. Qt's keys that change the text do nothing in these
+  modes: paste, cut, `Ctrl+Backspace` and `Ctrl+Delete`. In Vim, `Ctrl+V` starts
+  a block selection, which side-vim doesn't have.
+- Other keys without a command do nothing in Normal mode. They never type text.
+- Esc in Normal mode with nothing pending goes to the app, for example to close a
+  dialog. Vim beeps.
+- A read-only editor allows movement, scrolling, selection, yank and search, and
+  ignores edits. Vim only warns when you change a read-only file.
+- Dragging with the mouse in Normal mode starts Visual mode.
+- Outside Insert mode, Ukrainian letters work as the Latin keys in the same
+  place, so `ц` is `w`. Vim needs `langmap` for that. Punctuation stays as typed,
+  `ґ` isn't mapped because its key moves between layout variants, and `/` needs
+  the English layout.
+- On macOS, Ctrl means the physical Control key. Command shortcuts stay with the
+  app.
+- The tab width comes from the editor's tab stop, not from a `tabstop` setting.
+- `u` and the app's undo share the editor's undo stack, so they undo the same
+  steps.
+
+## Develop
+
+```sh
+uv sync --locked
+make run       # Demo window
+make check     # Ruff and pytest
+make format    # Format Python
+make record    # Record expected results using local Vim
+make unicode   # Regenerate Vim character classes and widths
+make mac-keys  # Key checks on a Mac
+```
+
+Tests run Qt offscreen. CI runs for release tags and can also be started from
+**Actions → CI → Run workflow**. It tests Linux, macOS and Windows on Python 3.12
+and 3.14, and the lowest allowed PySide6 on Python 3.12.
+The tests replay saved [Vim cases](https://github.com/sprytnyk/side-vim/tree/main/tests/cases),
+so CI doesn't need Vim. Recording them needs Vim, and the scrolling cases need a
+Unix terminal.
+
+On a Mac, `make mac-keys` opens the demo and presses keys through macOS. It checks
+Ctrl and Cmd keys, search, read-only mode and the Ukrainian layout, and prints PASS
+or FAIL for each. Start it on the English (ABC) layout with Ukrainian-PC installed,
+and don't type until it finishes.
+
+## Release
+
+Set these up by hand before the first tag:
+
+1. In the GitHub repository, open **Settings**, then **Environments**, and create
+   `pypi`. Add yourself as a required reviewer. Leave **Prevent self-review** off,
+   so you can approve runs you start. Limit deployment tags to `v*`.
+2. In your PyPI account's **Publishing** page, add a pending trusted publisher:
+
+   | Field | Value |
+   | --- | --- |
+   | PyPI project | `side-vim` |
+   | GitHub owner | `sprytnyk` |
+   | Repository | `side-vim` |
+   | Workflow | `release.yml` |
+   | Environment | `pypi` |
+
+   A pending publisher creates the project on its first upload. No PyPI token
+   goes into GitHub. See the [PyPI setup guide](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
+   and [GitHub approval guide](https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments).
+
+For each release:
+
+1. On `main`, check the README and run `make check`. If key handling changed,
+   run `make mac-keys` on a Mac.
+2. Run `uv version X.Y.Z`. Write the dated `CHANGELOG.md` section from the commits
+   since the previous release, using only sections with entries: Breaking,
+   Highlights, Fixes, Changes and Removed. Review it before committing.
+3. Build and test the wheel in a temporary environment. Make the signed
+   `chore(release): vX.Y.Z` commit and signed `vX.Y.Z` tag with key
+   `0xC00C0F0D647BD3C6`. Push `main` and that tag to `origin`.
+4. The release workflow runs CI, checks that the tag matches the package version,
+   and builds the wheel and source distribution. Review the run and approve the
+   `pypi` job. It publishes those files using
+   [uv trusted publishing](https://docs.astral.sh/uv/guides/integration/github/#publishing-to-pypi).
+5. Confirm the version is on PyPI, then create a GitHub release using just the
+   changelog section as its notes. Attach no files.
+
+The project [release skill](https://github.com/sprytnyk/side-vim/blob/main/.claude/skills/release/SKILL.md)
+has the command sequence and approval points.

side_vim-0.1.0/README.md

@@ -0,0 +1,200 @@
+# side-vim
+
+A Vim mode for PySide6's `QPlainTextEdit`. Attach it to an existing editor to add
+Normal, Insert, Visual and Visual Line modes.
+
+![The demo in Visual mode, with text selected and the mode in the status bar](https://raw.githubusercontent.com/sprytnyk/side-vim/main/docs/demo.png)
+
+## Install
+
+Requires Python 3.12 or newer and PySide6 6.8 or newer. Installing side-vim also
+installs PySide6-Essentials.
+
+```sh
+uv add side-vim
+```
+
+## Usage
+
+```python
+import sys
+
+from PySide6.QtWidgets import QApplication, QLabel, QPlainTextEdit, QVBoxLayout, QWidget
+
+from side_vim import VimMode
+
+app = QApplication(sys.argv)
+window = QWidget()
+editor = QPlainTextEdit("Try w, i, Esc, v and y.")
+status = QLabel()
+layout = QVBoxLayout(window)
+layout.addWidget(editor)
+layout.addWidget(status)
+
+vim = VimMode(editor)  # Starts in Normal mode. Qt deletes it with the editor.
+status.setText(vim.mode.value)
+vim.mode_changed.connect(lambda mode: status.setText(mode.value))
+
+window.resize(800, 500)
+window.show()
+editor.setFocus()
+sys.exit(app.exec())
+```
+
+Attach one `VimMode` per editor. Import `Mode` to compare `vim.mode` with
+`Mode.NORMAL`, `Mode.INSERT`, `Mode.VISUAL` or `Mode.VISUAL_LINE`.
+
+| API | Behavior |
+| --- | --- |
+| `vim.mode_changed.connect(callback)` | Calls `callback(mode)` when the mode changes. |
+| `vim.pending_changed.connect(callback)` | Calls `callback(text)` with pending keys such as `2d`, or `""` when done. |
+| `vim.escape_hook = callback` | Calls `callback()` before handling Esc. Return `True` if the app used it, for example to close a popup. |
+| `vim.search_hook = callback` | `/` calls `callback(True)`; `?` calls `callback(False)`. The app opens its search UI. |
+| `vim.set_search("rent", forward=True)` | Saves the search text and jumps to the next match. `n` repeats in that direction; `N` reverses it. |
+| `vim.normal()` | Goes to Normal mode as Esc does, from Insert or Visual mode. |
+| `vim.clipboard = True` | Uses the system clipboard for yank, delete, change and paste. Defaults to `False`. |
+| `vim.layout_map = UKRAINIAN` | Maps Ukrainian letters to Vim keys. This is the default; import `UKRAINIAN` from `side_vim`. Set `None` to disable it, or pass your own dictionary. |
+| `vim.set_enabled(False)` | Restores the plain editor and its cursor. `True` enables Vim in Normal mode. Read the setting through `vim.enabled`. |
+| `vim.detach()` | Removes Vim from the editor. To turn it off for a while, use `set_enabled(False)`. |
+
+When the app accepts a search, call `set_search` with its text and direction,
+after `normal()` if the search was opened from Insert mode.
+Search is case-sensitive, wraps around the document, and uses plain text rather
+than regular expressions. Each editor keeps its own search. An empty string
+clears it. In Insert mode or while disabled, `set_search` saves the search without
+moving the cursor. The [demo](https://github.com/sprytnyk/side-vim/blob/main/side_vim/__main__.py)
+shows a find bar and an Esc hook together.
+
+The unnamed register is shared between editors in the same process. With
+`clipboard=False`, yank in one editor and paste in another. With `clipboard=True`,
+text copied in another app pastes as whole lines if it ends in a newline.
+
+## Supported keys
+
+Counts work with motions and edits: `3w`, `5G`, `2dd`, `y3j`. A counted insert
+repeats the typed text: `3ix<Esc>` inserts `xxx`.
+
+| Action | Keys |
+| --- | --- |
+| Move | `h j k l`, `w b e`, `W B E`, `0 ^ $`, `gg G` |
+| Insert | `i a I A o O` |
+| Delete, change, yank | `d c y` followed by a motion; `dd cc yy`, `x D C` |
+| Paste, join | `p P`, `J` |
+| Undo, redo | `u`, `Ctrl+R` |
+| Select | `v` for characters, `V` for lines; motions extend the selection |
+| Edit a selection | `d c y x p`; `o` switches its ends |
+| Search | `/ ?` through the app hook, then `n N` |
+| Scroll a line | `Ctrl+E`, `Ctrl+Y` |
+| Scroll half a screen | `Ctrl+D`, `Ctrl+U` |
+| Scroll a screen | `Ctrl+F`, `Ctrl+B` |
+| Return to Normal | `Esc`, `Ctrl+[` |
+
+In Normal and Visual modes, the Ctrl keys above take priority over app shortcuts.
+`j` and `k` keep the screen column across tabs and wide characters, and a wrapped
+line counts as one line, as in Vim.
+
+This release has only the keys above. It has no repeat (`.`), text objects,
+`f t r ~`, colon commands, macros, marks, named registers or block selection.
+
+## Differences from Vim
+
+side-vim follows Vim 9.1 with its default settings, except for these:
+
+- Joined emoji and flags, such as 👨‍👩‍👧 and 🇺🇦, are one character. Vim splits
+  them into their parts. Accents, CJK and single emoji work as in Vim.
+- Search uses plain text, not regular expressions. There is no command line.
+  `/` and `?` call `search_hook`, then the app shows its own search box and
+  passes the text to `set_search`.
+- `J` puts one space after a period, like Vim with `nojoinspaces`. Vim's default
+  puts two.
+- Qt stops scrolling when the last line reaches the bottom of the editor. Vim
+  scrolls on until the last line is at the top, so `Ctrl+F` and `Ctrl+E` stop
+  sooner near the end. The cursor still goes to the line Vim picks.
+- In Insert mode the editor handles every key except Esc and `Ctrl+[`. Arrows,
+  Backspace and app shortcuts work as in any Qt editor. Vim's Insert mode keys,
+  such as `Ctrl+W`, `Ctrl+U` and `Ctrl+O`, are not there.
+- In Normal and Visual modes, Ctrl keys that side-vim doesn't use go to the
+  editor or the app, and so do PageUp, PageDown and the function keys. `Ctrl+A`
+  selects all, for example. Qt's keys that change the text do nothing in these
+  modes: paste, cut, `Ctrl+Backspace` and `Ctrl+Delete`. In Vim, `Ctrl+V` starts
+  a block selection, which side-vim doesn't have.
+- Other keys without a command do nothing in Normal mode. They never type text.
+- Esc in Normal mode with nothing pending goes to the app, for example to close a
+  dialog. Vim beeps.
+- A read-only editor allows movement, scrolling, selection, yank and search, and
+  ignores edits. Vim only warns when you change a read-only file.
+- Dragging with the mouse in Normal mode starts Visual mode.
+- Outside Insert mode, Ukrainian letters work as the Latin keys in the same
+  place, so `ц` is `w`. Vim needs `langmap` for that. Punctuation stays as typed,
+  `ґ` isn't mapped because its key moves between layout variants, and `/` needs
+  the English layout.
+- On macOS, Ctrl means the physical Control key. Command shortcuts stay with the
+  app.
+- The tab width comes from the editor's tab stop, not from a `tabstop` setting.
+- `u` and the app's undo share the editor's undo stack, so they undo the same
+  steps.
+
+## Develop
+
+```sh
+uv sync --locked
+make run       # Demo window
+make check     # Ruff and pytest
+make format    # Format Python
+make record    # Record expected results using local Vim
+make unicode   # Regenerate Vim character classes and widths
+make mac-keys  # Key checks on a Mac
+```
+
+Tests run Qt offscreen. CI runs for release tags and can also be started from
+**Actions → CI → Run workflow**. It tests Linux, macOS and Windows on Python 3.12
+and 3.14, and the lowest allowed PySide6 on Python 3.12.
+The tests replay saved [Vim cases](https://github.com/sprytnyk/side-vim/tree/main/tests/cases),
+so CI doesn't need Vim. Recording them needs Vim, and the scrolling cases need a
+Unix terminal.
+
+On a Mac, `make mac-keys` opens the demo and presses keys through macOS. It checks
+Ctrl and Cmd keys, search, read-only mode and the Ukrainian layout, and prints PASS
+or FAIL for each. Start it on the English (ABC) layout with Ukrainian-PC installed,
+and don't type until it finishes.
+
+## Release
+
+Set these up by hand before the first tag:
+
+1. In the GitHub repository, open **Settings**, then **Environments**, and create
+   `pypi`. Add yourself as a required reviewer. Leave **Prevent self-review** off,
+   so you can approve runs you start. Limit deployment tags to `v*`.
+2. In your PyPI account's **Publishing** page, add a pending trusted publisher:
+
+   | Field | Value |
+   | --- | --- |
+   | PyPI project | `side-vim` |
+   | GitHub owner | `sprytnyk` |
+   | Repository | `side-vim` |
+   | Workflow | `release.yml` |
+   | Environment | `pypi` |
+
+   A pending publisher creates the project on its first upload. No PyPI token
+   goes into GitHub. See the [PyPI setup guide](https://docs.pypi.org/trusted-publishers/creating-a-project-through-oidc/)
+   and [GitHub approval guide](https://docs.github.com/en/actions/how-tos/deploy/configure-and-manage-deployments/review-deployments).
+
+For each release:
+
+1. On `main`, check the README and run `make check`. If key handling changed,
+   run `make mac-keys` on a Mac.
+2. Run `uv version X.Y.Z`. Write the dated `CHANGELOG.md` section from the commits
+   since the previous release, using only sections with entries: Breaking,
+   Highlights, Fixes, Changes and Removed. Review it before committing.
+3. Build and test the wheel in a temporary environment. Make the signed
+   `chore(release): vX.Y.Z` commit and signed `vX.Y.Z` tag with key
+   `0xC00C0F0D647BD3C6`. Push `main` and that tag to `origin`.
+4. The release workflow runs CI, checks that the tag matches the package version,
+   and builds the wheel and source distribution. Review the run and approve the
+   `pypi` job. It publishes those files using
+   [uv trusted publishing](https://docs.astral.sh/uv/guides/integration/github/#publishing-to-pypi).
+5. Confirm the version is on PyPI, then create a GitHub release using just the
+   changelog section as its notes. Attach no files.
+
+The project [release skill](https://github.com/sprytnyk/side-vim/blob/main/.claude/skills/release/SKILL.md)
+has the command sequence and approval points.

side_vim-0.1.0/pyproject.toml

@@ -0,0 +1,47 @@
+[project]
+name = "side-vim"
+version = "0.1.0"
+description = "Vim mode for PySide6's QPlainTextEdit"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+dependencies = ["PySide6-Essentials>=6.8"]
+
+[[project.authors]]
+name = "sprytnyk.dev"
+
+[project.urls]
+Repository = "https://github.com/sprytnyk/side-vim"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "ruff>=0.8",
+    "pip-audit>=2.7",
+]
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-root = ""
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "F",
+    "W",
+    "I",
+    "B",
+    "UP",
+    "SIM",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

side_vim-0.1.0/pyproject.toml.orig

@@ -0,0 +1,38 @@
+[project]
+name = "side-vim"
+version = "0.1.0"
+description = "Vim mode for PySide6's QPlainTextEdit"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "sprytnyk.dev" }]
+requires-python = ">=3.12"
+dependencies = ["PySide6-Essentials>=6.8"]
+
+[project.urls]
+Repository = "https://github.com/sprytnyk/side-vim"
+
+[dependency-groups]
+dev = [
+    "pytest>=8",
+    "ruff>=0.8",
+    "pip-audit>=2.7",
+]
+
+[build-system]
+requires = ["uv_build>=0.12,<0.13"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+# the package sits at the repo root, not under src/
+module-root = ""
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "SIM"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

side_vim-0.1.0/side_vim/__init__.py

@@ -0,0 +1,7 @@
+"""A vim mode for PySide6's QPlainTextEdit."""
+
+from side_vim.layouts import UKRAINIAN
+from side_vim.mode import Mode
+from side_vim.vim import VimMode
+
+__all__ = ["UKRAINIAN", "Mode", "VimMode"]

side_vim-0.1.0/side_vim/__main__.py

@@ -0,0 +1,146 @@
+"""A demo: an editor with vim keys and a status bar. Run it with `make run`."""
+
+import sys
+
+from PySide6.QtCore import Qt
+from PySide6.QtGui import QFontDatabase, QKeySequence, QShortcut
+from PySide6.QtWidgets import (
+    QApplication,
+    QCheckBox,
+    QLabel,
+    QLineEdit,
+    QMainWindow,
+    QPlainTextEdit,
+)
+
+from side_vim import Mode, VimMode
+
+SAMPLE = """\
+side-vim demo. Esc goes back to Normal mode; i, a, I, A, o and O start typing.
+Try w b e, W B E, 0 ^ $, gg G, h j k l, with counts: 3w, 2j, 5G.
+Edit with x, dw, d2j, cw, cc, C, D, dd, yy, yw, p, P and J; u undoes, Ctrl+R redoes.
+Tick "clipboard" to yank to the system clipboard and paste from it.
+v and V select, or drag with the mouse; then move, o, and d c y x p on the selection.
+/ and ? open the find bar: type, Enter, then n and N. Esc closes the find bar first.
+Scroll with Ctrl+E and Ctrl+Y (a line), Ctrl+D and Ctrl+U (half a screen), Ctrl+F and
+Ctrl+B (a screen). Tick "read-only" to try that; on the Ukrainian layout, ц works as w.
+
+\tA tab first, then words: foo.bar(baz) and foo-bar_baz.
+Emoji count as one character: 😀 👨‍👩‍👧 🇺🇦 1️⃣ and é.
+CJK is two cells wide, so j and k keep the column: 日本語のテキスト here.
+Українською теж: слово, ще одне слово.
+
+A long line that wraps when the window is narrow enough, to show that j and k move by \
+whole lines and not by the rows on the screen, the same as in vim with its defaults.
+
+The lines below are there to scroll through and to search in (try /rent or /😀).
+"""
+
+FILLER = [
+    "rent 1200, food 350, transport 90",
+    "    indented: savings = rent * 0.2",
+    "a line with an emoji 😀 and a flag 🇺🇦",
+    "",
+    "\tafter a tab: total, rent, food",
+    "short",
+    "Українська: оренда, їжа, транспорт",
+    "日本語のテキスト and rent again",
+]
+
+
+def sample() -> str:
+    lines = [f"{i:3}  {FILLER[i % len(FILLER)]}" for i in range(1, 301)]
+    return SAMPLE + "\n" + "\n".join(lines) + "\n"
+
+
+class Demo(QMainWindow):
+    """The demo window: an editor with vim keys, a find bar and a status bar."""
+
+    def __init__(self) -> None:
+        super().__init__()
+        self.setWindowTitle("side-vim demo")
+
+        self.editor = editor = QPlainTextEdit()
+        font = QFontDatabase.systemFont(QFontDatabase.SystemFont.FixedFont)
+        font.setPointSize(16)
+        editor.setFont(font)
+        editor.setTabStopDistance(editor.fontMetrics().horizontalAdvance(" ") * 8)
+        editor.setPlainText(sample())
+        self.setCentralWidget(editor)
+
+        self.vim = vim = VimMode(editor)
+
+        # a find bar: / and ? open it; Enter hands the text to vim, which jumps to it
+        self.find = QLineEdit()
+        self.find.setPlaceholderText("find")
+        self.find.hide()
+        self._forward = True
+        self.find.returnPressed.connect(self._run_find)
+        QShortcut(
+            QKeySequence("Esc"),
+            self.find,
+            self.close_find,
+            context=Qt.ShortcutContext.WidgetShortcut,
+        )
+        vim.search_hook = self.open_find
+        vim.escape_hook = self.close_find
+
+        self.mode_label = QLabel()
+        keys_label = QLabel()
+        toggle = QCheckBox("vim")
+        toggle.setChecked(True)
+        toggle.toggled.connect(vim.set_enabled)
+        toggle.toggled.connect(self.mode_label.setVisible)
+        clipboard = QCheckBox("clipboard")
+        clipboard.toggled.connect(lambda on: setattr(vim, "clipboard", on))
+        read_only = QCheckBox("read-only")
+        read_only.toggled.connect(editor.setReadOnly)
+        for box in (toggle, clipboard, read_only):
+            box.toggled.connect(lambda _: editor.setFocus())
+
+        self._show_mode(vim.mode)
+        vim.mode_changed.connect(self._show_mode)
+        vim.pending_changed.connect(keys_label.setText)
+
+        status = self.statusBar()
+        status.addWidget(self.mode_label)
+        status.addWidget(self.find, 1)
+        status.addPermanentWidget(keys_label)
+        status.addPermanentWidget(read_only)
+        status.addPermanentWidget(clipboard)
+        status.addPermanentWidget(toggle)
+        self.resize(1200, 640)
+
+    def open_find(self, forward: bool) -> None:
+        self._forward = forward
+        self.find.setPlaceholderText("find down" if forward else "find up")
+        self.find.show()
+        self.find.selectAll()
+        self.find.setFocus()
+
+    def close_find(self) -> bool:
+        """The Esc hook: closes the find bar first, if it's open."""
+        if not self.find.isVisible():
+            return False
+        self.find.hide()
+        self.editor.setFocus()
+        return True
+
+    def _run_find(self) -> None:
+        self.close_find()
+        self.vim.set_search(self.find.text(), self._forward)
+
+    def _show_mode(self, mode: Mode) -> None:
+        self.mode_label.setText(f"-- {mode.value.upper()} --")
+
+
+def main() -> int:
+    app = QApplication(sys.argv)
+    window = Demo()
+    window.show()
+    window.editor.setFocus()
+    return app.exec()
+
+
+if __name__ == "__main__":
+    sys.exit(main())