Home

Awesome

<div align = "center"> <h1><a href="https://2kabhishek.github.io/co-author.nvim">co-author.nvim</a></h1> <a href="https://github.com/2KAbhishek/co-author.nvim/blob/main/LICENSE"> <img alt="License" src="https://img.shields.io/github/license/2kabhishek/co-author.nvim?style=flat&color=eee&label="> </a> <a href="https://github.com/2KAbhishek/co-author.nvim/graphs/contributors"> <img alt="People" src="https://img.shields.io/github/contributors/2kabhishek/co-author.nvim?style=flat&color=ffaaf2&label=People"> </a> <a href="https://github.com/2KAbhishek/co-author.nvim/stargazers"> <img alt="Stars" src="https://img.shields.io/github/stars/2kabhishek/co-author.nvim?style=flat&color=98c379&label=Stars"></a> <a href="https://github.com/2KAbhishek/co-author.nvim/network/members"> <img alt="Forks" src="https://img.shields.io/github/forks/2kabhishek/co-author.nvim?style=flat&color=66a8e0&label=Forks"> </a> <a href="https://github.com/2KAbhishek/co-author.nvim/watchers"> <img alt="Watches" src="https://img.shields.io/github/watchers/2kabhishek/co-author.nvim?style=flat&color=f5d08b&label=Watches"> </a> <a href="https://github.com/2KAbhishek/co-author.nvim/pulse"> <img alt="Last Updated" src="https://img.shields.io/github/last-commit/2kabhishek/co-author.nvim?style=flat&color=e06c75&label="> </a> <h3>Quickly add co-authors to commits 💻🪄</h3> <figure> <img src= "images/screenshot.png" alt="co-author.nvim Demo"> <br/> <figcaption>co-author.nvim screenshot</figcaption> </figure> </div>

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:

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

What's next

You tell me!

Hit the ⭐ button if you found this useful.

More Info

<div align="center">

<a href="https://github.com/2KAbhishek/co-author.nvim">Source</a> | <a href="https://2kabhishek.github.io/co-author.nvim">Website</a>

</div>