Spring Assistant downloads statistics

Spring Assistant - IntelliJ plugin that assists you in developing spring applications

What does the plugin do

This plugins provides the following features as of now. (IntelliJ IDEA Ultimate does not need to download the plugin)

• Auto completion of the configuration properties in your yaml files based on the spring boot's auto configuration jars are present in the classpath • Auto completion of the configuration properties in your yaml files if you have classes annotated with @ConfigurationProperties, if your build is properly configured • Auto completion of the configuration properties in your properties files based on the spring boot's auto configuration jars are present in the classpath • 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 • 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 Assistant wizards. Looks & Feel resembles Intellij Ultimate, but with less bells & whistles

描述

• 用来创建Spring Boot工程 • 支持yml的自动补全 • 部分支持properties的自动补全（我没充分测试过，显示还是灰色的Unused property，不过凑活用吧，原来维护的人基本已经完成功能，只是那时候没开放） • 旗舰版已经自带补全了，没必要下载 • 我看了下最高能支持到版本号222

注意事项

• 创建项目时默认使用Artifact Id作为Project name，如果你手动声明了Project name，记得在指定项目路径时，把项目路径上面的Project name改成你自己声明的 • 升级后可能会报错，应该没影响，有影响就重装

Usage

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

Setup for showing ConfigurationProperties as suggestions within current module

• Make sure Enable annotation processing is checked under Settings > 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 optional scope (as we dont need spring-boot-configuration-processor as 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 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

If you want to look at a sample project, look inside samples 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

• 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.

Feel free to let me know what else you want added via the issues

Suggestions, feedback and other comments welcome via @1tontech on Twitter

Changelog

Since 1.0.6 (28 Nov 2021):

• improve 部分支持properties的补全

Since 1.0.5 (21 Nov 2021):

• Fixed 修复直接通过Maven创建项目时不能补全的bug

Since 1.0.4 (20 Nov 2021):

• Fixed 创建项目时404的问题

Since 1.0.3 (28 Oct 2021):

• Fixed bugs • Refactor build.gradle upgrade dependence versions • improve code and clean code refactors • Improved the configuration page • test: IntelliJ IDEA 2021.2.3 (Community Edition) Build #IC-212.xx • 修复了一些bug（目前还是只支持yml） • 适配2021.2.3 • 完善了下配置界面

Since 1.0.0 (1 Feb 2021):

• Fixed bugs • Refactor build.gradle upgrade dependence versions • Upgrade JDK 11 • improve code and clean code refactors • test: IntelliJ IDEA 2020.3.2 (Community Edition) Build #IC-203.xx

License

Spring Assistant - IntelliJ Plugin is open-sourced software licensed under the MIT license

Description from the JetBrains Marketplace listing.