Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.68 KB

README.md

File metadata and controls

66 lines (43 loc) · 1.68 KB
Raw

FunkTree


The FunkTree plugin simplifies navigation through objects and key structures in files. It's based on the awesome telescope.nvim plugin that works as a frontend for the parsing result of the analyzed file.

Currently, FunkTree works with:

Language Level
Lua Basic
Python Advanced
JavaScript Basic

FunkTree enable users to navigate for example among classes, methods, and functions within the open file.

Installation

Packer

With packer.nvim

use("marcosalvalaggio/funktree")

remap command:

vim.api.nvim_set_keymap('n', '<leader>k', ':Funk<CR>', {noremap=true})

Lazy

With lazy.nvim

return {
  "marcosalvalaggio/funktree",
  dependencies = {"nvim-telescope/telescope.nvim"},
  config = function()
    vim.api.nvim_set_keymap('n', '<leader>k', ':Funk<CR>', {noremap=true})
  end
}

Usage

FunkTree is composed by a single command:

:Funk

The :Funk command opens a new buffer containing the names of the key structures present in the analyzed file.

Moving the cursor to the line in the FunkTree buffer and pressing "Enter" closes the FunkTree buffer and positions the cursor in the original buffer at the lines indicated as "line" in the FunkTree buffer. If you want to close the FunkTree buffer simply press esc on the keyboard.