README.md

repos.nvim

repos.nvim is a simple Neovim plugin for per-repository settings.

Installation

vim-plug

Plug 'TymekDev/repos.nvim'

packer

use "TymekDev/repos.nvim"

Usage

setup() function stores your config and executes callbacks immediately. If you would like to restore config to defaults, then run setup() with no arguments or with an empty table ({}).

require("repos").setup({
  remote = "origin", -- Remote used for matching callbacks against it
  plain = true,      -- Perform plain text matching (true) or regex matching (false)
  callbacks = {},    -- Callbacks with keys to match against remote URL
})

If you would like to execute callbacks again, then execute run() function (it uses saved configuration).

Notes:

• Multiple callbacks can be executed for a single repository
• callbacks will run only in a git worktree, i.e. not in the root of a bare repo

Example

require("repos").setup({
  callbacks = {
    -- Runs on a single repository due to the specific key
    ["[email protected]:TymekDev/repos.nvim"] = function(root)
      print("Repository is located at: " .. root)
    end,
    -- Possibly runs on multiple repositories on different platforms (e.g. GitHub and GitLab)
    ["TymekDev/dotfiles"] = function(_)
      vim.opt.winwidth = 20
    end,
    -- Runs on any SSH repository
    ["git@"] = function(_)
      print("This repo has SSH remote")
    end,
  },
})

This config will print the following for repo with [email protected]:TymekDev/repos.nvim remote:

Repository is located at: <path to repository>
This repo has SSH remote