olacin/telescope-cc.nvim

A Telescope integration of Conventional Commits.

telescope-cc.nvim

A Telescope integration of Conventional Commits.

Installation

# vim-plug
Plug 'olacin/telescope-cc.nvim'

# packer
use 'olacin/telescope-cc.nvim'

# lazy.nvim
{ "olacin/telescope-cc.nvim" }

Usage

# As a command
:Telescope conventional_commits

# As a lua function
require('telescope').extensions.conventional_commits.conventional_commits()

Configuration

You can customize action on selection within Telescope setup() function.

telescope.setup({
    ...
    extensions = {
        conventional_commits = {
            theme = "ivy", -- custom theme
            action = function(entry)
                -- entry = {
                --     display = "feat       A new feature",
                --     index = 7,
                --     ordinal = "feat",
                --     value = feat"
                -- }
                vim.print(entry)
            end,
            include_body_and_footer = true, -- Add prompts for commit body and footer
        },
    },
})

telescope.load_extension("conventional_commits")

Default action

Default action is cc_actions.commit and can be found here.

Include body and footer

The easiest way is to add include_body_and_footer within telescope setup like shown above.

If however you wish to do something more advanced, you can create a command to initiate the extension with the include_body_and_footer flag.

local function create_conventional_commit()
    local actions = require("telescope._extensions.conventional_commits.actions")
    local picker = require("telescope._extensions.conventional_commits.picker")
    local themes = require("telescope.themes")

    -- if you use the picker directly you have to provide your theme manually
    picker({
        action = actions.prompt,
        include_body_and_footer = true,
        -- theme = themes["get_ivy"]() -- ivy theme
    })
end

vim.keymap.set(
  "n",
  "cc",
  create_conventional_commit,
  { desc = "Create conventional commit" }
)

telescope-cc.nvim's Issues

Dropdown theme!

Hello @olacin , I had been implementing the plugin, but the first page works well, however, in the commands (scope, commit_message) are called within cmd!... Maybe he was implementing my configuration wrong.
Screencast from 2024-05-21 15-59-48.webm

theme option not working

For some reason unknown to me, all telescope extensions work with the theme option, except telescope-cc.
Everything in the extension seems to work as it should, except this option.

This is my configuration:

{
  defaults = {
        ...
  },

  extensions = {
        fzf = {
          fuzzy = true,
          override_generic_sorter = true,
          override_file_sorter = true,
          case_mode = "smart_case",
        },
        conventional_commits = {
          theme = "dropdown",
          action = function()
            local actions = require "telescope._extensions.conventional_commits.actions"
            return actions.prompt
          end,
          include_body_and_footer = true,
        },
        ["ui-select"] = {
          require("telescope.themes").get_dropdown {},
        },
        file_browser = {
          theme = "dropdown",
          hijack_netrw = true,
        },
  },
}

Edit: It works fine running :Telescope conventional_commits theme=dropdown

Fails when used with `dressing.nvim`

dressing.nvim replaces native vim.ui.input.

When plugin is called, two input windows are overlaid or even replaced and nothing happens after entering.

It seems like it's impossible to have two dressing input windows at the time.

Implement gitmojis

Please add (optionnaly) gitmojis, https://gitmoji.dev/

Example Screencast?

This looks interesting can you post a short showcase? Would help me understand how this works, if I can do without it or if this will boost my productivity.