mirror of
https://github.com/kristoferssolo/solorice.git
synced 2025-10-21 20:10:34 +00:00
155 lines
5.6 KiB
Markdown
155 lines
5.6 KiB
Markdown
# relative-motions.yazi
|
|
|
|
A [Yazi](https://github.com/sxyazi/yazi) plugin based about vim motions.
|
|
|
|
https://github.com/dedukun/relative-motions.yazi/assets/25795432/04fb186a-5efe-442d-8d7b-2dccb6eee408
|
|
|
|
## Requirements
|
|
|
|
- [Yazi](https://github.com/sxyazi/yazi) v0.3.0+
|
|
|
|
## Installation
|
|
|
|
If you use the latest Yazi from main branch
|
|
|
|
```sh
|
|
ya pack -a dedukun/relative-motions
|
|
```
|
|
|
|
If you are using <= v0.3.3
|
|
|
|
```sh
|
|
# Linux/macOS
|
|
git clone --branch 0.3.3 https://github.com/dedukun/relative-motions.yazi.git ~/.config/yazi/plugins/relative-motions.yazi
|
|
|
|
# Windows
|
|
git clone --branch 0.3.3 https://github.com/dedukun/relative-motions.yazi.git %AppData%\yazi\config\plugins\relative-motions.yazi
|
|
```
|
|
|
|
## Configuration
|
|
|
|
If you want to use the numbers directly to start a motion add this to your `keymap.toml`:
|
|
|
|
<details>
|
|
|
|
```toml
|
|
[[manager.prepend_keymap]]
|
|
on = [ "1" ]
|
|
run = "plugin relative-motions --args=1"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "2" ]
|
|
run = "plugin relative-motions --args=2"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "3" ]
|
|
run = "plugin relative-motions --args=3"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "4" ]
|
|
run = "plugin relative-motions --args=4"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "5" ]
|
|
run = "plugin relative-motions --args=5"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "6" ]
|
|
run = "plugin relative-motions --args=6"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "7" ]
|
|
run = "plugin relative-motions --args=7"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "8" ]
|
|
run = "plugin relative-motions --args=8"
|
|
desc = "Move in relative steps"
|
|
|
|
[[manager.prepend_keymap]]
|
|
on = [ "9" ]
|
|
run = "plugin relative-motions --args=9"
|
|
desc = "Move in relative steps"
|
|
```
|
|
|
|
</details>
|
|
|
|
Alternatively you can use a key to trigger a new motion without any initial value, for that add the following in `keymap.toml`:
|
|
|
|
```toml
|
|
[[manager.prepend_keymap]]
|
|
on = [ "m" ]
|
|
run = "plugin relative-motions"
|
|
desc = "Trigger a new relative motion"
|
|
```
|
|
|
|
---
|
|
|
|
Additionally there are a couple of initial configurations that can be given to the plugin's `setup` function:
|
|
|
|
| Configuration | Values | Default | Description |
|
|
| -------------- | ----------------------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `show_numbers` | `relative`, `absolute`, `relative_absolute` or `none` | `none` | Shows relative or absolute numbers before the file icon |
|
|
| `show_motion` | `true` or `false` | `false` | Shows current motion in Status bar |
|
|
| `only_motions` | `true` or `false` | `false` | If true, only the motion movements will be enabled, i.e., the commands for delete, cut, yank and visual selection will be disabled |
|
|
|
|
If you want, for example, to enable relative numbers as well as to show the motion in the status bar,
|
|
add the following to Yazi's `init.lua`, i.e. `~/.config/yazi/init.lua`:
|
|
|
|
```lua
|
|
-- ~/.config/yazi/init.lua
|
|
require("relative-motions"):setup({ show_numbers="relative", show_motion = true })
|
|
```
|
|
|
|
> [!NOTE]
|
|
> The `show_numbers` and `show_motion` functionalities overwrite [`Current:redraw`](https://github.com/sxyazi/yazi/blob/e3c91115a2c096724303a0b364e7625691e4beba/yazi-plugin/preset/components/current.lua#L28)
|
|
> and [`Status:children_redraw`](https://github.com/sxyazi/yazi/blob/e3c91115a2c096724303a0b364e7625691e4beba/yazi-plugin/preset/components/status.lua#L177) respectively.
|
|
> If you have custom implementations for any of this functions
|
|
> you can add the provided `Entity:number` and `Status:motion` to your implementations, just check [here](https://github.com/dedukun/relative-motions.yazi/blob/main/init.lua#L126) how we are doing things.
|
|
|
|
## Usage
|
|
|
|
This plugin adds the some basic vim motions like `3k`, `12j`, `10gg`, etc.
|
|
The following table show all the available motions:
|
|
|
|
| Command | Description |
|
|
| -------------- | ------------------- |
|
|
| `j`/`<Down>` | Move `n` lines down |
|
|
| `k`/`<Up>` | Move `n` lines up |
|
|
| `gj`/`g<Down>` | Go `n` lines down |
|
|
| `gk`/`g<Up>` | Go `n` lines up |
|
|
| `gg` | Go to line |
|
|
|
|
Furthermore, the following operations were also added:
|
|
|
|
| Command | Description |
|
|
| ------- | ------------- |
|
|
| `v` | visual select |
|
|
| `y` | Yank |
|
|
| `x` | Cut |
|
|
| `d` | Delete motion |
|
|
|
|
This however must be followed by a direction, which can be `j`/`<Down>`, `k`/`<Up>` or repeating the command key,
|
|
which will operate from the cursor down, e.g. `2yy` will copy two files.
|
|
|
|
Finally, we also support some tab operations:
|
|
|
|
| Command | Description |
|
|
| ------- | ------------------------------------ |
|
|
| `t` | create `n` tabs |
|
|
| `H` | Move `n` tabs left |
|
|
| `L` | Move `n` tabs right |
|
|
| `gt` | Go to the `n` tab |
|
|
| `w` | Close tab `n` |
|
|
| `W` | Close `n` tabs right |
|
|
| `<` | Swap current tab with `n` tabs left |
|
|
| `>` | Swap current tab with `n` tabs right |
|
|
| `~` | Swap current tab with tab `n` |
|