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

/images/editor-open-with.png

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

application-yaml-validation application-properties-validation

Code Completions

application-yaml-completions

application-properties-completions

Information Hovers

application-yaml-hovers

Issues and Feature Requests

Please report bugs, issues and feature requests on the Github STS4 issue tracker.

Releases:

Released versions of this extension can be installed directly from the vscode marketplace.

There are also development snapshots available with the latest fixes and improvements as a .vsix file that can be donwloaded from here. To install it open vscode, press CTRL-SHIFT-P and search for VSIX, then select Extension: Install from VSIX

Clone this wiki locally