This plugins provides the following features as of now.
- Auto completion of the configuration properties in your
yamlfiles based on the spring boot's auto configuration jars are present in the classpath - Auto completion of the configuration properties in your
yamlfiles if you have classes annotated with@ConfigurationProperties, if your build is properly configured - Short form search & search for element deep within is also supported. i.e,
sp.dwill show youspring.data,spring.datasource, also,portwould showserver.portas a suggestion - 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)
- Allows you to bootstrap new project & new module using
File -> New -> Project -> Spring Assistant&File -> New -> Module -> Spring Assistantwizards. Looks & Feel resembles Intellij Ultimate, but with less bells & whistles
Assuming that you have Spring boot's auto configuration 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
-
Make sure
Enable annotation processingis checked underSettings > Build, Execution & Deployment > Compiler > Annotation Processors -
Make sure you add the following changes to to your project
For Maven
Add the following dependency
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency>
For Gradle
Add the following build configuration. You can use the propdeps-plugin for
optionalscope (as we dont needspring-boot-configuration-processoras a dependency in the generated jar/war)dependencies { optional "org.springframework.boot:spring-boot-configuration-processor" } compileJava.dependsOn(processResources)
-
(OPTIONAL) If intellij is generating build artfacts to
outputdirectory instead of gradle's defaultbuilddirectory, then you may need toFile | 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
If you want to look at a sample project, look inside samples directory where the above setup is done. These samples allow properties from
@ConfigurationPropertiesto be shown as suggestions
IMPORTANT
After changing your custom
@ConfigurationPropertiesfiles, suggestions would be refreshed only after you trigger the build explicitly using keyboard (Ctrl+F9)/UI
- If two groups from different auto configurations conflict with each other, the documentation for the group picked is random & undefined
- If a group & property represent the depth, the behaviour of the plugin is undefined.
To install the plugin open your editor (IntelliJ) and hit:
File > Settings > Pluginsand click on theBrowse repositoriesbutton.- Look for
Spring Assistantthe right click and selectDownload plugin. - Finally hit the
Applybutton, agree to restart your IDE and you're all done!
Feel free to let me know what else you want added via the issues
See here
Spring Assistant - IntelliJ Plugin is open-sourced software licensed under the MIT license
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent