Skip to content

Boot Properties Editor

Kris De Volder edited this page Sep 11, 2018 · 14 revisions

This describes the Eclipse-based editor support for editing Spring Boot properties files in either .properties or .yml format.

Note that similar support is also provided for vscode and atom. For documentation on vscode/atom support please refer to vscode marketplace entry or atom package repository entry instead.

Usage:

The Boot properties/yml editor will automatically be used when you edit files with name application.yml or application.properties. Due to limitations in Eclipse's content-type framework, files with other names like application-production.properties will not be automatically opened with the Spring Boot Properties Editor.

There is a somewhat clunky workaround for this limitation:

  • Open Eclipse Preferences and Search for Content Types.
  • Select the Spring Properties File or Spring Yaml Properties File content type.
  • In the File Associations section click the Add button.
  • Enter the name of your file without path exactly (glob patterns or paths are not supported). For example application-custom-profile.properties.
  • Click Apply and Close button.

From now on files with the name application-custom-profile.properties will be opened with the Spring Boot Editor.

Functionality

STS analyzes your project's classpath and parses and indexes any Spring Boot Properties Metadata it finds. Both Maven and Gradle projects are supported.

The data in the index is used to provide validation, code completions and information hovers while editing Spring Boot Properties in either .properties or .yml format.

Validation

Code Completions

Information Hovers

Clone this wiki locally