2KAbhishek/co-author.nvim

github github
git
stars 19
issues 0
subscribers 2
forks 1
CREATED

2022-12-21

UPDATED

30 days ago


What is this

How many times have you been pairing on a feature and then when committing you had to manually paste their details for adding a Co-author to the commit?

This plugin automatically fetches author details from the repo's commit history and then adds it to your commit message.

It shows you a list of all the unique authors in your current repo on a nice fuzzy searchable list.

co-author.nvim automatically works with telescope and presents the list in a nice fuzzy searchable UI.

Here's a demo video for a quick walkthrough.

Inspiration

Noticed something similar on a co-workers using IntelliJ, and I wanted it!

Prerequisites

Before you begin, ensure you have met the following requirements:

  • You have installed the latest version of neovim

These two plugins are optional but highly recommended for a smoother user experience.

Installing co-author.nvim

To get co-author.nvim, add the following to your plugin list:

-- Lazy
{
    '2kabhishek/co-author.nvim',
    dependencies = {
        'stevearc/dressing.nvim',
        'nvim-telescope/telescope.nvim',
    },
    cmd = {'CoAuthor'},
},

-- Packer
use '2kabhishek/co-author.nvim'

Using co-author.nvim

co-author.nvim adds a :CoAuthor command that will show you the list of unique co authors who have already contributed to the current git repo.

You can add your custom bindings for the command :CoAuthor, the recommended keybinding is <leader>gC.

check :help co-author for more details.

NOTE: By default there are no configured keybindings.

How it was built

co-author.nvim was built using neovim, lua

Challenges faced

Figuring out vim's rtp was tricky initially.

What I learned

  • Learned about nvim plugin ecosystem
  • Explored vim APIs

What's next

You tell me!

Hit the ⭐ button if you found this useful.

More Info

Source | Website