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

Add Starters Inlay Hint in the pom file

Browse Source
This commit is contained in:
aboyko
2024-02-21 17:29:55 -05:00
parent 9011e040f9
commit 09ed9c1157
17 changed files with 513 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -29,8 +29,10 @@ import org.springframework.ide.vscode.boot.java.links.JavaElementLocationProvide
import org.springframework.ide.vscode.boot.java.links.SourceLinks;
import org.springframework.ide.vscode.boot.java.livehover.v2.SpringProcessLiveDataProvider;
import org.springframework.ide.vscode.boot.java.utils.CompilationUnitCache;
import org.springframework.ide.vscode.boot.maven.PomLanguageServerComponents;
import org.springframework.ide.vscode.boot.metadata.ProjectBasedPropertyIndexProvider;
import org.springframework.ide.vscode.boot.properties.BootPropertiesLanguageServerComponents;
import org.springframework.ide.vscode.boot.validation.generations.SpringProjectsProvider;
import org.springframework.ide.vscode.boot.xml.SpringXMLLanguageServerComponents;
import org.springframework.ide.vscode.commons.java.IJavaProject;
import org.springframework.ide.vscode.commons.languageserver.completion.CompositeCompletionEngine;
@@ -119,7 +121,8 @@ public class BootLanguageServerInitializer implements InitializingBean {
new BootPropertiesLanguageServerComponents(server, params, javaElementLocationProvider, parser, yamlStructureProvider, yamlAssistContextProvider, sourceLinks),
new BootJavaLanguageServerComponents(appContext),
new SpringXMLLanguageServerComponents(server, springIndexer, params, config),
new SpringFactoriesLanguageServerComponents(projectFinder, springIndexer, config)
new SpringFactoriesLanguageServerComponents(projectFinder, springIndexer, config),
new PomLanguageServerComponents(server, projectFinder, params.projectObserver, appContext.getBean(SpringProjectsProvider.class))
);
for (LanguageServerComponents c : componentsList) {
@@ -144,7 +147,11 @@ public class BootLanguageServerInitializer implements InitializingBean {
components.getCodeActionProvider().ifPresent(documents::onCodeAction);
components.getCodeLensHandler().ifPresent(documents::onCodeLens);
components.getDocumentSymbolProvider().ifPresent(documents::onDocumentSymbol);
components.getInlayHintHandler().ifPresent(documents::onInlayHint);
startListeningToPerformReconcile();
@@ -164,8 +171,7 @@ public class BootLanguageServerInitializer implements InitializingBean {
documents.publishDiagnostics(d.getId(), Collections.emptyList());
}
});
}
private void startListeningToPerformReconcile() {

5
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/java/BootJavaLanguageServerComponents.java
View File

@@ -174,7 +174,6 @@ public class BootJavaLanguageServerComponents implements LanguageServerComponent
sourceLinks);
codeLensHandler = createCodeLensEngine(indexer);
documents.onCodeLens(codeLensHandler);
highlightsEngine = createDocumentHighlightEngine(indexer);
documents.onDocumentHighlight(highlightsEngine);
@@ -218,8 +217,8 @@ public class BootJavaLanguageServerComponents implements LanguageServerComponent
return hoverProvider;
}
public CodeLensHandler getCodeLensHandler() {
return codeLensHandler;
public Optional<CodeLensHandler> getCodeLensHandler() {
return Optional.of(codeLensHandler);
}
public DocumentHighlightHandler getDocumentHighlightHandler() {

170
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/maven/PomInlayHintHandler.java Normal file
View File

@@ -0,0 +1,170 @@
/*******************************************************************************
* 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.maven;
import java.net.URI;
import java.nio.file.Paths;
import java.util.Collections;
import java.util.List;
import java.util.Optional;
import org.eclipse.lemminx.dom.DOMDocument;
import org.eclipse.lemminx.dom.DOMElement;
import org.eclipse.lemminx.dom.DOMParser;
import org.eclipse.lsp4j.Command;
import org.eclipse.lsp4j.InlayHint;
import org.eclipse.lsp4j.InlayHintKind;
import org.eclipse.lsp4j.InlayHintLabelPart;
import org.eclipse.lsp4j.InlayHintParams;
import org.eclipse.lsp4j.jsonrpc.CancelChecker;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.ide.vscode.boot.validation.generations.GenerationsValidator;
import org.springframework.ide.vscode.boot.validation.generations.SpringProjectsProvider;
import org.springframework.ide.vscode.boot.validation.generations.VersionValidationUtils;
import org.springframework.ide.vscode.boot.validation.generations.json.Generation;
import org.springframework.ide.vscode.boot.validation.generations.json.ResolvedSpringProject;
import org.springframework.ide.vscode.commons.Version;
import org.springframework.ide.vscode.commons.java.IJavaProject;
import org.springframework.ide.vscode.commons.java.SpringProjectUtil;
import org.springframework.ide.vscode.commons.languageserver.java.JavaProjectFinder;
import org.springframework.ide.vscode.commons.languageserver.java.ProjectObserver;
import org.springframework.ide.vscode.commons.languageserver.util.InlayHintHandler;
import org.springframework.ide.vscode.commons.languageserver.util.SimpleLanguageServer;
import org.springframework.ide.vscode.commons.util.text.TextDocument;
public class PomInlayHintHandler implements InlayHintHandler {
private static final String POM_XML = "pom.xml";
private static final Logger log = LoggerFactory.getLogger(PomInlayHintHandler.class);
final private SimpleLanguageServer server;
final private JavaProjectFinder projectFinder;
final private SpringProjectsProvider generationsProvider;
public PomInlayHintHandler(SimpleLanguageServer server, JavaProjectFinder projectFinder, ProjectObserver projectObserver, SpringProjectsProvider generationsProvider) {
this.server = server;
this.projectFinder = projectFinder;
this.generationsProvider = generationsProvider;
projectObserver.addListener(new ProjectObserver.Listener() {
private void refreshOpenDocs(IJavaProject project) {
if (project.getProjectBuild() != null && project.getProjectBuild().getBuildFile() != null ) {
URI projectBuildFileUri = project.getProjectBuild().getBuildFile();
if (projectBuildFileUri.toString().endsWith(POM_XML)) {
server.getTextDocumentService().getAll().stream()
.map(doc -> URI.create(doc.getId().getUri()))
.filter(projectBuildFileUri::equals)
.findFirst().ifPresent(docPath -> {
log.info("Refresh inlays for: " + docPath);
server.getClient().refreshInlayHints();
});
}
}
}
@Override
public void deleted(IJavaProject project) {
refreshOpenDocs(project);
}
@Override
public void created(IJavaProject project) {
refreshOpenDocs(project);
}
@Override
public void changed(IJavaProject project) {
refreshOpenDocs(project);
}
});
}
@Override
public List<InlayHint> handle(CancelChecker token, InlayHintParams params) {
URI uri = URI.create(params.getTextDocument().getUri());
if ("file".equals(uri.getScheme()) && POM_XML.equals(Paths.get(uri).getFileName().toString())) {
log.info("INLAY for " + uri);
Optional<IJavaProject> projectOpt = projectFinder.find(params.getTextDocument());
if (projectOpt.isPresent()) {
URI buildFileUri = projectOpt.get().getProjectBuild().getBuildFile();
if (buildFileUri.equals(uri) && SpringProjectUtil.isBootProject(projectOpt.get())) {
Version currentVersion = SpringProjectUtil.getSpringBootVersion(projectOpt.get());
if (currentVersion != null) {
try {
ResolvedSpringProject genProject = generationsProvider.getProject(SpringProjectUtil.SPRING_BOOT);
if (genProject != null) {
Generation generation = GenerationsValidator.getGenerationForJavaProject(projectOpt.get(), genProject);
if (generation != null && VersionValidationUtils.isOssValid(generation)) {
TextDocument doc = server.getTextDocumentService().getLatestSnapshot(params.getTextDocument().getUri());
if (doc != null) {
String content = doc.get();
if (!content.isEmpty()) {
// if doc is not empty, dive into the details and provide more sophisticated content assist proposals
DOMParser parser = DOMParser.getInstance();
DOMDocument dom = parser.parse(content, "", null);
DOMElement project = dom.getDocumentElement();
if (project != null && "project".equals(project.getTagName())) {
for (int j = 0; j < project.getChildNodes().getLength(); j++) {
var child = project.getChildNodes().item(j);
if ("dependencies".equals(child.getNodeName()) && child instanceof DOMElement dependencies) {
try {
Command command = new Command();
command.setTitle("Add Spring Boot Starters");
command.setCommand("spring.initializr.addStarters");
InlayHintLabelPart label = new InlayHintLabelPart("Add Spring Boot Starters...");
label.setCommand(command);
InlayHint hint = new InlayHint();
hint.setPosition(doc.toPosition(dependencies.getStartTagCloseOffset() + 1));
hint.setKind(InlayHintKind.Parameter);
hint.setPaddingLeft(true);
hint.setLabel(List.of(label));
log.info("Sending inlay for " + uri);
return List.of(hint);
} catch (Exception e) {
log.error("", e);
break;
}
}
}
}
}
}
}
}
} catch (Exception e) {
log.error("", e);
}
}
}
}
}
return Collections.emptyList();
}
}

42
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/maven/PomLanguageServerComponents.java Normal file
View File

@@ -0,0 +1,42 @@
/*******************************************************************************
* 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.maven;
import java.util.Optional;
import java.util.Set;
import org.springframework.ide.vscode.boot.validation.generations.SpringProjectsProvider;
import org.springframework.ide.vscode.commons.languageserver.composable.LanguageServerComponents;
import org.springframework.ide.vscode.commons.languageserver.java.JavaProjectFinder;
import org.springframework.ide.vscode.commons.languageserver.java.ProjectObserver;
import org.springframework.ide.vscode.commons.languageserver.util.InlayHintHandler;
import org.springframework.ide.vscode.commons.languageserver.util.SimpleLanguageServer;
import org.springframework.ide.vscode.commons.util.text.LanguageId;
public class PomLanguageServerComponents implements LanguageServerComponents{
private PomInlayHintHandler inlayHintHandler;
public PomLanguageServerComponents(SimpleLanguageServer server, JavaProjectFinder projectFinder, ProjectObserver projectObserver, SpringProjectsProvider generationsProvider) {
this.inlayHintHandler = new PomInlayHintHandler(server, projectFinder, projectObserver, generationsProvider);
}
@Override
public Set<LanguageId> getInterestingLanguages() {
return Set.of(LanguageId.XML);
}
@Override
public Optional<InlayHintHandler> getInlayHintHandler() {
return Optional.of(inlayHintHandler);
}
}

4
headless-services/spring-boot-language-server/src/main/java/org/springframework/ide/vscode/boot/validation/generations/GenerationsValidator.java
View File

@@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2023 VMware, Inc.
* Copyright (c) 2023, 2024 VMware, 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
@@ -33,7 +33,7 @@ public class GenerationsValidator extends AbstractDiagnosticValidator {
this.provider = provider;
}
private static Generation getGenerationForJavaProject(IJavaProject javaProject, ResolvedSpringProject springProject)
public static Generation getGenerationForJavaProject(IJavaProject javaProject, ResolvedSpringProject springProject)
throws Exception {
List<Generation> genList = springProject.getGenerations();
Version javaProjectVersion = SpringProjectUtil.getDependencyVersion(javaProject, springProject.getSlug());