Skip to content

Latest commit

 

History

History
80 lines (57 loc) · 3.14 KB

README.md

File metadata and controls

80 lines (57 loc) · 3.14 KB
Raw

Spring Boot NVim

Spring boot NVim is plugin currently under development to simplify the development of Java, specifically Spring Boot projects.

The plugin aims to bring features similar to that of modern Java IDE's such as Intellij and Eclipse to NeoVim.

Features currently implemented include:

  1. Incremental compiling on save, which enables Spring Boot Dev Tools to auto reload your application for rapid development.

  2. Start running your Spring Boot project with a simple key mapping rather than starting up a new terminal and running the run command manually.

  3. Automatic package declaration when a Java file is created in NeoVim.

  4. Class, Interface, and Enum generation to reduce the need to type out boiler plate code.

We are also planning a Spring Boot Project generator based on the Spring Initializer API, as well as features from community feedback.

Installation

Basic installation requires nvim-lspconfig and nvim-jdtls to auto compile, and gain information from the Java LSP about your project.

return {
    "elmcgill/springboot-nvim",
    depedencies = {
        "neovim/nvim-lspconfig",
        "mfussenegger/nvim-jdtls",
        "nvim-tree/nvim-tree.lua",
    },
    config = function()
        local springboot_nvim = require("springboot-nvim")
        springboot_nvim.setup({})
    end
}

Recommended installation and configuration

return {
    "elmcgill/springboot-nvim",
    depedencies = {
        "neovim/nvim-lspconfig",
        "mfussenegger/nvim-jdtls"
    },
    config = function()
        local springboot_nvim = require("springboot-nvim")
        vim.keymap.set('n', '<leader>Jr', springboot_nvim.boot_run, {desc = "Spring Boot Run Project"})
        vim.keymap.set('n', '<leader>Jc', springboot_nvim.generate_class, {desc = "Java Create Class"})
        vim.keymap.set('n', '<leader>Ji', springboot_nvim.generate_interface, {desc = "Java Create Interface"})
        vim.keymap.set('n', '<leader>Je', springboot_nvim.generate_enum, {desc = "Java Create Enum"})
        springboot_nvim.setup({})
    end
}

Creating a New Spring Boot Project

To create a new Spring Boot project in Neovim, you can use the SpringBootNewProject command. This command leverages the functionality of the Neovim plugin to automatically generate a Spring Boot project by fetching it from https://start.spring.io.

Here's what the SpringBootNewProject command does:

Fetch Project Metadata: The command sends a request to start.spring.io to retrieve the latest metadata for project configuration.
Generate Project: Based on the metadata and user-specified options, it generates a new Spring Boot project.
Download Project: The generated project is then downloaded and saved to your local system, ready for you to start coding.

To use this feature, simply run the following command in Neovim:

:SpringBootNewProject

This will initiate the process of creating a new Spring Boot project tailored to your specifications.

Contributing

If you have recommendations feel free to create feature requests that we will attempt to get you.

If you would like to contribute please create a new branch and pull request with the new/updated features.