KamaiZen

KamaiZen A language server for Kamailio configuration files.

Tip

It uses grammar based on tree-sitter-kamailio-cfg You can use that if you just want to have syntax highlighting.

Features

Demo Video

Watch a demo of KamaiZen in action:

demo.mp4

Code completion

• Variables
  • AVP
  • Local variables (vars)
  • Dialog variables
• Core Cookbook items
• exported functions
• Modules
• SIP Keywords
• Parameters

Diagnostics

• Syntax Errors -- Buggy (requires re-work on the parser, you can disable it by setting enableDiagnostics to false)
• Invalid statements
• Unreachable code
• Assignment Errors

Hover

• Show documentation for functions
• Show documentation for variables
• Core Cookbook items
• Variables

Code navigation

• Go to definition for routes: This currently works with the routes defined in current file.

Code Formatting

• Basic indentation

---

Note

This is a work in progress, and not all features are available yet and might contain bugs.

Installation

Neovim

with lazy.nvim

Note

Make sure to have go 1.24 installed.

{
  'IbrahimShahzad/KamaiZen',
  branch = 'master',
  -- or
  -- version = 'V0.1.2',
  build = 'go build',
  opts = {
    settings = {
      kamaizen = {
        enableDeprecatedCommentHint = false, -- to enable hints for '#' comments
        enableDiagnostics = true, -- to enable/disable diagnostics
        KamailioSourcePath = '/path/to/kamailio', -- or use current dir vim.fn.getcwd()
        loglevel = 3,
      },
    },
    on_attach = function(client, bufnr)
      if client then
        print('Attaching to: ' .. client.name .. ' attached to buffer ' .. bufnr)
        ------------------------------------------------------------------
        local bufkeymap = function(mode, keys, func, desc)
          vim.keymap.set(mode, keys, func, { buffer = bufnr, noremap = true, silent = true, desc = 'LSP: ' .. desc })
        end
        -- Diagnostic keymaps
        bufkeymap('n', '[d', vim.diagnostic.jump { count = -1, float = true }, 'Go to previous [D]iagnostic message')
        bufkeymap('n', ']d', vim.diagnostic.jump { count = 1, float = true }, 'Go to next [D]iagnostic message')
        bufkeymap('n', 'e', vim.diagnostic.open_float, 'Show diagnostic [E]rror messages')
        bufkeymap('n', 'q', vim.diagnostic.setloclist, 'Open diagnostic [Q]uickfix list')
        --
        if client.server_capabilities.hoverProvider then
          bufkeymap('n', 'K', vim.lsp.buf.hover, 'Hover Documentation')
        end
        if client.server_capabilities.definitionProvider then
          bufkeymap('n', 'gd', require('telescope.builtin').lsp_definitions, '[G]oto [D]efinition')
        end
      end
    end,
  },
}

How To Contrribute

Contributions are welcome! To help improve KamaiZen, please follow these guidelines:

1. Fork the Repository:

Click the "Fork" button on the GitHub repository page to create your own copy.

2. Clone Your Fork:

git clone https://github.com/<your-username>/KamaiZen.git
cd KamaiZen

3. Create a New Branch: Create a branch for your feature or bugfix:

git checkout -b feature/your-feature-name

4. Make Your Changes:

Ensure your changes follow the project's code style. Write tests if applicable.

5. Commit and Push:

Commit your changes with a descriptive message:

git add .
git commit -m "Description of your change"
git push origin feature/your-feature-name

6. Submit a Pull Request:

Open a pull request against the main branch of the original repository. Please provide a clear description of your changes and reference any relevant issues.

7. Code Reviews and Feedback:

Your pull request will be reviewed. Be prepared to make adjustments based on feedback.

For any questions or suggestions, please open an issue on GitHub.

Future Plans

These are the features that are planned to be implemented in the future:

• scratch-parser implementation ?
• LSP for Workspace Folder instead of open file
• Code navigation
  • Find references for routes
• Code Actions
  • Add missing modules
  • string evaluations
  • regex check
• Snippets
  • Route snippets
  • Module snippets
  • Ifblock snippets
  • loop snippets
  • switch snippets
• Code formatting
• Code folding
• Diagnostics
  • Function calls from non-loaded modules
  • Unused variables
  • Unused modules
  • Unused parameters
• Other Editors
  • Neovim
  • VSCode
  • CLion

Note

These are not in any particular order and might change in the future.

---

Feel free to contribute or open issues if you have suggestions or encounter problems!

---