Permalink
Switch branches/tags
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
85 lines (56 sloc) 3.11 KB

Pug

General utility plugin management

Pug is a general-purpose plugin manager for command-line utilities. This currently includes Vim and ZSH plugins, but can be expanded easily for other shells or programs.

But why?

Previously I used git submodules for things that I cared about - but this made it difficult to add and remove dependencies. Other solutions like Oh My Zsh, Pathogen, and Vundle allow for managing plugins but include more features than I am looking for. This makes the goals for Pug basically:

  • Self contained: Only require a shell and git.
  • Minimal magic: Do what's expected.
  • Non-destructive: Don't break how config files and other plugins function.
  • Quick experimentation: Allow for quickly adding/ removing plugins.
  • Consistent: Install plugins from a config file reliably without user interaction.

Install

Install Pug automatically:

curl https://raw.githubusercontent.com/javanut13/pug/master/install.sh | bash

Or if you don't like piping into Bash:

git clone https://github.com/javanut13/pug.git
cd pug
./install.sh

This adds the pug script into /usr/local/bin - you can put it anywhere in your $PATH if that suits you better. Installers for Vim and ZSH are copied to ~/.pug/installers. This is where you can add your own installers (for another utility), just make sure it's named UTILITY-install.

Usage with a Config File

Somewhere safe (like your dotfiles repo) add a deps.pug file. This will specify the dependencies you want to load. For example, my config looks like this:

#!/usr/local/bin/pug load

zsh from: https://github.com/zsh-users/zsh-autosuggestions.git
zsh github: zsh-users/zsh-syntax-highlighting
vim github: ctrlpvim/ctrlp.vim
vim github: tpope/vim-fireplace
vim github: guns/vim-sexp

This is a shell script that is loaded by Pug, which allows it to have some helpers for specifying the dependencies. Currently these are all in the format type from: url including abbreviations for GitHub and GitLab URLs.

Manual Usage

Add a dependency:

pug get TYPE GIT_CLONE_URL [MAIN_FILE?]
# eg to install ctrlp.vim:
pug get vim https://github.com/ctrlpvim/ctrlp.vim.git

The MAIN_FILE argument is only needed if the file to be sourced is not in the format $PLUGIN_NAME.$TYPE - e.g: zsh-autosuggestions.zsh.

The first time you install a dependency of a certain type, you will need to add a snippet to load the Pug file for that type. For example for ZSH this needs to be added to your .zshrc file:

# Somewhere in ~/.zshrc
source "$HOME/.pug/source/zsh/pug"

You can update all plugins with:

pug update

All of your sources - everything stored in .pug/source - can be removed with:

pug wipe

Installers

An installer should take the name of a plugin as an argument and echo the code necessary to load it into the correct Pug file in the .pug/source directory. Look at the default installers for examples of how they work.