Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adamtabrams/flatnvim
A simple tool that prevents nested Neovim instances
https://github.com/adamtabrams/flatnvim
cli neovim nvim terminal vim
Last synced: 27 days ago
JSON representation
A simple tool that prevents nested Neovim instances
- Host: GitHub
- URL: https://github.com/adamtabrams/flatnvim
- Owner: adamtabrams
- License: gpl-3.0
- Created: 2021-09-15T20:28:57.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-06T03:43:03.000Z (about 2 years ago)
- Last Synced: 2024-10-03T08:07:22.446Z (about 1 month ago)
- Topics: cli, neovim, nvim, terminal, vim
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 19
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# About
The goal of `flatnvim` is to make it easy to use [Neovim](https://neovim.io/)'s
[terminal emulator](https://neovim.io/doc/user/nvim_terminal_emulator.html).
When you open files from within the Neovim terminal, `flatnvim` will automatically add them
to the current instance instead of creating a new nested one.
Now you can easily use all your favorite command line programs inside Neovim.
# Usage
## Clone & Build
You'll first need the `flatnvim` binary on you system.
```sh
git clone https://github.com/adamtabrams/flatnvim.git
cd flatnvim
./build.sh
```
## Environment Variables
There are 4 environment variables `flatnvim` can use.
Add them to the config file for your shell (.bashrc, .profile, .zprofile, etc).
### Required: set the path to the actual editor.
```sh
export FLATNVIM_EDITOR="nvim"
```
- When `flatnvim` is called from your regular terminal, it will just pass arguments to this editor.
### Recommended: set the path to the `flatnvim` binary as your default terminal editor.
```sh
export EDITOR="$HOME/repos/flatnvim/bin/flatnvim"
```
- If you don't know what this should be, use the path printed by the build.sh script.
- In addition, you can make an alias to `flatnvim`: `alias vim="$EDITOR`
### Optional: set a log file for `flatnvim` to use.
```sh
export FLATNVIM_LOGFILE="$HOME/repos/flatnvim/log.txt"
```
- If this is not set, any error messages are just printed.
### Optional: set an extra Neovim command to be executed when preventing nested instances.
```sh
export FLATNVIM_EXTRA_COMMAND="echo 'it works' | sleep"
```
- Just in case you want `flatnvim` to do something extra before it opens files in the parent instance.
## Neovim Configs
### Recommended: disable status line when in terminal mode.
```viml
autocmd TermOpen * setlocal laststatus=0 noshowmode noruler
\| autocmd TermClose * setlocal laststatus=2 showmode ruler
```
### Recommended: skip exit prompt if terminal commands were successful.
```viml
autocmd TermClose * if !v:event.status | exe 'bdelete! '..expand('') | endif
```
### Optional: fix issue with Airline that occurs when window focus is lost.
```viml
autocmd TermLeave * AirlineRefresh
```
## Neovim Function
Adding this function to your Neovim config makes it easier to access the terminal and specific command line programs.
```viml
function! TempTerm(...)
let command = get(a:, 1)
exe "terminal ".command
return ""
endfunction
```
```viml
nnoremap gt :call TempTerm(" ")
nnoremap gL :call TempTerm("lazygit")
nnoremap gl :call TempTerm("lf")
```