bub.nvim

What? • Requirements • Install • Usage

Batman's Utility Belt (bub) for Neovim.

What?

bub.nvim is a collection of utilities for Neovim.

If Batman had Neovim, this is what his utility belt would look like.

Requirements

• Neovim (tested with 0.11.5, other versions may work as well)

Install

Please use release tags when installing the plugin to ensure compatibility and stability.

The main branch may contain breaking changes and isn't guaranteed to be stable.

Lazy.nvim

See: lazy.nvim

{
  'mistweaverco/bub.nvim',
  version = 'v1.0.1',
},

Packer.nvim

See: packer.nvim

use {
  'mistweaverco/bub.nvim',
  tag = 'v1.0.1',
})

Neovim built-in package manager

vim.pack.add({
  src = 'https://github.com/mistweaverco/bub.nvim.git',
  version = 'v1.0.1',
})

Usage

It's a collection of utilities for Neovim.

You can require each utility module like this:

local fs_exists = require('bub.utils.fs.exists')

or a parent module like this:

local fs = require('bub.utils.fs')

If you want to have access to all utilities at once, you can require the main module:

local bub = require('bub')

You can see a real-world usage example in our own test-suite: here.