Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/eltonsandre/intellij-spring-boot-helper

Assist in Spring application development - Adds support for start initializr, autocomplete Spring Boot/Cloud configuration key/value, Spring reference configuration, Spring metadata documentation.(Support: Java, Kotlin, application.yml and bootstrap.properties)
https://github.com/eltonsandre/intellij-spring-boot-helper

autocompletion intellij-idea intellij-plugin intellij-spring intellij-spring-boot spring-boot spring-plugin

Last synced: about 1 month ago
JSON representation

Host: GitHub
URL: https://github.com/eltonsandre/intellij-spring-boot-helper
Owner: eltonsandre
License: other
Created: 2022-08-06T00:58:56.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-09-26T19:52:13.000Z (about 2 months ago)
Last Synced: 2024-09-30T03:23:39.015Z (about 2 months ago)
Topics: autocompletion, intellij-idea, intellij-plugin, intellij-spring, intellij-spring-boot, spring-boot, spring-plugin
Homepage:
Size: 14.9 MB
Stars: 14
Watchers: 2
Forks: 3
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE_PLUGIN.md

Awesome Lists containing this project

README

![Version](https://img.shields.io/jetbrains/plugin/v/18622-spring-boot-helper)
![Downloads](https://img.shields.io/jetbrains/plugin/d/18622-spring-boot-helper)
![Rating](https://img.shields.io/jetbrains/plugin/r/rating/18622-spring-boot-helper)

---
## Features:
### Spring Initializr
⚠️ Resource Moved to plugin ![Spring](https://plugins.jetbrains.com/files/23564/476979/icon/pluginIcon.svg) [Spring Initializr](https://plugins.jetbrains.com/plugin/23564-spring-initializr)
1. Allows you to bootstrap new project & new module using `File-> New-> Project-> Spring Initializr` & `File-> New-> Module-> Spring Initializr`
wizards.

### Autocomplete configuration properties

1. Autocompletion of the configuration properties in your `yaml`/ `properties` files based on the spring boot's autoconfiguration jars are present in
the classpath
2. Auto-completion of the configuration properties in your `yaml`/ `properties` files if you have classes annotated with `@ConfigurationProperties`
, [if your build is properly configured](https://docs.spring.io/spring-boot/docs/current/reference/html/configuration-metadata.html#appendix.configuration-metadata.annotation-processor.configuring)
3. Short form search & search for element deep within is also supported. i.e, `sp.d` will show you `spring.data`, `spring.datasource`, also, `port`
would show `server.port` as a suggestion
4. Quick documentation for groups & properties (not all groups & properties will have documentation, depends on whether the original author specified
documentation or not for any given element)

### Go to configuration properties

1. Ctrl+click to go to property or code

2. Goto placeholder

## Usage

---
Assuming that you have Spring boot's autoconfiguration jars are present in the classpath, this plugin will automatically allows you to autocomplete
properties as suggestions in all your `yml` files

Suggestions would appear as soon as you type/press `Ctrl+Space`.

Short form suggestions are also supported such as, `sp.d` will show you `spring.data`, `spring.datasource`, e.t.c as suggestions that make your typing
faster

In addition to libraries in the classpath, the plugin also allows you to have your own `@ConfigurationProperties` available as suggestions in all
your `yml` files.

For this to work, you need to ensure the following steps are followed for your project/module

### Setup for showing ConfigurationProperties as suggestions within current module

1. Make sure `Enable annotation processing` is checked under `Settings > Build, Execution & Deployment > Compiler > Annotation Processors`
2. Make sure you add the following changes to your project

#### *For Gradle*

Add the following build configuration. You can use the [propdeps-plugin](https://github.com/spring-gradle-plugins/propdeps-plugin) for `optional`
scope (as we dont need `spring-boot-configuration-processor` as a dependency in the generated jar/war)

```groovy
dependencies {
annotationProcessor 'org.springframework.boot:spring-boot-configuration-processor'
}

compileJava.dependsOn(processResources)
```

#### *For Maven*

```xml

org.springframework.boot
spring-boot-configuration-processor
true

```

3. (**OPTIONAL**) If intellij is generating build artfacts to `output` directory instead of gradle's default `build` directory, then you may need
to `File | Settings | Build, Execution, Deployment | Build Tools | Gradle | Runner => Delegate IDE build/run actions to gradle` & restart the IDE.
This will ensure that gradle plugin generates metadata & Intellij is pointing to it

> directory where the above setup is done. These samples allow properties from `@ConfigurationProperties` to be shown as suggestions

---
⚠️ **IMPORTANT**

> After changing your custom `@ConfigurationProperties` files, suggestions would be refreshed only after you trigger the build explicitly using keyboard (`Ctrl+F9`)/UI

### Known behaviour in ambiguous cases

> 1. If two groups from different auto configurations conflict with each other, the documentation for the group picked is random & undefined
> 2. If a group & property represent the depth, the behaviour of the plugin is undefined.

## Installation (in 3 easy steps)

To install the plugin open your editor (IntelliJ) and hit:

1. `File > Settings > Plugins` and click on the `Browse repositories` button.
2. Look for `Spring Boot Helper` the right click and select `Download plugin`.
3. Finally hit the `Apply` button, agree to restart your IDE and you're all done!

Feel free to let me know what else you want added via the [issues](https://github.com/eltonsandre/intellij-spring-boot-helper/issues)