-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.md
211 lines (158 loc) · 7.03 KB
/
README.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
# Neovim pde
My _personal development environment_ for Neovim
## Older versions
> [!NOTE]
> Tag [with_submodules] references the version containing `git submodules`,
> `lazy.nvim` and `mini.deps`
>
> Tag [with_lazynvim] references the version containing `lazy.nvim` and `mini.deps`
## Structure
- `init`: Uses `:h vim.loader` and calls `ak.init`
- [ak.init]: Invoke [ak.mini_deps]
- [ak.deps]: Load plugins
- [ak.config]: All setup for plugins, options, key-mappings, auto-commands, and colors
- [ak.mini]: Internal plugins [ak.mini.visits_harpooned] and [ak.mini.pick_hinted]
- [ak.util]: Shared code
## Install
> Requirements: Neovim latest version or nightly.
>
> Always review the code before trying a configuration.
Clone the repository:
```sh
git clone https://github.com/abeldekat/nvim_pde ~/.config/ak
```
Open Neovim with this config, installing the plugins:
```sh
NVIM_APPNAME=ak nvim
```
Remove the config:
```sh
rm -rf ~/.local/share/ak ~/.local/state/ak ~/.cache/ak
rm -rf ~/.config/ak
```
Note: For [peek.nvim], [deno] needs to be installed.
## Workflow
I touch type using the right hand
in combination with the forefinger of the left hand
- Leader: `space`
- Main plugins: [ak.mini.visits_harpooned], [oil.nvim], [mini.pick] and [mini.jump2d]
- Menu: [mini.clue]
### VisitsHarpooned
Internal plugin [ak.mini.visits_harpooned] is a customized [mini.visits] configuration,
operating in almost the same way as `harpoon`
- Info in statusline: [ak.mini.visits_harpooned_line]
- The shortcuts normally used for window navigation correspond to visit 1-4 in current label:
`c-j`, `<c-k>`,`<c-l>`,`<c-h>`
- Toggle current label on visit: `<leader>a`
- Add visit to "uncategorised" label: `<leader>oa`
- Pick visits from all labels: `<leader>j` ("strongest finger")
- Pick visits having current label: `<leader>ol`
- Change current label: `<leader>oj`
- Maintain visits having active label: `<leader>om`
- Remove active label from visits: `<leader>or`
- Copy global visits to "uncategorised" label: `<leader>oc`
Pickers can display hints using internal plugin [ak.mini.pick_hinted]
### Window navigation
- `<c-w>hjkl` (stock `Neovim`)
- `mw`(next window)
- `me`(last accessed window)
### Oil
- `mk`("rolling fingers"), opening oil
- `h` up one level
- `l` down one level, open file
### Tmux
- [tmux-sessionizer] inspired by @ThePrimeagen
- workspaces at the top of the screen, using [tmuxp]
- leader: `ctrl space`
- navigation:
- `tmux-sessionizer`: leader h
- previous session: leader j
- previous window: leader l
- existing sessions: leader k
- switch pane: leader o
### UI
- `mini.statusline`, no colors, except on:
- mode change
- diagnostics
- current buffer has current label (mini.visits)
- macro recording
- many color-schemes
Change color-schemes:
- on each startup, see [scripts], `vim_menu_owns`
- mini.pick, `leader f o c`, loads all colors, does not show builtin color-schemes
- change the palette of the current color-scheme using [leader h]
Script `vim_menu_owns` writes to `lua.ak.colors`.
Ignoring changes to that file:
```sh
git update-index --assume-unchanged lua/ak/colors.lua
```
## Key conflicts
Replace **replace** with **substitute** mnemonic:
In my config, the suggested key `gr`("go replace") in [mini.operators] is already used
for the `lsp`("go references").
I prefer "two character hotkeys" as I use some lsp keys quite often(`gd`, `gr`).
Solution: Change operator `gr` into `gs`, mnemonic for "go substitute".
Consequences:
- [mini.operators]: Change suggested key `gs`("go sort") into `gS`.
- [mini.surround]: Change `sr`(surround replace) into `ss`(surround substitute).
## Mini
Many of the excellent modules included in [mini.nvim] are used in this config:
`ai`, `align`, `animate`, `base16`, `clue`, `cursorword`,
`deps`, `diff`, `git`, `hipatterns`, `hue`, `icons`,
`indentscope`, `jump2d`, `move`, `notify`, `operators`, `pairs`,
`pick`, `splitjoin`, `starter`, `statusline`, `surround`, `visits`
Relevant discussions:
- [From `grapple` to `mini.visits`](https://github.com/echasnovski/mini.nvim/discussions/1158).
See internal plugin [ak.mini.visits_harpooned]
- [Augment pickers with labels and hotkeys](https://github.com/echasnovski/mini.nvim/discussions/1109).
See internal plugin [ak.mini.pick_hinted]
- [Pick bufferlines with treesitter highlighting](https://github.com/echasnovski/mini.nvim/discussions/988).
- [Apply tokyonight dev environment](https://github.com/echasnovski/mini.nvim/discussions/1012).
- [Optimized jumping with jump2d](https://github.com/echasnovski/mini.nvim/discussions/1033).
- [Beta testing mini.deps](https://github.com/echasnovski/mini.nvim/issues/689#issuecomment-1962327624).
## Environment
[tmux](https://github.com/abeldekat/tmux)
[alacritty](https://github.com/abeldekat/alacritty)
[zsh](https://github.com/abeldekat/zsh)
[scripts](https://github.com/abeldekat/scripts)
[awesome](https://github.com/abeldekat/awesome)
[arch linux](https://archlinux.org/)
## Acknowledgements
This repo uses code and ideas from the following repositories:
- [nvim](https://github.com/echasnovski/nvim) `@echasnovski`
- [mini.deps](https://github.com/echasnovski/mini.deps)
- [LazyVim](https://github.com/LazyVim/LazyVim)
- [lazy.nvim](https://github.com/folke/lazy.nvim)
- [dotfiles](https://github.com/folke/dot/tree/master/nvim) `@folke`
- [dotfiles](https://github.com/dpetka2001/dotfiles/tree/main/dot_config/nvim) `@dpetka2001`
- [dotfiles](https://github.com/lewis6991/dotfiles/tree/main/config/nvim) `@lewis6991`
- [dotfiles](https://github.com/savq/dotfiles/tree/master/nvim) `@savq`
- [dotfiles](https://github.com/MariaSolOs/dotfiles/tree/main/.config/nvim) `@mariasolos`
- [pckr.nvim](https://github.com/lewis6991/pckr.nvim)
[tmuxp]: https://github.com/tmux-python/tmuxp
[scripts]: https://github.com/abeldekat/scripts
[tmux-sessionizer]: https://github.com/abeldekat/scripts/blob/main/tmux-sessionizer
[ak.init]: lua/ak/init.lua
[ak.mini_deps]: lua/ak/mini_deps.lua
[ak.deps]: lua/ak/deps
[ak.config]: lua/ak/config
[ak.mini]: lua/ak/mini
[ak.util]: lua/ak/util
[leader h]: lua/ak/util/color.lua
[mini.nvim]: https://github.com/echasnovski/mini.nvim
[mini.operators]: https://github.com/echasnovski/mini.operators
[mini.surround]: https://github.com/echasnovski/mini.surround
[mini.pick]: https://github.com/echasnovski/mini.pick
[mini.visits]: https://github.com/echasnovski/mini.visits
[mini.jump2d]: https://github.com/echasnovski/mini.jum2d
[mini.clue]: https://github.com/echasnovski/mini.clue
[ak.mini.visits_harpooned]: lua/ak/mini/visits_harpooned.lua
[ak.mini.visits_harpooned_line]: lua/ak/mini/visits_harpooned_line.lua
[ak.mini.pick_hinted]: lua/ak/mini/pick_hinted.lua
[oil.nvim]: https://github.com/stevearc/oil.nvim
[peek.nvim]: https://github.com/toppair/peek.nvim
[deno]: https://deno.land
[with_submodules]: https://github.com/abeldekat/nvim_pde/tree/with_submodules
[with_lazynvim]: https://github.com/abeldekat/nvim_pde/tree/with_lazynvim