https://github.com/2KAbhishek/co-author.nvim

Quickly add co-authors to commits 💻🪄
https://github.com/2KAbhishek/co-author.nvim

coauthor git neovim nvim pairing plugin utility vim

Last synced: 11 days ago
JSON representation

Quickly add co-authors to commits 💻🪄

• Host: GitHub
• URL: https://github.com/2KAbhishek/co-author.nvim
• Owner: 2KAbhishek
• License: gpl-3.0
• Created: 2022-12-21T04:26:18.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-19T06:24:01.000Z (4 months ago)
• Last Synced: 2024-07-31T20:51:23.663Z (3 months ago)
• Topics: coauthor, git, neovim, nvim, pairing, plugin, utility, vim
• Language: Lua
• Homepage:
• Size: 622 KB
• Stars: 21
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-neovim - 2KAbhishek/co-author.nvim - Quickly add co-authors to commits. (Git / Quickfix)

README

        


co-author.nvim




 



 







 



 



 

Quickly add co-authors to commits 💻🪄


  

  


  co-author.nvim screenshot



## 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](https://youtu.be/mBLLyOLwSf4?si=2Bdw900ROLp63LEg) 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.

- [dressing.nvim](https://github.com/stevearc/dressing.nvim) — for prettier select UI

- [telescope](https://github.com/nvim-telescope/telescope.nvim) — for fuzzy searching in list

## Installing co-author.nvim

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

```lua

-- 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 `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