diff --git a/vscode-extensions/commons/application-properties-metadata/src/test/java/org/springframework/ide/vscode/boot/properties/metadata/LoggerNameProviderTest.java b/vscode-extensions/commons/application-properties-metadata/src/test/java/org/springframework/ide/vscode/boot/properties/metadata/LoggerNameProviderTest.java index cbb8b915a..149e34014 100644 --- a/vscode-extensions/commons/application-properties-metadata/src/test/java/org/springframework/ide/vscode/boot/properties/metadata/LoggerNameProviderTest.java +++ b/vscode-extensions/commons/application-properties-metadata/src/test/java/org/springframework/ide/vscode/boot/properties/metadata/LoggerNameProviderTest.java @@ -63,7 +63,7 @@ public class LoggerNameProviderTest { String query = "jboss"; List directQueryResults = getResults(p, query); - dumpResults("jboss - DIRECT", directQueryResults); +// dumpResults("jboss - DIRECT", directQueryResults); /* * Commented out due to search results from JDK present @@ -99,7 +99,7 @@ public class LoggerNameProviderTest { for (int i = 0; i <= fullQuery.length(); i++) { String query = fullQuery.substring(0, i); List results = getResults(p, query); - dumpResults(query, results); +// dumpResults(query, results); if (i==fullQuery.length()) { System.out.println("Verifying final result!"); //Not checking for exact equals because... quircks of JDT search engine means it @@ -146,6 +146,7 @@ public class LoggerNameProviderTest { .collect(Collectors.toList()); } + @SuppressWarnings("unused") private void dumpResults(String string, Collection r) { System.out.println(">>> "+string); String[] strings = r.toArray(new String[r.size()]); diff --git a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/DefaultCompletionFactory.java b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/DefaultCompletionFactory.java index 9d96cc27f..eb204ceb5 100644 --- a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/DefaultCompletionFactory.java +++ b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/DefaultCompletionFactory.java @@ -7,7 +7,7 @@ import org.springframework.ide.vscode.commons.languageserver.completion.IComplet import org.springframework.ide.vscode.commons.languageserver.completion.ScoreableProposal; import org.springframework.ide.vscode.commons.languageserver.util.IDocument; import org.springframework.ide.vscode.commons.util.Renderable; -import org.springframework.ide.vscode.commons.yaml.hover.YPropertyHoverInfo; +import org.springframework.ide.vscode.commons.yaml.hover.YPropertyInfoTemplates; import org.springframework.ide.vscode.commons.yaml.schema.YType; import org.springframework.ide.vscode.commons.yaml.schema.YTypeUtil; import org.springframework.ide.vscode.commons.yaml.schema.YTypedProperty; @@ -64,7 +64,7 @@ public class DefaultCompletionFactory implements CompletionFactory { @Override public Renderable getDocumentation() { - return YPropertyHoverInfo.create(contextProperty, contextType, p); + return YPropertyInfoTemplates.createCompletionDocumentation(contextProperty, contextType, p); } } diff --git a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/YTypeAssistContext.java b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/YTypeAssistContext.java index d8eca0189..8a2ad6e7b 100644 --- a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/YTypeAssistContext.java +++ b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/completion/YTypeAssistContext.java @@ -26,7 +26,7 @@ import org.springframework.ide.vscode.commons.languageserver.util.DocumentRegion import org.springframework.ide.vscode.commons.util.CollectionUtil; import org.springframework.ide.vscode.commons.util.FuzzyMatcher; import org.springframework.ide.vscode.commons.util.Renderable; -import org.springframework.ide.vscode.commons.yaml.hover.YPropertyHoverInfo; +import org.springframework.ide.vscode.commons.yaml.hover.YPropertyInfoTemplates; import org.springframework.ide.vscode.commons.yaml.path.YamlPath; import org.springframework.ide.vscode.commons.yaml.path.YamlPathSegment; import org.springframework.ide.vscode.commons.yaml.path.YamlPathSegment.YamlPathSegmentType; @@ -238,7 +238,7 @@ public class YTypeAssistContext extends AbstractYamlAssistContext { case KEY_AT_KEY: YTypedProperty prop = getProperty(lastSegment.toPropString()); if (prop!=null) { - return YPropertyHoverInfo.create(contextPath.toPropString(), getType(), prop); + return YPropertyInfoTemplates.createHover(contextPath.toPropString(), getType(), prop); } break; default: diff --git a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyHoverInfo.java b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyInfoTemplates.java similarity index 77% rename from vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyHoverInfo.java rename to vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyInfoTemplates.java index 6948deb02..9d91e6bd7 100644 --- a/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyHoverInfo.java +++ b/vscode-extensions/commons/commons-yaml/src/main/java/org/springframework/ide/vscode/commons/yaml/hover/YPropertyInfoTemplates.java @@ -17,6 +17,7 @@ import static org.springframework.ide.vscode.commons.util.Renderables.link; import static org.springframework.ide.vscode.commons.util.Renderables.text; import org.springframework.ide.vscode.commons.util.Renderable; +import org.springframework.ide.vscode.commons.util.Renderables; import org.springframework.ide.vscode.commons.util.StringUtil; import org.springframework.ide.vscode.commons.yaml.schema.YType; import org.springframework.ide.vscode.commons.yaml.schema.YTypedProperty; @@ -29,9 +30,9 @@ import com.google.common.collect.ImmutableList.Builder; * * @author Kris De Volder */ -public class YPropertyHoverInfo { +public class YPropertyInfoTemplates { - public static Renderable create(String contextProperty, YType contextType, YTypedProperty prop) { + public static Renderable createHover(String contextProperty, YType contextType, YTypedProperty prop) { Builder html = ImmutableList.builder(); if (StringUtil.hasText(contextProperty)) { @@ -57,5 +58,15 @@ public class YPropertyHoverInfo { return concat(html.build()); } + + public static Renderable createCompletionDocumentation(String contextProperty, YType contextType, YTypedProperty prop) { + /* + * More parameters present to be able to quickly change the format. + * Currently the format for the documentation is just the property + * description + */ + Renderable r = prop.getDescription(); + return r == Renderables.NO_DESCRIPTION ? null : r; + } } diff --git a/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/AbstractPropertyProposal.java b/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/AbstractPropertyProposal.java index 8ce21f18d..af1e2e37f 100644 --- a/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/AbstractPropertyProposal.java +++ b/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/AbstractPropertyProposal.java @@ -15,7 +15,7 @@ import org.springframework.ide.vscode.commons.languageserver.completion.Document import org.springframework.ide.vscode.commons.languageserver.completion.ScoreableProposal; import org.springframework.ide.vscode.commons.languageserver.util.IDocument; import org.springframework.ide.vscode.commons.util.Renderable; -import org.springframework.ide.vscode.commons.yaml.hover.YPropertyHoverInfo; +import org.springframework.ide.vscode.commons.yaml.hover.YPropertyInfoTemplates; import org.springframework.ide.vscode.commons.yaml.schema.YType; import org.springframework.ide.vscode.commons.yaml.schema.YTypeUtil; diff --git a/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/PropertyCompletionFactory.java b/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/PropertyCompletionFactory.java index 285d67dd2..b37ef73c1 100644 --- a/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/PropertyCompletionFactory.java +++ b/vscode-extensions/vscode-boot-properties/src/main/java/org/springframework/ide/vscode/boot/common/PropertyCompletionFactory.java @@ -23,7 +23,7 @@ import org.springframework.ide.vscode.commons.languageserver.completion.Scoreabl import org.springframework.ide.vscode.commons.languageserver.java.JavaProjectFinder; import org.springframework.ide.vscode.commons.languageserver.util.IDocument; import org.springframework.ide.vscode.commons.util.Renderable; -import org.springframework.ide.vscode.commons.yaml.hover.YPropertyHoverInfo; +import org.springframework.ide.vscode.commons.yaml.hover.YPropertyInfoTemplates; import org.springframework.ide.vscode.commons.yaml.schema.YType; import com.google.common.base.Supplier; @@ -75,7 +75,7 @@ public class PropertyCompletionFactory { @Override public Renderable getDocumentation() { - return YPropertyHoverInfo.create(contextProperty, contextType, property); + return YPropertyInfoTemplates.createCompletionDocumentation(contextProperty, contextType, property); } @Override