Spring/spring-tools
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Setting to "elide prefix" for properties completions

Browse Source
This commit is contained in:
aboyko
2024-10-14 13:09:58 -04:00
parent f844544653
commit 00d423a7ea
11 changed files with 71 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
eclipse-language-servers/org.springframework.tooling.boot.ls/src/org/springframework/tooling/boot/ls/Constants.java
View File

@@ -48,4 +48,6 @@ public class Constants {
public static final String PREF_JPQL = "boot-java.jpql";
public static final String PREF_PROPS_COMPLETIONS_ELIDE_PREFIX = "boot-java.properties.completions.elide-prefix";
}

6
eclipse-language-servers/org.springframework.tooling.boot.ls/src/org/springframework/tooling/boot/ls/DelegatingStreamConnectionProvider.java
View File

@@ -223,6 +223,12 @@ public class DelegatingStreamConnectionProvider implements StreamConnectionProvi
"properties-metadata", preferenceStore.getString(Constants.PREF_COMMON_PROPS_METADATA)
));
bootJavaObj.put("properties", Map.of(
"completions", Map.of(
"elide-prefix", preferenceStore.getBoolean(Constants.PREF_PROPS_COMPLETIONS_ELIDE_PREFIX)
)
));
settings.put("boot-java", bootJavaObj);
settings.put("http", createHttpProxySettings());

3
eclipse-language-servers/org.springframework.tooling.boot.ls/src/org/springframework/tooling/boot/ls/prefs/BootJavaPreferencesPage.java
View File

@@ -45,6 +45,9 @@ public class BootJavaPreferencesPage extends FieldEditorPreferencePage implement
// JPQL Support switch
addField(new BooleanFieldEditor(Constants.PREF_JPQL, "JPA Query language support", fieldEditorParent));
// Properties Completions - Elide common prefix
addField(new BooleanFieldEditor(Constants.PREF_PROPS_COMPLETIONS_ELIDE_PREFIX, "Elide common prefix in property key auto completions", fieldEditorParent));
// Experimental Modulith support
addField(new BooleanFieldEditor(Constants.PREF_MODULITH, "Spring Boot Modulith automatic project tracking and metadata update", fieldEditorParent));

2
eclipse-language-servers/org.springframework.tooling.boot.ls/src/org/springframework/tooling/boot/ls/prefs/PrefsInitializer.java
View File

@@ -66,6 +66,8 @@ public class PrefsInitializer extends AbstractPreferenceInitializer {
preferenceStore.setDefault(Constants.PREF_JPQL, true);
preferenceStore.setDefault(Constants.PREF_PROPS_COMPLETIONS_ELIDE_PREFIX, false);
}
}

8
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/app/BootJavaConfig.java
View File

