feat: show reasons for the versions we choose

src/upgrade/dependency.metadata.ts

@@ -10,32 +10,48 @@ export const DEPENDENCY_JAVA_RUNTIME = {
     "name": "Java Runtime",
     "reason": UpgradeReason.JRE_TOO_OLD,
     "supportedVersion": `>=${LATEST_JAVA_LTS_VESRION}`,
-    "suggestedVersion": String(LATEST_JAVA_LTS_VESRION),
+    "suggestedVersion": {
+        "name": String(LATEST_JAVA_LTS_VESRION),
+        "description": "latest LTS version",
+    },
 } as const;
 
 const DEPENDENCIES_TO_SCAN: DependencyCheckMetadata = {
     "org.springframework.boot:*": {
         "reason": UpgradeReason.END_OF_LIFE,
         "name": "Spring Boot",
         "supportedVersion": "2.7.x || >=3.2.x",
-        "suggestedVersion": "3.5",
+        "suggestedVersion": {
+            "name": "3.5",
+            "description": "latest stable release",
+        },
     },
     "org.springframework:*": {
         "reason": UpgradeReason.END_OF_LIFE,
         "name": "Spring Framework",
         "supportedVersion": "5.3.x || >=6.2.x",
-        "suggestedVersion": "6.2"
+        "suggestedVersion": {
+            "name": "3.5",
+            "description": "latest stable release",
+        },
     },
     "org.springframework.security:*": {
         "reason": UpgradeReason.END_OF_LIFE,
         "name": "Spring Security",
         "supportedVersion": "5.7.x || 5.8.x || >=6.2.x",
-        "suggestedVersion": "6.5"
+        "suggestedVersion": {
+            "name": "3.5",
+            "description": "latest stable release",
+        },
     },
     "javax:*": {
         "reason": UpgradeReason.DEPRECATED,
         "name": "Java EE",
-        "alternative": "Jakarta EE 10",
+        "alternative": {
+            "name": "Jakarta EE 10",
+            "description": "latest release with wide Java runtime version support",
+
+        },
     },
     [Upgrade.PACKAGE_ID_FOR_JAVA_RUNTIME]: DEPENDENCY_JAVA_RUNTIME,
 };

src/upgrade/type.ts

@@ -1,10 +1,11 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT license.
 
+export type UpgradeTarget = { name: string; description: string };
 export type DependencyCheckItemBase = { name: string, reason: UpgradeReason };
 export type DependencyCheckItemEol = DependencyCheckItemBase
-    & { reason: UpgradeReason.END_OF_LIFE | UpgradeReason.JRE_TOO_OLD, supportedVersion: string, suggestedVersion: string };
-export type DependencyCheckItemDeprecated = DependencyCheckItemBase & { reason: UpgradeReason.DEPRECATED, alternative: string };
+    & { reason: UpgradeReason.END_OF_LIFE | UpgradeReason.JRE_TOO_OLD, supportedVersion: string, suggestedVersion: UpgradeTarget };
+export type DependencyCheckItemDeprecated = DependencyCheckItemBase & { reason: UpgradeReason.DEPRECATED, alternative: UpgradeTarget };
 export type DependencyCheckItem = (DependencyCheckItemEol | DependencyCheckItemDeprecated);
 export type DependencyCheckMetadata = Record<string, DependencyCheckItem>;
 
@@ -17,10 +18,10 @@ export enum UpgradeReason {
 
 export type UpgradeIssue = {
     packageId: string;
-    packageDisplayName?: string;
+    packageDisplayName: string;
     reason: UpgradeReason;
     currentVersion: string;
-    suggestedVersion?: string;
+    suggestedVersion: UpgradeTarget;
 };
 
 export interface IUpgradeIssuesRenderer {

src/upgrade/utility.ts

@@ -6,31 +6,37 @@ import { UpgradeReason, type UpgradeIssue } from "./type";
 import { Upgrade } from "../constants";
 
 export function buildNotificationMessage(issue: UpgradeIssue): string {
-    const { packageId, currentVersion, suggestedVersion, packageDisplayName } = issue;
-    const name = packageDisplayName ?? packageId;
+    const { packageId, currentVersion, reason, suggestedVersion: { name: suggestedVersionName, description: suggestedVersionDescription }, packageDisplayName } = issue;
 
     if (packageId === Upgrade.PACKAGE_ID_FOR_JAVA_RUNTIME) {
-        return `The current project is using an older runtime (Java ${currentVersion}). Do you want to upgrade to the latest LTS version${suggestedVersion ? ` (${suggestedVersion})` : ""}?`;
+        return `The current project is using an older Java runtime (${currentVersion}). Do you want to upgrade to the latest LTS version ${suggestedVersionName}?`;
     }
 
-    return `The current project is using ${name} ${currentVersion}, which has reached end of life. Do you want to upgrade to ${suggestedVersion ? ` ${suggestedVersion}` : "the latest version"
-        }?`;
+    switch (reason) {
+        case UpgradeReason.CVE: {
+            return `The current project is using ${packageDisplayName} ${currentVersion}, which has CVE issues. Do you want to upgrade to ${suggestedVersionName} (${suggestedVersionDescription})?`;
+        }
+        case UpgradeReason.DEPRECATED:
+        case UpgradeReason.END_OF_LIFE:
+        default: {
+            return `The current project is using ${packageDisplayName} ${currentVersion}, which has reached end of life. Do you want to upgrade to ${suggestedVersionName} (${suggestedVersionDescription})?`;
+        }
+    }
 }
 
+
 export function buildFixPrompt(issue: UpgradeIssue): string {
-    const { packageId, packageDisplayName, reason, suggestedVersion } = issue;
-    const name = packageDisplayName ?? packageId;
+    const { packageDisplayName, reason, suggestedVersion: { name: suggestedVersionName } } = issue;
 
     switch (reason) {
         case UpgradeReason.CVE: {
-            return `upgrade package ${name} to ${suggestedVersion ?? "the latest version"} to address CVE issues using java upgrade tools`;
+            return `upgrade ${packageDisplayName} to ${suggestedVersionName} to address CVE issues using java upgrade tools`;
         }
         case UpgradeReason.JRE_TOO_OLD: {
-            return `upgrade java runtime to latest LTS version${suggestedVersion ? ` (${suggestedVersion})` : ""
-                } using java upgrade tools`;
+            return `upgrade java runtime to the latest LTS version ${suggestedVersionName} using java upgrade tools`;
         }
         default: {
-            return `upgrade package ${name} to ${suggestedVersion ?? "the latest version"} using java upgrade tools`;
+            return `upgrade ${packageDisplayName} to ${suggestedVersionName} using java upgrade tools`;
         }
     }
 }