https://github.com/disrupted/blink-cmp-conventional-commits

Conventional Commits source for blink.cmp
https://github.com/disrupted/blink-cmp-conventional-commits

Last synced: about 1 year ago
JSON representation

Conventional Commits source for blink.cmp

• Host: GitHub
• URL: https://github.com/disrupted/blink-cmp-conventional-commits
• Owner: disrupted
• Created: 2025-02-18T23:30:24.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-02-18T23:30:34.000Z (about 1 year ago)
• Last Synced: 2025-04-01T19:03:22.108Z (about 1 year ago)
• Language: Lua
• Size: 1.95 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-neovim-sorted - disrupted/blink-cmp-conventional-commits
• awesome-neovim - disrupted/blink-cmp-conventional-commits - `blink.cmp` source for [Conventional Commits](https://www.conventionalcommits.org/). (Completion / Diagnostics)

README

          
# blink-cmp-conventional-commits

[Conventional Commits](https://www.conventionalcommits.org) source for [blink.cmp](https://github.com/Saghen/blink.cmp) completion plugin.

It provides the different types of conventional commits when writing a new Git commit message. Mainly because I am just starting to adopt conventional commits and can never remember the commonly used types.

![screenshot showing completion in gitcommit buffer](https://github.com/user-attachments/assets/af851953-acf5-4744-9f2c-340add739ba7)

## Installation

example using [Lazy](https://github.com/folke/lazy.nvim) plugin manager

```lua

{

    'saghen/blink.cmp',

    dependencies = {

        { 'disrupted/blink-cmp-conventional-commits' },

    },

    opts = {

        sources = {

            default = {

                'conventional_commits', -- add it to the list

                'lsp',

                'buffer',

                'path',

            },

            providers = {

                conventional_commits = {

                    name = 'Conventional Commits',

                    module = 'blink-cmp-conventional-commits',

                    enabled = function()

                        return vim.bo.filetype == 'gitcommit'

                    end,

                    ---@module 'blink-cmp-conventional-commits'

                    ---@type blink-cmp-conventional-commits.Options

                    opts = {}, -- none so far

                },

            },

        },

    },

}

```