@@ -22,6 +22,7 @@ import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.ide.vscode.boot.common.SpringProblemCategories;
import org.springframework.ide.vscode.boot.properties.completions.PropertyCompletionSettings;
import org.springframework.ide.vscode.commons.languageserver.reconcile.ProblemCategory.Toggle;
import org.springframework.ide.vscode.commons.languageserver.reconcile.ProblemType;
import org.springframework.ide.vscode.commons.languageserver.util.ListenerList;
@@ -235,6 +236,13 @@ public class BootJavaConfig implements InitializingBean {
return Toggle.Option.AUTO;
}
public PropertyCompletionSettings getPropertyCompletionSettings() {
Boolean elidePrefix = settings.getBoolean("boot-java", "properties", "completions", "elide-prefix");
return new PropertyCompletionSettings(
elidePrefix != null && elidePrefix.booleanValue()
);
}
public JsonObject getJavaValidationSettingsJson() {
JsonObject javaValidationsJson = new JsonObject();
List<String> javaValidationTypes = List.of(

4
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/app/BootLanguageServerBootApp.java
View File

@@ -286,11 +286,11 @@ public class BootLanguageServerBootApp {
return new SpringXMLCompletionEngine(server, projectFinder, symbolIndex, config);
}
@Bean SpringPropertiesCompletionEngine propertiesCompletionEngine(BootLanguageServerParams params, JavaProjectFinder projectFinder, SourceLinks sourceLinks) {
@Bean SpringPropertiesCompletionEngine propertiesCompletionEngine(BootLanguageServerParams params, JavaProjectFinder projectFinder, SourceLinks sourceLinks, BootJavaConfig config) {
return new SpringPropertiesCompletionEngine(
params.indexProvider,
params.typeUtilProvider,
projectFinder, sourceLinks);
projectFinder, sourceLinks, config);
}
@Bean YamlCompletionEngine yamlCompletionEngine(YamlStructureProvider structureProvider, YamlAssistContextProvider contextProvider) {

7
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/properties/completions/PropertiesCompletionProposalsCalculator.java
View File

@@ -116,9 +116,12 @@ public class PropertiesCompletionProposalsCalculator {
private int offset;
private boolean preferLowerCaseEnums;
private AntlrParser parser;
private final PropertyCompletionSettings propertyCompletionSettings;
public PropertiesCompletionProposalsCalculator(FuzzyMap<PropertyInfo> index, TypeUtil typeUtil, PropertyCompletionFactory completionFactory, IDocument doc, int offset, boolean preferLowerCaseEnums) {
public PropertiesCompletionProposalsCalculator(FuzzyMap<PropertyInfo> index, PropertyCompletionSettings propertyCompletionSettings,
TypeUtil typeUtil, PropertyCompletionFactory completionFactory, IDocument doc, int offset, boolean preferLowerCaseEnums) {
this.index = index;
this.propertyCompletionSettings = propertyCompletionSettings;
this.typeUtil = typeUtil;
this.completionFactory = completionFactory;
this.doc = doc;
@@ -365,7 +368,7 @@ public class PropertiesCompletionProposalsCalculator {
}
private Collection<ICompletionProposal> elideCommonPrefix(String basePrefix, ArrayList<ICompletionProposal> proposals) {
if (false) { // TODO: check for preference setting
if (propertyCompletionSettings.elidePrefix()) {
String prefix = StringUtil.commonPrefix(Stream.concat(Stream.of(basePrefix), proposals.stream().map(ICompletionProposal::getLabel)));
int lastDot = prefix.lastIndexOf('.');
if (lastDot>=0) {

15
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/properties/completions/PropertyCompletionSettings.java Normal file
View File

@@ -0,0 +1,15 @@
/*******************************************************************************
* Copyright (c) 2024 Broadcom, Inc.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Broadcom, Inc. - initial API and implementation
*******************************************************************************/
package org.springframework.ide.vscode.boot.properties.completions;
public record PropertyCompletionSettings(boolean elidePrefix) {
}

16
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/properties/completions/SpringPropertiesCompletionEngine.java
View File

@@ -13,6 +13,7 @@ package org.springframework.ide.vscode.boot.properties.completions;
import java.util.Collection;
import org.springframework.ide.vscode.boot.app.BootJavaConfig;
import org.springframework.ide.vscode.boot.common.PropertyCompletionFactory;
import org.springframework.ide.vscode.boot.java.links.SourceLinks;
import org.springframework.ide.vscode.boot.metadata.SpringPropertyIndexProvider;
@@ -35,18 +36,21 @@ public class SpringPropertiesCompletionEngine implements ICompletionEngine, Lang
private boolean preferLowerCaseEnums = true; //might make sense to make this user configurable
private SpringPropertyIndexProvider indexProvider;
private TypeUtilProvider typeUtilProvider;
private PropertyCompletionFactory completionFactory = null;
private SourceLinks sourceLinks;
private final SpringPropertyIndexProvider indexProvider;
private final TypeUtilProvider typeUtilProvider;
private final PropertyCompletionFactory completionFactory;
private final SourceLinks sourceLinks;
private final BootJavaConfig config;
/**
* Constructor used in 'production'. Wires up stuff properly for running inside a normal
* Eclipse runtime.
*/
public SpringPropertiesCompletionEngine(SpringPropertyIndexProvider indexProvider, TypeUtilProvider typeUtilProvider, JavaProjectFinder projectFinder, SourceLinks sourceLinks) {
public SpringPropertiesCompletionEngine(SpringPropertyIndexProvider indexProvider, TypeUtilProvider typeUtilProvider, JavaProjectFinder projectFinder,
SourceLinks sourceLinks, BootJavaConfig config) {
this.indexProvider = indexProvider;
this.typeUtilProvider = typeUtilProvider;
this.config = config;
this.completionFactory = new PropertyCompletionFactory();
this.sourceLinks = sourceLinks;
}
@@ -56,7 +60,7 @@ public class SpringPropertiesCompletionEngine implements ICompletionEngine, Lang
*/
@Override
public InternalCompletionList getCompletions(TextDocument doc, int offset) throws BadLocationException {
Collection<ICompletionProposal> completionItems = new PropertiesCompletionProposalsCalculator(indexProvider.getIndex(doc).getProperties(),
Collection<ICompletionProposal> completionItems = new PropertiesCompletionProposalsCalculator(indexProvider.getIndex(doc).getProperties(), config.getPropertyCompletionSettings(),
typeUtilProvider.getTypeUtil(sourceLinks, doc), completionFactory, doc, offset, preferLowerCaseEnums).calculate();
return new InternalCompletionList(completionItems, true);

16
headless-services/spring-boot-language-server/src/test/java/org/springframework/ide/vscode/boot/test/ApplicationPropertiesEditorTest.java
View File

@@ -42,6 +42,7 @@ import org.springframework.ide.vscode.boot.metadata.CachingValueProvider;
import org.springframework.ide.vscode.boot.metadata.PropertiesLoader;
import org.springframework.ide.vscode.commons.java.IJavaProject;
import org.springframework.ide.vscode.commons.java.IType;
import org.springframework.ide.vscode.commons.languageserver.util.Settings;
import org.springframework.ide.vscode.commons.maven.java.MavenJavaProject;
import org.springframework.ide.vscode.commons.util.text.LanguageId;
import org.springframework.ide.vscode.languageserver.testharness.CodeAction;
@@ -51,6 +52,8 @@ import org.springframework.test.context.junit.jupiter.SpringExtension;
import com.google.common.collect.ImmutableList;
import com.google.common.io.Files;
import com.google.gson.Gson;
import com.google.gson.JsonElement;
/**
* Boot App Properties Editor tests
@@ -292,6 +295,13 @@ public class ApplicationPropertiesEditorTest extends AbstractPropsEditorTest {
@Test
void abbreviateLongPrefixCompletions() throws Exception {
String changedSettings = "{\"boot-java\": {\"properties\": {\"completions\": {\"elide-prefix\": true}}}}";
JsonElement settingsAsJson = new Gson().fromJson(changedSettings, JsonElement.class);
Settings settings = new Settings(settingsAsJson);
harness.changeConfiguration(settings);
//See: https://github.com/spring-projects/sts4/issues/361
Editor editor;
@@ -815,9 +825,9 @@ public class ApplicationPropertiesEditorTest extends AbstractPropsEditorTest {
assertCompletionsDisplayString(
"application.temp.user.<*>"
, // =>
"name",
"password",
"roles"
"application.temp.user.name",
"application.temp.user.password",
"application.temp.user.roles"
);
assertCompletionsDisplayString(

5
vscode-extensions/vscode-spring-boot/package.json
View File

@@ -343,6 +343,11 @@
],
"description": "The path to a shared properties metadata JSON file."
},
"boot-java.properties.completions.elide-prefix": {
"type": "boolean",
"default": false,
"description": "Elide common prefix in property key auto completions"
},
"boot-java.jpql": {
"type": "boolean",
"default": true,