spring-initializr.nvim

The easiest way to generate Spring Boot projects

A Neovim plugin that lets you build and download fully configured Spring Boot projects inside the editor.

🔧 Features

• Full Spring Initializr metadata support
• TUI-based UI for selecting project options
• Fuzzy dependency selection with telescope.nvim
• Tab and key-based navigation

📁 Project Structure

spring-initializr.nvim/
├── LICENSE
├── README.md
├── lua
│   └── spring-initializr
│       ├── commands
│       │   └── commands.lua           # Neovim user commands
│       ├── core
│       │   └── core.lua               # Project generation logic
│       ├── init.lua                   # Plugin entry point
│       ├── metadata
│       │   └── metadata.lua           # Metadata fetching and state
│       ├── telescope
│       │   └── telescope.lua          # Telescope-based dependency picker
│       ├── ui
│       │   ├── deps.lua               # Dependencies panel and buttons
│       │   ├── focus.lua              # Focus management across windows
│       │   ├── init.lua               # UI mount/unmount setup
│       │   ├── inputs.lua             # Input fields (groupId, artifactId, etc.)
│       │   ├── layout.lua             # Full UI layout builder
│       │   └── radios.lua             # Radio-style selectors
│       └── utils
│           ├── file.lua               # File utilities
│           ├── highlights.lua         # Highlight group setup
│           ├── http.lua               # Project downloader
│           ├── message.lua            # Logging helpers
│           ├── url.lua                # URL query encoding
│           └── window.lua             # Popup window helpers

Installation ⭐

Requires Neovim 0.9+
Dependencies:

• nui.nvim
• plenary.nvim
• telescope.nvim

Vim Plug

Plug 'nvim-lua/plenary.nvim'
Plug 'MunifTanjim/nui.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'jkeresman01/spring-initializr.nvim'

Packer

use {
  'jkeresman01/spring-initializr.nvim',
  requires = {
    'nvim-lua/plenary.nvim',
    'MunifTanjim/nui.nvim',
    'nvim-telescope/telescope.nvim'
  }
}

Lazy.nvim

{
  'jkeresman01/spring-initializr.nvim',
  dependencies = {
    'nvim-lua/plenary.nvim',
    'MunifTanjim/nui.nvim',
    'nvim-telescope/telescope.nvim',
  },
  config = function()
    require('spring-initializr').setup()
  end
}

Commands 🔧

:SpringInitializr             -- Launch the UI to configure project
:SpringGenerateProject        -- Download and extract Spring Boot project to current directory

Setup ⚙️

Basic setup and keybindings:

require("spring-initializr").setup()

vim.keymap.set("n", "<leader>si", "<CMD>SpringInitializr<CR>")
vim.keymap.set("n", "<leader>sg", "<CMD>SpringGenerateProject<CR>")

Keybinding	Action
<leader>si	Open Spring Initializr TUI
<leader>sg	Generate project to current directory
<Tab>	Navigate forward between fields
<S-Tab>	Navigate backward
j / k	Move between radio options
<CR>	Confirm field selection or submit

Contributing

Contributions are very welcome. You can help by:

• Picking up an existing issue.
• Opening a new bug report or feature request with clear details.
• Submitting a focused pull request that improves code, docs, or UX.

How to get started

1. Fork the repo and clone your fork.
2. Create a topic branch: git checkout -b feature/<short-name> or fix/<short-name>.
3. Develop and test locally in Neovim:
   • Ensure dependencies are installed: plenary.nvim, nui.nvim, telescope.nvim.
   • Load the plugin and verify :SpringInitializr and :SpringGenerateProject.
4. Commit with clear messages and reference any related issues:
   git commit -m "Add toggle for X (#123)"
5. Push and open a pull request against main.

Filing issues

• Use the provided issue templates for bugs and features.
• For bugs, include Steps to Reproduce, Actual vs Expected Behavior, Environment, and logs if available.
• For features, describe the motivation, proposed solution, and alternatives considered.

If you are unsure where to start, open an issue to discuss an idea before coding.

License

This project is licensed under the terms of the GNU General Public License v3.0.