Skip to main content

Neovim Leader Menu

How to Make a Menu in Neovim

How to Make a Menu in Neovim

In Neovim leader key pull up a menu, it is the which-key plugin. I saw many videos where people use a menu in Neovim. They just press the leader key and a menu pops up. I wanted to have that too. I wondered which component of Neovim is responsible for that. I found out that it is the which-key plugin: https://github.com/folke/which-key.nvim

Cases where a menu is useful in Neovim

Neovim has already a bunch of "commands". Why would I need a menu? Useful when you want to group a set of commands you often use together. Also helpful when the command name is hard to remember: use the leader key and a combo of keys to get to the command.

How to write a menu tree in Neovim configuration

I use code-ai.nvim plugin to call AI to write code for me. I have defined a bunch of commands in my configuration file. 

      
  {  "natixgroup/code-ai.nvim",
    dependencies = 'nvim-lua/plenary.nvim',
    opts = {
      prompts = {
        typescript_node_backend = {
          command = 'AITypescriptNodeBackend',
          instruction_tpl = 'Act as a Typescript software developer writing a Node.js backend application. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
        javascript_bare= {
          command = 'AIJavascriptVanilla',
          instruction_tpl = 'Act as a Vanilla Javascript developer writing a Javascript Web application. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
        javascript_firefox= {
          command = 'AIJavascriptFirefox',
          instruction_tpl = 'Act as a Javascript Firefox extension developer writing a Javascript Firefox extension. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
        javascript_react = {
          command = 'AIJavascriptReact',
          instruction_tpl = 'Act as a Javascript software developer writing a React application. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
        typescript_react = {
          command = 'AITypescriptReact',
          instruction_tpl = 'Act as a Typescript software developer writing a React application. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
        php_symfony = {
          command = 'AIPHPSymfony',
          instruction_tpl = 'Act as a PHP software developer using the Symfony framework. Format the answer using Markdown.',
          prompt_tpl= '${input}',
        },
    }

As you see I have a bunch of commands. In reality, I have more than that. It becomes necessary to categorize them. I have created a menu tree in my configuration file. 

      
if pcall(require, 'which-key') then
  local wk = require("which-key")
  wk.register({
    a = {
      name = "CodeAI",
      b = { ":'<,'>AIBash<CR>", "Bash" },
      l = { ":'<,'>AIBlogger<CR>", "Blogger" },
      c = { ":'<,'>AILuaNeovimConfiguration<CR>", "Lua Neovim configuration" },
      j = {
        name = "JavaScript",
        v = { ":'<,'>AIJavascriptVanilla<CR>", "Vanilla JS" },
        f = { ":'<,'>AIJavascriptFirefox<CR>", "Firefox Extension" },
        r = { ":'<,'>AIJavascriptReact<CR>", "React JS" },
      },
      t = {
        name = "TypeScript",
        n = { ":'<,'>AITypescriptNodeBackend<CR>", "Node.js Backend" },
        r = { ":'<,'>AITypescriptReact<CR>", "React" },
        e = { ":'<,'>AITypescriptEJS<CR>", "EJS Web App" },
      },
      p = {
        name = "PHP",
        b = { ":'<,'>AIPHPBare<CR>", "Bare PHP" },
        s = { ":'<,'>AIPHPSymfony<CR>", "Symfony" },
      },
      d = { ":'<,'>AIDockerfile<CR>", "Dockerfile" },
      y = {
        name = "YAML",
        k = { ":'<,'>AIYAMLKubernetesAdmin<CR>", "Kubernetes Admin" },
        s = { ":'<,'>AIYAMLSymfonyConfiguration<CR>", "Symfony Config" },
      },
      n = {
        name = "Neovim",
        p = { ":'<,'>AILuaNeovimPlugin<CR>", "Plugin Development" },
        c = { ":'<,'>AILuaNeovimConfiguration<CR>", "Configuration" },
      },
      a = {
        name = "Asterisk",
        v20 = { ":'<,'>AIAsterisk20<CR>", "Version 20" },
        v18 = { ":'<,'>AIAsterisk18<CR>", "Version 18" },
      },
    }
  }, { prefix = "<leader>", mode = "x" })  -- Ensure this is in visual mode
end

Popular posts from this blog

Undefined global vim

Defining vim as global outside of Neovim When developing plugins for Neovim, particularly in Lua, developers often encounter the "Undefined global vim" warning. This warning can be a nuisance and disrupt the development workflow. However, there is a straightforward solution to this problem by configuring the Lua Language Server Protocol (LSP) to recognize 'vim' as a global variable. Getting "Undefined global vim" warning when developing Neovim plugin While developing Neovim plugins using Lua, the Lua language server might not recognize the 'vim' namespace by default. This leads to warnings about 'vim' being an undefined global variable. These warnings are not just annoying but can also clutter the development environment with unnecessary alerts, potentially hiding other important warnings or errors. Defining vim as global in Lua LSP configuration to get rid of the warning To resolve the "Undefined global vi...
Read more

npm run build base-href

Using NPM to specify base-href When building an Angular application, people usually use "ng" and pass arguments to that invocation. Typically, when wanting to hard code "base-href" in "index.html", one will issue: ng build --base-href='https://ngx.rktmb.org/foo' I used to build my angular apps through Bamboo or Jenkins and they have a "npm" plugin. I got the habit to build the application with "npm run build" before deploying it. But the development team once asked me to set the "--base-href='https://ngx.rktmb.org/foo'" parameter. npm run build --base-href='https://ngx.rktmb.org/foo did not set the base href in indext.html After looking for a while, I found https://github.com/angular/angular-cli/issues/13560 where it says: You need to use −− to pass arguments to npm scripts. This did the job! The command to issue is then: npm run build -- --base-href='https://ngx.rktmb.org/foo...
Read more

CopilotChat GlobFile Configuration

CopilotChat GlobFile Configuration Want to feed multiple files into GitHub Copilot Chat from Neovim without listing each one manually? Let's add a tiny feature that does exactly that: a file glob that includes full file contents . In this post, we'll walk through what CopilotChat.nvim offers out of the box, why the missing piece matters, and how to implement a custom #file_glob:<pattern> function to include the contents of all files matching a glob. Using Copilot Chat with Neovim CopilotChat.nvim brings GitHub Copilot's chat right into your editing flow. No context switching, no browser hopping — just type your prompt in a Neovim buffer and let the AI help you refactor code, write tests, or explain tricky functions. You can open the chat (for example) with a command like :CopilotChat , then provide extra context using built-in functions. That “extra context” is where the magic really happens. Built-in functio...
Read more