fix: Avoid "install packages" action option when no packages are selected

Author: david-rodrigues

locales/bundle.l10n.jsonc

@@ -34,7 +34,8 @@
   "No fix available yet.": "", // The flaw is not yet known to be resolved in a future release.
   "If possible, downgrade to version {0}.": "", // But it is possible to downgrade to a version where the flaw does not exist.
   "Details": "", // Link where you can learn more about the flaw.
-  "Install packages": "", //  Forces the display of the notification suggesting to update the package.
+  "Install package": "", //  Forces the display of the notification suggesting to update the package (one package to be installed).
+  "Install packages": "", //  Forces the display of the notification suggesting to update the package (two or more packages to be installed).
 
   // DocumentDecoration.ts related.
   "Install pending": "", // The package was never installed, but the version entered by the user is the latest available.

locales/bundle.l10n.pt-br.json

@@ -25,6 +25,7 @@
   "No fix available yet.": "Ainda não há uma correção disponível.",
   "If possible, downgrade to version {0}.": "Se possível, realize um downgrade para a versão {0}.",
   "Details": "Detalhes",
+  "Install package": "Instalar dependência",
   "Install packages": "Instalar dependências",
 
   "Install pending": "Instalação pendente",

src/CodeAction.ts

@@ -10,7 +10,7 @@ import {
 } from "vscode"
 
 import { COMMAND_INSTALL_REQUEST } from "./Command"
-import { PackageRelatedDiagnostic } from "./Diagnostic"
+import { DiagnosticType, PackageRelatedDiagnostic } from "./Diagnostic"
 import { name as packageName } from "./plugin.json"
 import { hasMajorUpdateProtection } from "./Settings"
 
@@ -30,7 +30,8 @@ export class PackageJsonCodeActionProvider implements CodeActionProvider {
       (diagnostic) =>
         typeof diagnostic.code === "object" &&
         diagnostic.code.value === DIAGNOSTIC_ACTION &&
-        (!PackageRelatedDiagnostic.is(diagnostic) || diagnostic.isSelectable)
+        (!PackageRelatedDiagnostic.is(diagnostic) ||
+          diagnostic.type === DiagnosticType.GENERAL)
     ) as PackageRelatedDiagnostic[]
 
     // Checks if an CodeAction comes through a diagnostic.
@@ -39,21 +40,27 @@ export class PackageJsonCodeActionProvider implements CodeActionProvider {
     )
 
     // Checks if there are any packages waiting to be installed.
