retrovim 0.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.conda/retrovim.yaml +259 -0
- package/.conda/terax.icns +0 -0
- package/.conda/terax.ico +0 -0
- package/.conda/terax.png +0 -0
- package/.github/workflows/release.yml +95 -0
- package/.gitmodules +3 -0
- package/.npm/kanata_touchcursor.js +28 -0
- package/.npm/nvim.js +26 -0
- package/.npm/yazi.js +26 -0
- package/.npm/zsh.js +17 -0
- package/.pip/kanata_touchcursor/__init__.py +28 -0
- package/.pip/nvim/__init__.py +31 -0
- package/.pip/yazi/__init__.py +31 -0
- package/.pip/zsh/__init__.py +22 -0
- package/CHANGELOG.md +26 -0
- package/LICENSE +674 -0
- package/README.md +336 -0
- package/kanata/touchcursor.kbd +164 -0
- package/nvim/init.lua +813 -0
- package/nvim/plugins/mini.nvim/.github/DISCUSSION_TEMPLATE/q-a.yml +72 -0
- package/nvim/plugins/mini.nvim/.github/ISSUE_TEMPLATE/bug-report.yml +136 -0
- package/nvim/plugins/mini.nvim/.github/ISSUE_TEMPLATE/config.yml +5 -0
- package/nvim/plugins/mini.nvim/.github/ISSUE_TEMPLATE/feature-request.yml +75 -0
- package/nvim/plugins/mini.nvim/.github/PULL_REQUEST_TEMPLATE.md +2 -0
- package/nvim/plugins/mini.nvim/.github/workflows/quality-control.yml +150 -0
- package/nvim/plugins/mini.nvim/.pre-commit-config.yaml +20 -0
- package/nvim/plugins/mini.nvim/.stylua.toml +7 -0
- package/nvim/plugins/mini.nvim/.styluaignore +1 -0
- package/nvim/plugins/mini.nvim/CHANGELOG.md +1894 -0
- package/nvim/plugins/mini.nvim/CODE_OF_CONDUCT.md +132 -0
- package/nvim/plugins/mini.nvim/CONTRIBUTING.md +331 -0
- package/nvim/plugins/mini.nvim/LICENSE +21 -0
- package/nvim/plugins/mini.nvim/MAINTAINING.md +330 -0
- package/nvim/plugins/mini.nvim/Makefile +51 -0
- package/nvim/plugins/mini.nvim/README.md +261 -0
- package/nvim/plugins/mini.nvim/TESTING.md +1011 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/README.md +35 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/benchmark.sh +56 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_dashboard-alpha.lua +21 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_dashboard-original.lua +17 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_dashboard-starter.lua +18 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_empty.lua +4 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_starter-default.lua +7 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_startify-alpha.lua +10 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_startify-original.lua +7 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/init-files/init_startify-starter.lua +20 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/install.sh +10 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/make_summary.py +68 -0
- package/nvim/plugins/mini.nvim/benchmarks/starter/startup-summary.md +10 -0
- package/nvim/plugins/mini.nvim/colors/miniautumn.lua +55 -0
- package/nvim/plugins/mini.nvim/colors/minicyan.lua +95 -0
- package/nvim/plugins/mini.nvim/colors/minischeme.lua +95 -0
- package/nvim/plugins/mini.nvim/colors/minispring.lua +53 -0
- package/nvim/plugins/mini.nvim/colors/minisummer.lua +49 -0
- package/nvim/plugins/mini.nvim/colors/miniwinter.lua +51 -0
- package/nvim/plugins/mini.nvim/colors/randomhue.lua +16 -0
- package/nvim/plugins/mini.nvim/doc/mini-ai.txt +889 -0
- package/nvim/plugins/mini.nvim/doc/mini-align.txt +923 -0
- package/nvim/plugins/mini.nvim/doc/mini-animate.txt +937 -0
- package/nvim/plugins/mini.nvim/doc/mini-base16.txt +285 -0
- package/nvim/plugins/mini.nvim/doc/mini-basics.txt +359 -0
- package/nvim/plugins/mini.nvim/doc/mini-bracketed.txt +622 -0
- package/nvim/plugins/mini.nvim/doc/mini-bufremove.txt +123 -0
- package/nvim/plugins/mini.nvim/doc/mini-clue.txt +760 -0
- package/nvim/plugins/mini.nvim/doc/mini-cmdline.txt +392 -0
- package/nvim/plugins/mini.nvim/doc/mini-colors.txt +880 -0
- package/nvim/plugins/mini.nvim/doc/mini-comment.txt +230 -0
- package/nvim/plugins/mini.nvim/doc/mini-completion.txt +477 -0
- package/nvim/plugins/mini.nvim/doc/mini-cursorword.txt +105 -0
- package/nvim/plugins/mini.nvim/doc/mini-deps.txt +590 -0
- package/nvim/plugins/mini.nvim/doc/mini-diff.txt +661 -0
- package/nvim/plugins/mini.nvim/doc/mini-doc.txt +434 -0
- package/nvim/plugins/mini.nvim/doc/mini-extra.txt +856 -0
- package/nvim/plugins/mini.nvim/doc/mini-files.txt +1018 -0
- package/nvim/plugins/mini.nvim/doc/mini-fuzzy.txt +160 -0
- package/nvim/plugins/mini.nvim/doc/mini-git.txt +425 -0
- package/nvim/plugins/mini.nvim/doc/mini-hipatterns.txt +489 -0
- package/nvim/plugins/mini.nvim/doc/mini-hues.txt +420 -0
- package/nvim/plugins/mini.nvim/doc/mini-icons.txt +508 -0
- package/nvim/plugins/mini.nvim/doc/mini-indentscope.txt +485 -0
- package/nvim/plugins/mini.nvim/doc/mini-input.txt +932 -0
- package/nvim/plugins/mini.nvim/doc/mini-jump.txt +202 -0
- package/nvim/plugins/mini.nvim/doc/mini-jump2d.txt +525 -0
- package/nvim/plugins/mini.nvim/doc/mini-keymap.txt +449 -0
- package/nvim/plugins/mini.nvim/doc/mini-map.txt +717 -0
- package/nvim/plugins/mini.nvim/doc/mini-misc.txt +431 -0
- package/nvim/plugins/mini.nvim/doc/mini-move.txt +181 -0
- package/nvim/plugins/mini.nvim/doc/mini-notify.txt +434 -0
- package/nvim/plugins/mini.nvim/doc/mini-nvim.txt +431 -0
- package/nvim/plugins/mini.nvim/doc/mini-operators.txt +472 -0
- package/nvim/plugins/mini.nvim/doc/mini-pairs.txt +346 -0
- package/nvim/plugins/mini.nvim/doc/mini-pick.txt +1535 -0
- package/nvim/plugins/mini.nvim/doc/mini-sessions.txt +239 -0
- package/nvim/plugins/mini.nvim/doc/mini-snippets.txt +1291 -0
- package/nvim/plugins/mini.nvim/doc/mini-splitjoin.txt +536 -0
- package/nvim/plugins/mini.nvim/doc/mini-starter.txt +618 -0
- package/nvim/plugins/mini.nvim/doc/mini-statusline.txt +361 -0
- package/nvim/plugins/mini.nvim/doc/mini-surround.txt +863 -0
- package/nvim/plugins/mini.nvim/doc/mini-tabline.txt +151 -0
- package/nvim/plugins/mini.nvim/doc/mini-test.txt +966 -0
- package/nvim/plugins/mini.nvim/doc/mini-trailspace.txt +91 -0
- package/nvim/plugins/mini.nvim/doc/mini-visits.txt +937 -0
- package/nvim/plugins/mini.nvim/logo.png +0 -0
- package/nvim/plugins/mini.nvim/lua/mini/ai.lua +2244 -0
- package/nvim/plugins/mini.nvim/lua/mini/align.lua +2076 -0
- package/nvim/plugins/mini.nvim/lua/mini/animate.lua +2127 -0
- package/nvim/plugins/mini.nvim/lua/mini/base16.lua +1752 -0
- package/nvim/plugins/mini.nvim/lua/mini/basics.lua +772 -0
- package/nvim/plugins/mini.nvim/lua/mini/bracketed.lua +2013 -0
- package/nvim/plugins/mini.nvim/lua/mini/bufremove.lua +283 -0
- package/nvim/plugins/mini.nvim/lua/mini/clue.lua +2096 -0
- package/nvim/plugins/mini.nvim/lua/mini/cmdline.lua +1182 -0
- package/nvim/plugins/mini.nvim/lua/mini/colors.lua +2483 -0
- package/nvim/plugins/mini.nvim/lua/mini/comment.lua +586 -0
- package/nvim/plugins/mini.nvim/lua/mini/completion.lua +2094 -0
- package/nvim/plugins/mini.nvim/lua/mini/cursorword.lua +311 -0
- package/nvim/plugins/mini.nvim/lua/mini/deps.lua +1660 -0
- package/nvim/plugins/mini.nvim/lua/mini/diff.lua +1938 -0
- package/nvim/plugins/mini.nvim/lua/mini/doc.lua +1371 -0
- package/nvim/plugins/mini.nvim/lua/mini/extra.lua +2290 -0
- package/nvim/plugins/mini.nvim/lua/mini/files.lua +3145 -0
- package/nvim/plugins/mini.nvim/lua/mini/fuzzy.lua +356 -0
- package/nvim/plugins/mini.nvim/lua/mini/git.lua +1737 -0
- package/nvim/plugins/mini.nvim/lua/mini/hipatterns.lua +1042 -0
- package/nvim/plugins/mini.nvim/lua/mini/hues.lua +2088 -0
- package/nvim/plugins/mini.nvim/lua/mini/icons.lua +2254 -0
- package/nvim/plugins/mini.nvim/lua/mini/indentscope.lua +1158 -0
- package/nvim/plugins/mini.nvim/lua/mini/init.lua +427 -0
- package/nvim/plugins/mini.nvim/lua/mini/input.lua +2183 -0
- package/nvim/plugins/mini.nvim/lua/mini/jump.lua +609 -0
- package/nvim/plugins/mini.nvim/lua/mini/jump2d.lua +1244 -0
- package/nvim/plugins/mini.nvim/lua/mini/keymap.lua +880 -0
- package/nvim/plugins/mini.nvim/lua/mini/map.lua +1709 -0
- package/nvim/plugins/mini.nvim/lua/mini/misc.lua +969 -0
- package/nvim/plugins/mini.nvim/lua/mini/move.lua +509 -0
- package/nvim/plugins/mini.nvim/lua/mini/notify.lua +938 -0
- package/nvim/plugins/mini.nvim/lua/mini/operators.lua +1349 -0
- package/nvim/plugins/mini.nvim/lua/mini/pairs.lua +657 -0
- package/nvim/plugins/mini.nvim/lua/mini/pick.lua +3876 -0
- package/nvim/plugins/mini.nvim/lua/mini/sessions.lua +689 -0
- package/nvim/plugins/mini.nvim/lua/mini/snippets.lua +2828 -0
- package/nvim/plugins/mini.nvim/lua/mini/splitjoin.lua +1132 -0
- package/nvim/plugins/mini.nvim/lua/mini/starter.lua +1599 -0
- package/nvim/plugins/mini.nvim/lua/mini/statusline.lua +686 -0
- package/nvim/plugins/mini.nvim/lua/mini/surround.lua +2388 -0
- package/nvim/plugins/mini.nvim/lua/mini/tabline.lua +564 -0
- package/nvim/plugins/mini.nvim/lua/mini/test.lua +2516 -0
- package/nvim/plugins/mini.nvim/lua/mini/trailspace.lua +215 -0
- package/nvim/plugins/mini.nvim/lua/mini/visits.lua +1577 -0
- package/nvim/plugins/mini.nvim/readmes/mini-ai.md +190 -0
- package/nvim/plugins/mini.nvim/readmes/mini-align.md +203 -0
- package/nvim/plugins/mini.nvim/readmes/mini-animate.md +214 -0
- package/nvim/plugins/mini.nvim/readmes/mini-base16.md +198 -0
- package/nvim/plugins/mini.nvim/readmes/mini-basics.md +184 -0
- package/nvim/plugins/mini.nvim/readmes/mini-bracketed.md +193 -0
- package/nvim/plugins/mini.nvim/readmes/mini-bufremove.md +139 -0
- package/nvim/plugins/mini.nvim/readmes/mini-clue.md +260 -0
- package/nvim/plugins/mini.nvim/readmes/mini-cmdline.md +183 -0
- package/nvim/plugins/mini.nvim/readmes/mini-colors.md +169 -0
- package/nvim/plugins/mini.nvim/readmes/mini-comment.md +183 -0
- package/nvim/plugins/mini.nvim/readmes/mini-completion.md +217 -0
- package/nvim/plugins/mini.nvim/readmes/mini-cursorword.md +137 -0
- package/nvim/plugins/mini.nvim/readmes/mini-deps.md +271 -0
- package/nvim/plugins/mini.nvim/readmes/mini-diff.md +289 -0
- package/nvim/plugins/mini.nvim/readmes/mini-doc.md +198 -0
- package/nvim/plugins/mini.nvim/readmes/mini-extra.md +158 -0
- package/nvim/plugins/mini.nvim/readmes/mini-files.md +247 -0
- package/nvim/plugins/mini.nvim/readmes/mini-fuzzy.md +134 -0
- package/nvim/plugins/mini.nvim/readmes/mini-git.md +168 -0
- package/nvim/plugins/mini.nvim/readmes/mini-hipatterns.md +176 -0
- package/nvim/plugins/mini.nvim/readmes/mini-hues.md +285 -0
- package/nvim/plugins/mini.nvim/readmes/mini-icons.md +183 -0
- package/nvim/plugins/mini.nvim/readmes/mini-indentscope.md +191 -0
- package/nvim/plugins/mini.nvim/readmes/mini-input.md +163 -0
- package/nvim/plugins/mini.nvim/readmes/mini-jump.md +161 -0
- package/nvim/plugins/mini.nvim/readmes/mini-jump2d.md +197 -0
- package/nvim/plugins/mini.nvim/readmes/mini-keymap.md +205 -0
- package/nvim/plugins/mini.nvim/readmes/mini-map.md +191 -0
- package/nvim/plugins/mini.nvim/readmes/mini-misc.md +145 -0
- package/nvim/plugins/mini.nvim/readmes/mini-move.md +163 -0
- package/nvim/plugins/mini.nvim/readmes/mini-notify.md +175 -0
- package/nvim/plugins/mini.nvim/readmes/mini-operators.md +193 -0
- package/nvim/plugins/mini.nvim/readmes/mini-pairs.md +158 -0
- package/nvim/plugins/mini.nvim/readmes/mini-pick.md +340 -0
- package/nvim/plugins/mini.nvim/readmes/mini-sessions.md +164 -0
- package/nvim/plugins/mini.nvim/readmes/mini-snippets.md +373 -0
- package/nvim/plugins/mini.nvim/readmes/mini-splitjoin.md +194 -0
- package/nvim/plugins/mini.nvim/readmes/mini-starter.md +176 -0
- package/nvim/plugins/mini.nvim/readmes/mini-statusline.md +155 -0
- package/nvim/plugins/mini.nvim/readmes/mini-surround.md +190 -0
- package/nvim/plugins/mini.nvim/readmes/mini-tabline.md +156 -0
- package/nvim/plugins/mini.nvim/readmes/mini-test.md +175 -0
- package/nvim/plugins/mini.nvim/readmes/mini-trailspace.md +137 -0
- package/nvim/plugins/mini.nvim/readmes/mini-visits.md +243 -0
- package/nvim/plugins/mini.nvim/scripts/dual_log.sh +13 -0
- package/nvim/plugins/mini.nvim/scripts/dual_push.sh +15 -0
- package/nvim/plugins/mini.nvim/scripts/dual_release.sh +102 -0
- package/nvim/plugins/mini.nvim/scripts/dual_sync.sh +115 -0
- package/nvim/plugins/mini.nvim/scripts/init-deps-example.lua +59 -0
- package/nvim/plugins/mini.nvim/scripts/lint-filename-length.sh +16 -0
- package/nvim/plugins/mini.nvim/scripts/lintcommit-ci.sh +18 -0
- package/nvim/plugins/mini.nvim/scripts/lintcommit.lua +393 -0
- package/nvim/plugins/mini.nvim/scripts/minidoc.lua +57 -0
- package/nvim/plugins/mini.nvim/scripts/minimal_init.lua +28 -0
- package/nvim/plugins/mini.nvim/scripts/minitest.lua +4 -0
- package/package.json +16 -0
- package/pyproject.toml +43 -0
- package/yazi/init.lua +12 -0
- package/yazi/keymap.toml +114 -0
- package/yazi/lesskey +5 -0
- package/yazi/plugins/bookmarks.yazi/main.lua +86 -0
- package/yazi/plugins/cd-git-root.yazi/main.lua +31 -0
- package/yazi/plugins/smart-enter.yazi/main.lua +11 -0
- package/yazi/theme.toml +26 -0
- package/yazi/yazi.toml +15 -0
- package/zsh/.zshrc +145 -0
- package/zsh/starship.toml +20 -0
- package/zsh/zsh-patina.toml +2 -0
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-starter_readme.png?raw=true" alt="mini.starter" style="max-width:100%;border:solid 2px"/> </p>
|
|
2
|
+
|
|
3
|
+
### Fast and flexible start screen
|
|
4
|
+
|
|
5
|
+
See more details in [Features](#features) and [Documentation](../doc/mini-starter.txt).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
> [!NOTE]
|
|
10
|
+
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
|
|
11
|
+
|
|
12
|
+
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-starter) if you want to mention this module.
|
|
13
|
+
|
|
14
|
+
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
|
|
15
|
+
|
|
16
|
+
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
|
|
17
|
+
|
|
18
|
+
⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
|
|
23
|
+
|
|
24
|
+
## Demo
|
|
25
|
+
|
|
26
|
+
<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-starter.mp4 -->
|
|
27
|
+
https://user-images.githubusercontent.com/24854248/173045153-19087983-0211-4ab9-8278-909616b53c7e.mp4
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- All available actions are defined inside items. There are pre-configured whole sections in `MiniStarter.sections`.
|
|
32
|
+
- Configure what items are displayed by supplying an array which can be normalized to an array of items. Read about how supplied items are normalized in `MiniStarter.refresh()`.
|
|
33
|
+
- Modify the final look by supplying content hooks. There are pre-configured content hook generators in `MiniStarter.gen_hook`.
|
|
34
|
+
- Choosing an item can be done in two ways:
|
|
35
|
+
- Type prefix query to filter item by matching its name (ignoring case). Displayed information is updated after every typed character. For every item its unique prefix is highlighted.
|
|
36
|
+
- Use Down/Up arrows (or `<C-n>`/`<C-p>`, or `<M-j>`/`<M-k>`) and hit Enter.
|
|
37
|
+
- Allow multiple simultaneously open Starter buffers.
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
|
|
42
|
+
|
|
43
|
+
There are two branches to install from:
|
|
44
|
+
|
|
45
|
+
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
|
|
46
|
+
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
|
|
47
|
+
|
|
48
|
+
Here are code snippets for some common installation methods (use only one):
|
|
49
|
+
|
|
50
|
+
<details>
|
|
51
|
+
<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
|
|
52
|
+
|
|
53
|
+
**Full library**
|
|
54
|
+
|
|
55
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
56
|
+
|
|
57
|
+
**Standalone plugin**
|
|
58
|
+
|
|
59
|
+
Main branch:
|
|
60
|
+
|
|
61
|
+
```lua
|
|
62
|
+
vim.pack.add({ 'https://github.com/nvim-mini/mini.starter' })
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Stable branch:
|
|
66
|
+
|
|
67
|
+
```lua
|
|
68
|
+
vim.pack.add({
|
|
69
|
+
{ src = 'https://github.com/nvim-mini/mini.starter', version = 'stable' },
|
|
70
|
+
})
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
</details>
|
|
74
|
+
|
|
75
|
+
<details>
|
|
76
|
+
<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
|
|
77
|
+
|
|
78
|
+
**Full library**
|
|
79
|
+
|
|
80
|
+
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
|
|
81
|
+
|
|
82
|
+
**Standalone plugin**:
|
|
83
|
+
|
|
84
|
+
Main branch:
|
|
85
|
+
|
|
86
|
+
```lua
|
|
87
|
+
add('nvim-mini/mini.starter')
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Stable branch:
|
|
91
|
+
|
|
92
|
+
```lua
|
|
93
|
+
add({ source = 'nvim-mini/mini.starter', checkout = 'stable' })
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
</details>
|
|
97
|
+
|
|
98
|
+
<details>
|
|
99
|
+
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
|
|
100
|
+
|
|
101
|
+
**Full library**
|
|
102
|
+
|
|
103
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
104
|
+
|
|
105
|
+
**Standalone plugin**
|
|
106
|
+
|
|
107
|
+
Main branch:
|
|
108
|
+
|
|
109
|
+
```lua
|
|
110
|
+
{ 'nvim-mini/mini.starter', version = false },
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Stable branch:
|
|
114
|
+
|
|
115
|
+
```lua
|
|
116
|
+
{ 'nvim-mini/mini.starter', version = '*' },
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
</details>
|
|
120
|
+
|
|
121
|
+
**Important**: don't forget to call `require('mini.starter').setup()` to enable its functionality.
|
|
122
|
+
|
|
123
|
+
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
|
|
124
|
+
|
|
125
|
+
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
|
|
126
|
+
- Install plugin in other place with shorter path.
|
|
127
|
+
|
|
128
|
+
## Default config
|
|
129
|
+
|
|
130
|
+
```lua
|
|
131
|
+
-- No need to copy this inside `setup()`. Will be used automatically.
|
|
132
|
+
{
|
|
133
|
+
-- Whether to open starter buffer on VimEnter. Not opened if Neovim was
|
|
134
|
+
-- started with intent to show something else.
|
|
135
|
+
autoopen = true,
|
|
136
|
+
|
|
137
|
+
-- Whether to evaluate action of single active item
|
|
138
|
+
evaluate_single = false,
|
|
139
|
+
|
|
140
|
+
-- Items to be displayed. Should be an array with the following elements:
|
|
141
|
+
-- - Item: table with <action>, <name>, and <section> keys.
|
|
142
|
+
-- - Function: should return one of these three categories.
|
|
143
|
+
-- - Array: elements of these three types (i.e. item, array, function).
|
|
144
|
+
-- If `nil` (default), default items will be used (see |mini.starter|).
|
|
145
|
+
items = nil,
|
|
146
|
+
|
|
147
|
+
-- Header to be displayed before items. Converted to single string via
|
|
148
|
+
-- `tostring` (use `\n` to display several lines). If function, it is
|
|
149
|
+
-- evaluated first. If `nil` (default), polite greeting will be used.
|
|
150
|
+
header = nil,
|
|
151
|
+
|
|
152
|
+
-- Footer to be displayed after items. Converted to single string via
|
|
153
|
+
-- `tostring` (use `\n` to display several lines). If function, it is
|
|
154
|
+
-- evaluated first. If `nil` (default), default usage help will be shown.
|
|
155
|
+
footer = nil,
|
|
156
|
+
|
|
157
|
+
-- Array of functions to be applied consecutively to initial content.
|
|
158
|
+
-- Each function should take and return content for 'Starter' buffer (see
|
|
159
|
+
-- |mini.starter| and |MiniStarter.content| for more details).
|
|
160
|
+
content_hooks = nil,
|
|
161
|
+
|
|
162
|
+
-- Characters to update query. Each character will have special buffer
|
|
163
|
+
-- mapping overriding your global ones. Be careful to not add `:` as it
|
|
164
|
+
-- allows you to go into command mode.
|
|
165
|
+
query_updaters = 'abcdefghijklmnopqrstuvwxyz0123456789_-.',
|
|
166
|
+
|
|
167
|
+
-- Whether to disable showing non-error feedback
|
|
168
|
+
silent = false,
|
|
169
|
+
}
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
## Similar plugins
|
|
173
|
+
|
|
174
|
+
- [mhinz/vim-startify](https://github.com/mhinz/vim-startify)
|
|
175
|
+
- [glepnir/dashboard-nvim](https://github.com/glepnir/dashboard-nvim)
|
|
176
|
+
- [goolord/alpha-nvim](https://github.com/goolord/alpha-nvim)
|
|
@@ -0,0 +1,155 @@
|
|
|
1
|
+
<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-statusline_readme.png?raw=true" alt="mini.statusline" style="max-width:100%;border:solid 2px"/> </p>
|
|
2
|
+
|
|
3
|
+
### Minimal and fast statusline module with opinionated default look
|
|
4
|
+
|
|
5
|
+
See more details in [Features](#features) and [Documentation](../doc/mini-statusline.txt).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
> [!NOTE]
|
|
10
|
+
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
|
|
11
|
+
|
|
12
|
+
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-statusline) if you want to mention this module.
|
|
13
|
+
|
|
14
|
+
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
|
|
15
|
+
|
|
16
|
+
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
|
|
17
|
+
|
|
18
|
+
⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
|
|
23
|
+
|
|
24
|
+
## Demo
|
|
25
|
+
|
|
26
|
+
<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-statusline.mp4 -->
|
|
27
|
+
https://user-images.githubusercontent.com/24854248/173045208-42463c8f-a2ac-488d-9d30-216891f4bb51.mp4
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- Define own custom statusline structure for active and inactive windows. This is done with a function which should return string appropriate for |statusline|. Its code should be similar to default one with structure:
|
|
32
|
+
- Compute string data for every section you want to be displayed.
|
|
33
|
+
- Combine them in groups with `MiniStatusline.combine_groups()`.
|
|
34
|
+
- Built-in active mode indicator with colors.
|
|
35
|
+
- Sections can hide information when window is too narrow (specific window width is configurable per section).
|
|
36
|
+
|
|
37
|
+
## Dependencies
|
|
38
|
+
|
|
39
|
+
For full experience needs (still works without any of suggestions):
|
|
40
|
+
|
|
41
|
+
- [Nerd font](https://www.nerdfonts.com/) and enabled ['mini.icons'](https://nvim-mini.org/mini.nvim/readmes/mini-icons) module to show filetype icons. Can fall back to using [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) plugin.
|
|
42
|
+
|
|
43
|
+
- Enabled ['mini.git'](https://nvim-mini.org/mini.nvim/readmes/mini-git) and ['mini.diff'](https://nvim-mini.org/mini.nvim/readmes/mini-diff) modules to show Git and diff related information. Can fall back to using [lewis6991/gitsigns.nvim](https://github.com/lewis6991/gitsigns.nvim) plugin.
|
|
44
|
+
|
|
45
|
+
## Installation
|
|
46
|
+
|
|
47
|
+
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
|
|
48
|
+
|
|
49
|
+
There are two branches to install from:
|
|
50
|
+
|
|
51
|
+
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
|
|
52
|
+
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
|
|
53
|
+
|
|
54
|
+
Here are code snippets for some common installation methods (use only one):
|
|
55
|
+
|
|
56
|
+
<details>
|
|
57
|
+
<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
|
|
58
|
+
|
|
59
|
+
**Full library**
|
|
60
|
+
|
|
61
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
62
|
+
|
|
63
|
+
**Standalone plugin**
|
|
64
|
+
|
|
65
|
+
Main branch:
|
|
66
|
+
|
|
67
|
+
```lua
|
|
68
|
+
vim.pack.add({ 'https://github.com/nvim-mini/mini.statusline' })
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Stable branch:
|
|
72
|
+
|
|
73
|
+
```lua
|
|
74
|
+
vim.pack.add({
|
|
75
|
+
{ src = 'https://github.com/nvim-mini/mini.statusline', version = 'stable' },
|
|
76
|
+
})
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</details>
|
|
80
|
+
|
|
81
|
+
<details>
|
|
82
|
+
<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
|
|
83
|
+
|
|
84
|
+
**Full library**
|
|
85
|
+
|
|
86
|
+
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
|
|
87
|
+
|
|
88
|
+
**Standalone plugin**:
|
|
89
|
+
|
|
90
|
+
Main branch:
|
|
91
|
+
|
|
92
|
+
```lua
|
|
93
|
+
add('nvim-mini/mini.statusline')
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Stable branch:
|
|
97
|
+
|
|
98
|
+
```lua
|
|
99
|
+
add({ source = 'nvim-mini/mini.statusline', checkout = 'stable' })
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
</details>
|
|
103
|
+
|
|
104
|
+
<details>
|
|
105
|
+
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
|
|
106
|
+
|
|
107
|
+
**Full library**
|
|
108
|
+
|
|
109
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
110
|
+
|
|
111
|
+
**Standalone plugin**
|
|
112
|
+
|
|
113
|
+
Main branch:
|
|
114
|
+
|
|
115
|
+
```lua
|
|
116
|
+
{ 'nvim-mini/mini.statusline', version = false },
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Stable branch:
|
|
120
|
+
|
|
121
|
+
```lua
|
|
122
|
+
{ 'nvim-mini/mini.statusline', version = '*' },
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
</details>
|
|
126
|
+
|
|
127
|
+
**Important**: don't forget to call `require('mini.statusline').setup()` to enable its functionality.
|
|
128
|
+
|
|
129
|
+
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
|
|
130
|
+
|
|
131
|
+
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
|
|
132
|
+
- Install plugin in other place with shorter path.
|
|
133
|
+
|
|
134
|
+
## Default config
|
|
135
|
+
|
|
136
|
+
```lua
|
|
137
|
+
-- No need to copy this inside `setup()`. Will be used automatically.
|
|
138
|
+
{
|
|
139
|
+
-- Content of statusline as functions which return statusline string. See
|
|
140
|
+
-- `:h statusline` and code of default contents (used instead of `nil`).
|
|
141
|
+
content = {
|
|
142
|
+
-- Content for active window
|
|
143
|
+
active = nil,
|
|
144
|
+
-- Content for inactive window(s)
|
|
145
|
+
inactive = nil,
|
|
146
|
+
},
|
|
147
|
+
|
|
148
|
+
-- Whether to use icons by default
|
|
149
|
+
use_icons = true,
|
|
150
|
+
}
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
## Similar plugins
|
|
154
|
+
|
|
155
|
+
- [nvim-lualine/lualine.nvim](https://github.com/nvim-lualine/lualine.nvim)
|
|
@@ -0,0 +1,190 @@
|
|
|
1
|
+
<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-surround_readme.png?raw=true" alt="mini.surround" style="max-width:100%;border:solid 2px"/> </p>
|
|
2
|
+
|
|
3
|
+
### Fast and feature-rich surround actions
|
|
4
|
+
|
|
5
|
+
- Add, delete, replace, find, highlight surrounding (like pair of parenthesis, quotes, etc.).
|
|
6
|
+
- Supports dot-repeat for text edits, `v:count`, different search methods, "last"/"next" extended mappings, customization via Lua patterns or functions, and more.
|
|
7
|
+
- Has builtins for brackets, function call, tag, user prompt, and any alphanumeric/punctuation/whitespace character.
|
|
8
|
+
- Has maintained configuration of setup similar to 'tpope/vim-surround'.
|
|
9
|
+
|
|
10
|
+
See more details in [Features](#features) and [Documentation](../doc/mini-surround.txt).
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
> [!NOTE]
|
|
15
|
+
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
|
|
16
|
+
|
|
17
|
+
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-surround) if you want to mention this module.
|
|
18
|
+
|
|
19
|
+
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
|
|
20
|
+
|
|
21
|
+
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
|
|
22
|
+
|
|
23
|
+
⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
|
|
28
|
+
|
|
29
|
+
## Demo
|
|
30
|
+
|
|
31
|
+
<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-surround.mp4 -->
|
|
32
|
+
https://github.com/user-attachments/assets/e91b6e16-7a9c-44aa-afb4-7e07efc3e811
|
|
33
|
+
|
|
34
|
+
## Features
|
|
35
|
+
|
|
36
|
+
- Actions (text editing actions are dot-repeatable out of the box and respect `[count]`) with configurable mappings:
|
|
37
|
+
- Add surrounding with `sa` (in visual mode or on motion).
|
|
38
|
+
- Delete surrounding with `sd`.
|
|
39
|
+
- Replace surrounding with `sr`.
|
|
40
|
+
- Find surrounding with `sf` or `sF` (move cursor right or left).
|
|
41
|
+
- Highlight surrounding with `sh`.
|
|
42
|
+
- Surrounding is identified by a single character as both "input" (in `delete` and `replace` start, `find`, and `highlight`) and "output" (in `add` and `replace` end):
|
|
43
|
+
- `f` - function call (string of alphanumeric symbols or `_` or `.` followed by balanced `()`). In "input" finds function call, in "output" prompts user to enter function name.
|
|
44
|
+
- `t` - tag. In "input" finds tag with same identifier, in "output" prompts user to enter tag name.
|
|
45
|
+
- All symbols in brackets `()`, `[]`, `{}`, `<>`. In "input" represents balanced brackets (open - with whitespace pad, close - without), in "output" - left and right parts of brackets.
|
|
46
|
+
- `?` - interactive. Prompts user to enter left and right parts.
|
|
47
|
+
- All other single character identifiers (supported by `getcharstr()`) represent surrounding with identical left and right parts.
|
|
48
|
+
- Configurable search methods to find not only covering but possibly next, previous, or nearest surrounding. See more in help for `MiniSurround.config`.
|
|
49
|
+
- All actions involving finding surrounding (delete, replace, find, highlight) can be used with suffix that changes search method to find previous/last. See more in help for `MiniSurround.config`.
|
|
50
|
+
|
|
51
|
+
## Installation
|
|
52
|
+
|
|
53
|
+
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
|
|
54
|
+
|
|
55
|
+
There are two branches to install from:
|
|
56
|
+
|
|
57
|
+
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
|
|
58
|
+
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
|
|
59
|
+
|
|
60
|
+
Here are code snippets for some common installation methods (use only one):
|
|
61
|
+
|
|
62
|
+
<details>
|
|
63
|
+
<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
|
|
64
|
+
|
|
65
|
+
**Full library**
|
|
66
|
+
|
|
67
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
68
|
+
|
|
69
|
+
**Standalone plugin**
|
|
70
|
+
|
|
71
|
+
Main branch:
|
|
72
|
+
|
|
73
|
+
```lua
|
|
74
|
+
vim.pack.add({ 'https://github.com/nvim-mini/mini.surround' })
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Stable branch:
|
|
78
|
+
|
|
79
|
+
```lua
|
|
80
|
+
vim.pack.add({
|
|
81
|
+
{ src = 'https://github.com/nvim-mini/mini.surround', version = 'stable' },
|
|
82
|
+
})
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
</details>
|
|
86
|
+
|
|
87
|
+
<details>
|
|
88
|
+
<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
|
|
89
|
+
|
|
90
|
+
**Full library**
|
|
91
|
+
|
|
92
|
+
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
|
|
93
|
+
|
|
94
|
+
**Standalone plugin**:
|
|
95
|
+
|
|
96
|
+
Main branch:
|
|
97
|
+
|
|
98
|
+
```lua
|
|
99
|
+
add('nvim-mini/mini.surround')
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Stable branch:
|
|
103
|
+
|
|
104
|
+
```lua
|
|
105
|
+
add({ source = 'nvim-mini/mini.surround', checkout = 'stable' })
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
</details>
|
|
109
|
+
|
|
110
|
+
<details>
|
|
111
|
+
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
|
|
112
|
+
|
|
113
|
+
**Full library**
|
|
114
|
+
|
|
115
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
116
|
+
|
|
117
|
+
**Standalone plugin**
|
|
118
|
+
|
|
119
|
+
Main branch:
|
|
120
|
+
|
|
121
|
+
```lua
|
|
122
|
+
{ 'nvim-mini/mini.surround', version = false },
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
Stable branch:
|
|
126
|
+
|
|
127
|
+
```lua
|
|
128
|
+
{ 'nvim-mini/mini.surround', version = '*' },
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
</details>
|
|
132
|
+
|
|
133
|
+
**Important**: don't forget to call `require('mini.surround').setup()` to enable its functionality.
|
|
134
|
+
|
|
135
|
+
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
|
|
136
|
+
|
|
137
|
+
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
|
|
138
|
+
- Install plugin in other place with shorter path.
|
|
139
|
+
|
|
140
|
+
## Default config
|
|
141
|
+
|
|
142
|
+
```lua
|
|
143
|
+
-- No need to copy this inside `setup()`. Will be used automatically.
|
|
144
|
+
{
|
|
145
|
+
-- Add custom surroundings to be used on top of builtin ones. For more
|
|
146
|
+
-- information with examples, see `:h MiniSurround.config`.
|
|
147
|
+
custom_surroundings = nil,
|
|
148
|
+
|
|
149
|
+
-- Duration (in ms) of highlight when calling `MiniSurround.highlight()`
|
|
150
|
+
highlight_duration = 500,
|
|
151
|
+
|
|
152
|
+
-- Module mappings. Use `''` (empty string) to disable one.
|
|
153
|
+
mappings = {
|
|
154
|
+
add = 'sa', -- Add surrounding in Normal and Visual modes
|
|
155
|
+
delete = 'sd', -- Delete surrounding
|
|
156
|
+
find = 'sf', -- Find surrounding (to the right)
|
|
157
|
+
find_left = 'sF', -- Find surrounding (to the left)
|
|
158
|
+
highlight = 'sh', -- Highlight surrounding
|
|
159
|
+
replace = 'sr', -- Replace surrounding
|
|
160
|
+
|
|
161
|
+
suffix_last = 'l', -- Suffix to search with "prev" method
|
|
162
|
+
suffix_next = 'n', -- Suffix to search with "next" method
|
|
163
|
+
},
|
|
164
|
+
|
|
165
|
+
-- Number of lines within which surrounding is searched
|
|
166
|
+
n_lines = 20,
|
|
167
|
+
|
|
168
|
+
-- Whether to respect selection type:
|
|
169
|
+
-- - Place surroundings on separate lines in linewise mode.
|
|
170
|
+
-- - Place surroundings on each line in blockwise mode.
|
|
171
|
+
respect_selection_type = false,
|
|
172
|
+
|
|
173
|
+
-- How to search for surrounding (first inside current line, then inside
|
|
174
|
+
-- neighborhood). One of 'cover', 'cover_or_next', 'cover_or_prev',
|
|
175
|
+
-- 'cover_or_nearest', 'next', 'prev', 'nearest'. For more details,
|
|
176
|
+
-- see `:h MiniSurround.config`.
|
|
177
|
+
search_method = 'cover',
|
|
178
|
+
|
|
179
|
+
-- Whether to disable showing non-error feedback
|
|
180
|
+
-- This also affects (purely informational) helper messages shown after
|
|
181
|
+
-- idle time if user input is required.
|
|
182
|
+
silent = false,
|
|
183
|
+
}
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
## Similar plugins
|
|
187
|
+
|
|
188
|
+
- [tpope/vim-surround](https://github.com/tpope/vim-surround)
|
|
189
|
+
- [kylechui/nvim-surround](https://github.com/kylechui/nvim-surround)
|
|
190
|
+
- [machakann/vim-sandwich](https://github.com/machakann/vim-sandwich)
|
|
@@ -0,0 +1,156 @@
|
|
|
1
|
+
<p align="center"> <img src="https://github.com/nvim-mini/assets/blob/main/logo-2/logo-tabline_readme.png?raw=true" alt="mini.tabline" style="max-width:100%;border:solid 2px"/> </p>
|
|
2
|
+
|
|
3
|
+
### Minimal and fast tabline showing listed buffers
|
|
4
|
+
|
|
5
|
+
See more details in [Features](#features) and [Documentation](../doc/mini-tabline.txt).
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
> [!NOTE]
|
|
10
|
+
> This was previously hosted at a personal `echasnovski` GitHub account. It was transferred to a dedicated organization to improve long term project stability. See more details [here](https://github.com/nvim-mini/mini.nvim/discussions/1970).
|
|
11
|
+
|
|
12
|
+
⦿ This is a part of [mini.nvim](https://nvim-mini.org/mini.nvim) library. Please use [this link](https://nvim-mini.org/mini.nvim/readmes/mini-tabline) if you want to mention this module.
|
|
13
|
+
|
|
14
|
+
⦿ All contributions (issues, pull requests, discussions, etc.) are done inside of 'mini.nvim'.
|
|
15
|
+
|
|
16
|
+
⦿ See [whole library documentation](https://nvim-mini.org/mini.nvim/doc/mini-nvim) to learn about general design principles, disable/configuration recipes, and more.
|
|
17
|
+
|
|
18
|
+
⦿ See [MiniMax](https://nvim-mini.org/MiniMax) for a full config example that uses this module.
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
If you want to help this project grow but don't know where to start, check out [contributing guides of 'mini.nvim'](https://nvim-mini.org/mini.nvim/CONTRIBUTING) or leave a Github star for 'mini.nvim' project and/or any its standalone Git repositories.
|
|
23
|
+
|
|
24
|
+
## Demo
|
|
25
|
+
|
|
26
|
+
<!-- Demo source: https://github.com/nvim-mini/assets/blob/main/demo/demo-tabline.mp4 -->
|
|
27
|
+
https://user-images.githubusercontent.com/24854248/173045373-f5bdea82-fe3e-4488-8c9a-ebba062a373c.mp4
|
|
28
|
+
|
|
29
|
+
## Features
|
|
30
|
+
|
|
31
|
+
- Buffers are listed in the order of their identifier.
|
|
32
|
+
- Different highlight groups for "states" of buffer affecting 'buffer tabs'.
|
|
33
|
+
- Buffer names are made unique by extending paths to files or appending unique identifier to buffers without name.
|
|
34
|
+
- Current buffer is displayed "optimally centered" (in center of screen while maximizing the total number of buffers shown) when there are many buffers open.
|
|
35
|
+
- 'Buffer tabs' are clickable if Neovim allows it.
|
|
36
|
+
- Extra information section in case of multiple Neovim tabpages.
|
|
37
|
+
- Truncation symbols which show if there are tabs to the left and/or right. Exact characters are taken from 'listchars' option (`precedes` and `extends` fields) and are shown only if 'list' option is enabled.
|
|
38
|
+
|
|
39
|
+
## Dependencies
|
|
40
|
+
|
|
41
|
+
For full experience needs (still works without any of suggestions):
|
|
42
|
+
|
|
43
|
+
- Enabled ['mini.icons'](https://nvim-mini.org/mini.nvim/readmes/mini-icons) module to show icons near file names. Can fall back to using [nvim-tree/nvim-web-devicons](https://github.com/nvim-tree/nvim-web-devicons) plugin.
|
|
44
|
+
|
|
45
|
+
## Installation
|
|
46
|
+
|
|
47
|
+
This plugin can be installed as part of 'mini.nvim' library (**recommended**) or as a standalone Git repository.
|
|
48
|
+
|
|
49
|
+
There are two branches to install from:
|
|
50
|
+
|
|
51
|
+
- `main` (default, **recommended**) will have latest development version of plugin. All changes since last stable release should be perceived as being in beta testing phase (meaning they already passed alpha-testing and are moderately settled).
|
|
52
|
+
- `stable` will be updated only upon releases with code tested during public beta-testing phase in `main` branch.
|
|
53
|
+
|
|
54
|
+
Here are code snippets for some common installation methods (use only one):
|
|
55
|
+
|
|
56
|
+
<details>
|
|
57
|
+
<summary><b>(Recommended)</b> With <a href="https://neovim.io/doc/user/helptag.html?tag=vim.pack">vim.pack</a> (on Neovim 0.12 and newer)</summary>
|
|
58
|
+
|
|
59
|
+
**Full library**
|
|
60
|
+
|
|
61
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
62
|
+
|
|
63
|
+
**Standalone plugin**
|
|
64
|
+
|
|
65
|
+
Main branch:
|
|
66
|
+
|
|
67
|
+
```lua
|
|
68
|
+
vim.pack.add({ 'https://github.com/nvim-mini/mini.tabline' })
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Stable branch:
|
|
72
|
+
|
|
73
|
+
```lua
|
|
74
|
+
vim.pack.add({
|
|
75
|
+
{ src = 'https://github.com/nvim-mini/mini.tabline', version = 'stable' },
|
|
76
|
+
})
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</details>
|
|
80
|
+
|
|
81
|
+
<details>
|
|
82
|
+
<summary>With <a href="https://nvim-mini.org/mini.nvim/readmes/mini-deps">mini.deps</a> (before Neovim 0.12)</summary>
|
|
83
|
+
|
|
84
|
+
**Full library**
|
|
85
|
+
|
|
86
|
+
Follow [recommended 'mini.deps' installation](https://nvim-mini.org/mini.nvim/readmes/mini-deps#installation).
|
|
87
|
+
|
|
88
|
+
**Standalone plugin**:
|
|
89
|
+
|
|
90
|
+
Main branch:
|
|
91
|
+
|
|
92
|
+
```lua
|
|
93
|
+
add('nvim-mini/mini.tabline')
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Stable branch:
|
|
97
|
+
|
|
98
|
+
```lua
|
|
99
|
+
add({ source = 'nvim-mini/mini.tabline', checkout = 'stable' })
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
</details>
|
|
103
|
+
|
|
104
|
+
<details>
|
|
105
|
+
<summary>With <a href="https://github.com/folke/lazy.nvim">folke/lazy.nvim</a></summary>
|
|
106
|
+
|
|
107
|
+
**Full library**
|
|
108
|
+
|
|
109
|
+
Follow ['mini.nvim' installation](https://nvim-mini.org/mini.nvim#installation).
|
|
110
|
+
|
|
111
|
+
**Standalone plugin**
|
|
112
|
+
|
|
113
|
+
Main branch:
|
|
114
|
+
|
|
115
|
+
```lua
|
|
116
|
+
{ 'nvim-mini/mini.tabline', version = false },
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
Stable branch:
|
|
120
|
+
|
|
121
|
+
```lua
|
|
122
|
+
{ 'nvim-mini/mini.tabline', version = '*' },
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
</details>
|
|
126
|
+
|
|
127
|
+
**Important**: don't forget to call `require('mini.tabline').setup()` to enable its functionality.
|
|
128
|
+
|
|
129
|
+
**Note**: if you are on Windows, there might be problems with too long file paths (like `error: unable to create file <some file name>: Filename too long`). Try doing one of the following:
|
|
130
|
+
|
|
131
|
+
- Enable corresponding git global config value: `git config --system core.longpaths true`. Then try to reinstall.
|
|
132
|
+
- Install plugin in other place with shorter path.
|
|
133
|
+
|
|
134
|
+
## Default config
|
|
135
|
+
|
|
136
|
+
```lua
|
|
137
|
+
-- No need to copy this inside `setup()`. Will be used automatically.
|
|
138
|
+
{
|
|
139
|
+
-- Whether to show file icons (requires 'mini.icons')
|
|
140
|
+
show_icons = true,
|
|
141
|
+
|
|
142
|
+
-- Function which formats the tab label
|
|
143
|
+
-- By default surrounds with space and possibly prepends with icon
|
|
144
|
+
format = nil,
|
|
145
|
+
|
|
146
|
+
-- Where to show tabpage section in case of multiple vim tabpages.
|
|
147
|
+
-- One of 'left', 'right', 'none'.
|
|
148
|
+
tabpage_section = 'left',
|
|
149
|
+
}
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Similar plugins
|
|
153
|
+
|
|
154
|
+
- [akinsho/bufferline.nvim](https://github.com/akinsho/bufferline.nvim)
|
|
155
|
+
- [romgrk/barbar.nvim](https://github.com/romgrk/barbar.nvim)
|
|
156
|
+
- [ap/vim-buftabline](https://github.com/ap/vim-buftabline)
|