Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/jkeresman01/java-method-search.nvim

Neovim plugin that makes navigation and searching through Java methods a lot easier.
https://github.com/jkeresman01/java-method-search.nvim

java linux neovim neovim-plugin nvim nvim-plugin vim

Last synced: 2 days ago
JSON representation

Neovim plugin that makes navigation and searching through Java methods a lot easier.

Host: GitHub
URL: https://github.com/jkeresman01/java-method-search.nvim
Owner: jkeresman01
License: gpl-3.0
Created: 2024-07-14T12:07:38.000Z (6 months ago)
Default Branch: main
Last Pushed: 2024-10-17T14:20:41.000Z (3 months ago)
Last Synced: 2024-10-19T11:57:46.150Z (3 months ago)
Topics: java, linux, neovim, neovim-plugin, nvim, nvim-plugin, vim
Language: Lua
Homepage:
Size: 45.9 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        


  
java-method-search.nvim

  Neovim plugin that makes navigation and searching through Java methods a lot easier.


[![Lua](https://img.shields.io/badge/Lua-blue.svg?style=for-the-badge&logo=lua)](http://www.lua.org)

[![Neovim 0.10](https://img.shields.io/badge/Neovim%200.10-green.svg?style=for-the-badge&logo=neovim)](https://neovim.io)

![Work In Progress](https://img.shields.io/badge/Work%20In%20Progress-orange?style=for-the-badge)



## Table of Contents

- [The problem](#problem)

- [The solution](#solution)

- [Functionalities](#functionalities)

- [Installation](#installation)

    - [Vim-Plug](#vimplug)

    - [Packer](#packer)

- [Commands](#commands)

- [Setup](#setup)

## The problem :warning:   ##

You open your favorite editor, Neovim, and navigate to a new Java class you're unfamiliar with. You want to preview all available methods, easily search through them, and navigate to each one for exploration, but this seems impossible. 

## The solution :trophy:   ##

This Neovim plugin integrates with telescope.nvim and nvim-treesitter to enable interactive fuzzy finding and navigation through Java methods within a file.

[![asciicast](https://asciinema.org/a/0V6bFRxWP7EZNorV8Z0FPfuss.svg)](https://asciinema.org/a/0V6bFRxWP7EZNorV8Z0FPfuss)

## Repository structure :open_file_folder:  ##

```bash

java-method-search.nvim/

├── LICENSE

├── lua

│   └── java-method-search

│       ├── commands.lua         # Commands exposed to Neovim

│       ├── init.lu              # Plugin entry pint

│       ├── java_method.lu       # Mostly UI logic (.. telescope)

│       └── util.lu              # Utility functions

└── README.md

```

### Functionalities :pick:  ###

- [x] Fuzzy find trough all java methods in a class

- [x] Easily navigate to all java methods in a class

- [x] Preview all java methods in a class

### Installation :star:   ###

* Make sure you have Neovim v0.9.0 or greater. :exclamation:

* Dependecies: treesiter && telescope && plenary (telescope dep)

* Install using you plugin manager

#### Vim plug :star:   ####

```lua

Plug 'nvim-lua/plenary.nvim'

Plug 'nvim-telescope/telescope.nvim'

Plug 'nvim-treesitter/nvim-treesitter'

Plug 'jkeresman01/java-method-search.nvim'

```

#### Packer :star:   ####

```lua

use {

  'nvim-telescope/telescope.nvim', tag = '0.1.8',

-- or                            , branch = '0.1.x',

  requires = { {'nvim-lua/plenary.nvim'} }

}

 use 'nvim-treesitter/nvim-treesitter'

 use 'jkeresman01/java-method-search.nvim'

```

***

## Commands :musical_keyboard:  ##

Following commands have been exposed to Neovim:

`Commands`  

```lua

:JavaMethodSearch      -- Launch picker (select your java method and navigate to it)

```

## Setup :musical_keyboard:  ##

Set the keybindings as you see fit, here is one example:

```lua

require ("java-method-search").setup()

vim.keymap.set("n", "jms", "JavaMethodSearch")

```

***

| Key - map     | Action                                                             |

|---------------|--------------------------------------------------------------------|

| `fm`  | Search through Java methods within a file.                         |