-    let requiresInstall = false
+    let requiresInstallCount = 0
 
     for (const diagnostic of diagnosticsAll) {
       if (
         PackageRelatedDiagnostic.is(diagnostic) &&
-        (await diagnostic.packageRelated.requiresInstallCommand())
+        diagnostic.type === DiagnosticType.READY_TO_INSTALL &&
+        diagnostic.range.intersection(range) !== undefined
       ) {
-        requiresInstall = true
-        break
+        requiresInstallCount++
+
+        if (requiresInstallCount >= 2) {
+          break
+        }
       }
     }
 
     if (!diagnosticsSelected.length) {
-      if (requiresInstall) {
-        return Promise.all([this.createInstallAction(document)])
+      if (requiresInstallCount) {
+        return Promise.all([
+          this.createInstallAction(document, requiresInstallCount),
+        ])
       }
 
       return Promise.resolve([])
@@ -161,8 +168,10 @@ export class PackageJsonCodeActionProvider implements CodeActionProvider {
       }
     }
 
-    if (requiresInstall) {
-      diagnosticsPromises.push(this.createInstallAction(document))
+    if (requiresInstallCount) {
+      diagnosticsPromises.push(
+        this.createInstallAction(document, requiresInstallCount)
+      )
     }
 
     return Promise.all(diagnosticsPromises)
@@ -247,10 +256,13 @@ export class PackageJsonCodeActionProvider implements CodeActionProvider {
   }
 
   private async createInstallAction(
-    document: TextDocument
+    document: TextDocument,
+    requiresInstallCount: number
   ): Promise<CodeAction> {
     const action = new CodeAction(
-      l10n.t("Install packages"),
+      requiresInstallCount === 1
+        ? l10n.t("Install package")
+        : l10n.t("Install packages"),
       CodeActionKind.QuickFix
     )
 

src/Diagnostic.ts

@@ -108,14 +108,19 @@ export const diagnosticSubscribe = (
   )
 }
 
+export enum DiagnosticType {
+  GENERAL,
+  READY_TO_INSTALL,
+}
+
 export class PackageRelatedDiagnostic extends Diagnostic {
   constructor(
     range: Range,
     message: string,
     severity: DiagnosticSeverity,
     document: TextDocument,
     public packageRelated: PackageInfo,
-    public isSelectable = true
+    public type = DiagnosticType.GENERAL
   ) {
     super(range, message, severity)
 
@@ -185,7 +190,7 @@ export const getPackageDiagnostic = async (
         DiagnosticSeverity.Information,
         document,
         packageInfo,
-        false
+        DiagnosticType.READY_TO_INSTALL
       )
     }
 

src/extension.test.ts

@@ -183,6 +183,21 @@ describe("package diagnostics", () => {
 
     expect(diagnostics[0]?.message).toContain("1.0.1")
     expect(decorations[0]).toContain("Update available:")
+    expect(decorations[0]).not.toContain("(attention: major update!)")
+  })
+
+  it("valid dependency, upgrading to major pre-release", async () => {
+    const { decorations } = await vscodeSimulator({
+      packageJson: { dependencies: { "npm-outdated": "^2.0.0-alpha" } },
+      packagesInstalled: { "npm-outdated": "1.0.0" },
+      packagesRepository: {
+        "npm-outdated": ["1.0.0", "2.0.0-alpha", "2.0.0"],
+      },
+    })
+
+    expect(decorations[0]).toContain("Update available:")
+    expect(decorations[0]).toContain("2.0.0")
+    expect(decorations[0]).toContain("(attention: major update!)")
   })
 
   it("valid dependency, latest available version", async () => {
@@ -349,14 +364,60 @@ describe("code actions", () => {
     expect(actions).toHaveLength(0)
   })
 
-  it("no package selected, awaiting for installing packages", async () => {
+  it("no package selected, must not have any action", async () => {
     const { actions } = await vscodeSimulator({
       packageJson: { dependencies: { "npm-outdated": "^1.0.1" } },
       packagesInstalled: { "npm-outdated": "1.0.0" },
       packagesRepository: { "npm-outdated": ["1.0.0", "1.0.1"] },
       selectFirsts: 0,
     })
 
+    expect(actions).toHaveLength(0)
+  })
+
+  it("selected a specific package, ready to install", async () => {
+    const { actions } = await vscodeSimulator({
+      packageJson: {
+        dependencies: {
+          "@types/jest": "^1.0.1",
+          "npm-outdated": "^1.0.0",
+        },
+      },
+      packagesInstalled: {
+        "@types/jest": "1.0.0",
+        "npm-outdated": "1.0.0",
+      },
+      packagesRepository: {
+        "@types/jest": ["1.0.0", "1.0.1"],
+        "npm-outdated": ["1.0.0", "1.0.1"],
+      },
+      selectFirsts: 2,
+    })
+
+    expect(actions[0]?.title).toBe('Update "npm-outdated" to 1.0.1')
+    expect(actions[1]?.title).toBe("Install package")
+    expect(actions).toHaveLength(2)
+  })
+
+  it("selected two packages, ready to install", async () => {
+    const { actions } = await vscodeSimulator({
+      packageJson: {
+        dependencies: {
+          "@types/jest": "^1.0.1",
+          "npm-outdated": "^1.0.1",
+        },
+      },
+      packagesInstalled: {
+        "@types/jest": "1.0.0",
+        "npm-outdated": "1.0.0",
+      },
+      packagesRepository: {
+        "@types/jest": ["1.0.0", "1.0.1"],
+        "npm-outdated": ["1.0.0", "1.0.1"],
+      },
+      selectFirsts: 2,
+    })
+
     expect(actions[0]?.title).toBe("Install packages")
     expect(actions).toHaveLength(1)
   })
@@ -471,7 +532,7 @@ describe("code actions", () => {
     })
 
     expect(actions[0]?.title).toBe("Update 2 selected packages")
-    expect(actions[1]?.title).toBe("Install packages")
+    expect(actions[1]?.title).toBe("Install package")
     expect(actions).toHaveLength(2)
   })