Skip to content

A simple ZSH plugin for maintaining multiple Neovim configurations with NVIM_APPNAME

License

Notifications You must be signed in to change notification settings

mehalter/zsh-nvim-appname

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 

Repository files navigation

zsh-nvim-appname

A simple ZSH plugin for maintaining multiple Neovim configurations with NVIM_APPNAME with full tab completion of available flags, available neovim applications, and neovim arguments/flags.

Requirements: Neovim v0.9+

Short Demo

Recorded Demo

Usage

This creates a new command nvapp which takes an appname of a folder named nvim_<appname> in your $XDG_CONFIG_HOME and passes it into neovim using the NVIM_APPNAME environment variable.

Usage:
  nvapp [-h|--help] [-c|--clean] [-d|--delete] <nvapp_name> ...

Options:
  -h|--help     Display this help text and exit
  -c|--clean    Clean the installation files
  -d|--delete   Fully delete the neovim app
  <appname>     The name of the neovim app in $XDG_CONFIG_HOME
                (Example. ~/.config/nvim_<appname>)
  ...           any arguments passed to neovim

Installation

Antigen

  1. Add the following to your .zshrc:

    antigen bundle mehalter/zsh-nvim-appname
  2. Start a new terminal session.

Oh My Zsh

  1. Clone this repository into $ZSH_CUSTOM/plugins (by default ~/.oh-my-zsh/custom/plugins)

    git clone https://github.com/mehalter/zsh-nvim-appname ${ZSH_CUSTOM:-~/.oh-my-zsh/custom}/plugins/zsh-nvim-appname
  2. Add the plugin to the list of plugins for Oh My Zsh to load (inside ~/.zshrc):

    plugins=(
        # other plugins...
        zsh-nvim-appname
    )
  3. Start a new terminal session.

Manual (Git Clone)

  1. Clone this repository somewhere on your machine. This guide will assume ~/.zsh/zsh-autosuggestions.

    git clone https://github.com/mehalter/zsh-nvim-appname ~/.zsh/zsh-nvim-appname
  2. Add the following to your .zshrc:

    source ~/.zsh/zsh-nvim-appname/zsh-nvim-appname.plugin.zsh
    fpath+= ~/.zsh/zsh-nvim-appname
  3. Start a new terminal session.