feat: add correct Range in pom.xml when possible

Author: FluoriteCafe-work

src/upgrade/display/diagnosticsManager.ts

@@ -4,7 +4,8 @@
 import { Diagnostic, DiagnosticSeverity, type Disposable, languages, Uri, Range } from "vscode";
 import type { FileIssues } from "../type";
 import { Upgrade } from "../../constants";
-import { buildMessage } from "../utility";
+import { buildMessage, normalizePath } from "../utility";
+import pomDataManager from "../pomDataManager";
 
 class DiagnosticsManager implements Disposable {
     private diagnostics = languages.createDiagnosticCollection('javaUpgrade');
@@ -15,9 +16,9 @@ class DiagnosticsManager implements Disposable {
 
     public refresh(filePath: string, issues: FileIssues) {
         this.diagnostics.set(Uri.parse(filePath), Object.entries(issues).map(([packageId, issue]) => {
+            const range = pomDataManager.getPomRange(normalizePath(filePath), issue.packageId);
             const diagnostic = new Diagnostic(
-                // TODO: locate the actual version settings
-                new Range(0, 0, 0, 0),
+                range ?? new Range(0, 0, 0, 0),
                 buildMessage(issue),
                 DiagnosticSeverity.Warning
             );

src/upgrade/metadataManager.ts

@@ -57,7 +57,7 @@ class MetadataManager {
             return {
                 name: Upgrade.DIAGNOSTICS_NAME_FOR_JAVA_ENGINE,
                 supportedVersion: `>=${Upgrade.EARLIEST_JAVA_VERSION_NOT_TO_PROMPT}`,
-                packageRuleUsed: Upgrade.DIAGNOSTICS_GROUP_ID_FOR_JAVA_ENGINE,
+                packageRuleUsed: buildPackageId(Upgrade.DIAGNOSTICS_GROUP_ID_FOR_JAVA_ENGINE, "*"),
             };
         }
 

src/upgrade/upgradeCodeLensProvider.ts

@@ -3,36 +3,57 @@
 
 import { CancellationToken, CodeLens, CodeLensProvider, ProviderResult, Range, TextDocument } from "vscode";
 import { Commands } from "../commands";
-import { buildFixPrompt } from "./utility";
+import { buildFixPrompt, normalizePath, toFirstLine } from "./utility";
 import issueManager from "./issueManager";
 import metadataManager from "./metadataManager";
 import { Upgrade } from "../constants";
+import pomDataManager from "./pomDataManager";
 
 export default class UpgradeCodeLensProvider implements CodeLensProvider {
     provideCodeLenses(document: TextDocument, _token: CancellationToken): ProviderResult<CodeLens[]> {
         const documentPath = document.uri.toString();
         const issues = issueManager.getIssues(documentPath);
-        return Object.values(issues).map((issue) => {
+        const topOfFileCodeLens: CodeLens[] = [];
+        const inlineCodeLens: CodeLens[] = [];
+        Object.values(issues).forEach((issue) => {
             const metadata = metadataManager.getMetadataById(issue.packageId);
             if (!metadata) {
                 return;
             }
-            const codeLens = new CodeLens(new Range(0, 0, 0, 0), {
-                title: "Upgrade",
-                command: Commands.VIEW_TRIGGER_JAVA_UPGRADE_TOOL,
-                tooltip: `Upgrade ${metadata.name} with GitHub Copilot`,
-                arguments: [buildFixPrompt(issue)],
-            });
+            const range = pomDataManager.getPomRange(normalizePath(documentPath), issue.packageId);
+            if (range) {
+                const codeLens = new CodeLens(
+                    toFirstLine(range),
+                    {
+                        title: "Upgrade",
+                        command: Commands.VIEW_TRIGGER_JAVA_UPGRADE_TOOL,
+                        tooltip: `Upgrade ${metadata.name} with GitHub Copilot`,
+                        arguments: [buildFixPrompt(issue)],
+                    });
+                inlineCodeLens.push(codeLens);
+            } else {
+                const codeLens = new CodeLens(
+                    new Range(0, 0, 0, 0),
+                    {
+                        title: "Upgrade",
+                        command: Commands.VIEW_TRIGGER_JAVA_UPGRADE_TOOL,
+                        tooltip: `Upgrade ${metadata.name} with GitHub Copilot`,
+                        arguments: [buildFixPrompt(issue)],
+                    });
+                topOfFileCodeLens.push(codeLens);
+            }
+        });
 
-            return codeLens;
-        })
-            .filter((x): x is CodeLens => Boolean(x))
-            .sort((a, b) => {
-                // always show Java engine upgrade first
+        return [
+            ...topOfFileCodeLens.sort((a, b) => {
+                // always show Java engine upgrade first, if any
                 if (a.command?.title === `Upgrade ${Upgrade.DIAGNOSTICS_NAME_FOR_JAVA_ENGINE}`) return -1;
                 if (b.command?.title === `Upgrade ${Upgrade.DIAGNOSTICS_NAME_FOR_JAVA_ENGINE}`) return 1;
                 return (a.command?.title ?? "") < (b.command?.title ?? "") ? -1 : 1;
             })
-            .slice(0, 1); // give 1 Code Lens action at most
+                // give 1 top-of-file Code Lens action at most
+                .slice(0, 1),
+            ...inlineCodeLens,
+        ];
     }
 }

src/upgrade/upgradeManager.ts

@@ -15,6 +15,7 @@ import metadataManager from "./metadataManager";
 import UpgradeCodeActionProvider from "./upgradeCodeActionProvider";
 import UpgradeCodeLensProvider from "./upgradeCodeLensProvider";
 import { buildPackageId } from "./utility";
+import pomDataManager from "./pomDataManager";
 
 const DEFAULT_UPGRADE_PROMPT = "Upgrade Java project dependency";
 
@@ -72,6 +73,7 @@ class UpgradeManager {
             if (!pomPath) {
                 return;
             }
+            await pomDataManager.parsePom(pomPath);
             this.checkJavaVersion(project, pomPath);
             const packageData = await Jdtls.getPackageData({ kind: NodeKind.Project, projectUri: project.uri });
             packageData

src/upgrade/utility.ts

@@ -1,8 +1,8 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
-import { Uri } from "vscode";
-import { UpgradeIssue, UpgradeReason } from "./type";
+import { Range, Uri } from "vscode";
+import { type UpgradeIssue, UpgradeReason } from "./type";
 
 export function buildMessage(issue: UpgradeIssue): string {
     const { packageId, packageDisplayName, currentVersion, reason } = issue;
@@ -48,4 +48,8 @@ export function buildPackageId(groupId: string, artifactId: string): string {
 
 export function normalizePath(path: string): string {
     return Uri.parse(path).toString();
+}
+
+export function toFirstLine(range: Range): Range {
+    return new Range(range.start.line, 0, range.start.line, 0);
 }