feat: Warn that it requires npm install

After the package version is updated in the `package.json`, it warn the user to run `npm install`. Otherwise, nothing done!

Author: david-rodrigues

locales/bundle.l10n.jsonc

@@ -28,6 +28,7 @@
   "Package \"{0}\" pending installation: {1}.": "", // The package has been declared as a dependency, but no version has yet been installed.
   "Newer version of \"{0}\" is available: {1}.": "", // New version available which can be used by user.
   "Pre-release version of \"{0}\".": "", // The defined user version is a pre-release, and there is no better alternative yet.
+  "Ready-to-install package. Just run your package manager install command.": "", // User must run the `npm install` to install new packages based on version defined.
   "Security advisory: this package version has a known flaw level {0}/{1}.": "", // Diagnostic warning when a security advisory exists.
   "Please upgrade to version {0} or higher.": "", // Suggested upgrade to a version above.
   "No fix available yet.": "", // The flaw is not yet known to be resolved in a future release.
@@ -42,6 +43,7 @@
   "already installed, just formalization": "", // The version informed by the user is already installed, only a version formalization of package.json will be needed.
   "attention: major update!": "", // Warns the user that a major update will take place.
   "pre-release": "", // Warns the user that this is a pre-release version.
+  "Now run your package manager install command.": "", // User must run the `npm install` to install new packages based on version defined.
   "Security advisory": "", // Informs that the package has a security advisory.
   "low": "", // Security advisory level.
   "moderate": "", // Security advisory level.

locales/bundle.l10n.pt-br.json

@@ -5,7 +5,7 @@
   "Update {0} selected packages": "Atualizar as {0} dependências selecionadas",
   "Update all {0} packages": "Atualizar todas as {0} dependências",
 
-  "Save your package.json and run your package manager install command to finish updating packages.": "Salve o package.json e use o seu gerenciador de pacotes para concluir a instalação de suas dependências.",
+  "Save your package.json and run your package manager install command to finish updating packages.": "Salve o package.json e use o seu gerenciador de dependências para concluir a instalação de suas dependências.",
   "Do it for me!": "Faça para mim!",
 
   "Installing selected packages...": "Instalando as dependências selecionadas...",
@@ -19,6 +19,7 @@
   "Package \"{0}\" pending installation: {1}.": "Dependência \"{0}\" com instalação pendente: {1}",
   "Newer version of \"{0}\" is available: {1}.": "Versão mais nova disponível para a dependência \"{0}\": {1}",
   "Pre-release version of \"{0}\".": "Versão pre-release de \"{0}\".",
+  "Ready-to-install package. Just run your package manager install command.": "Pacote pronto para instalar. Basta executar o comando `install` do seu gerenciador de dependências.",
   "Security advisory: this package version has a known flaw level {0}/{1}.": "",
   "Please upgrade to version {0} or higher.": "Por favor, atualize para a versão {0} ou superior.",
   "No fix available yet.": "Ainda não há uma correção disponível.",
@@ -31,6 +32,7 @@
   "install pending": "instalação pendente",
   "already installed, just formalization": "já instalado, apenas formalização",
   "attention: major update!": "atenção: atualização major!",
+  "Now run your package manager install command.": "Agora, rode o comando `install` do seu gerenciador de dependências.",
   "Security advisory": "Aviso de segurança",
   "low": "baixo",
   "moderate": "moderado",

src/CodeAction.ts

@@ -23,13 +23,14 @@ export class PackageJsonCodeActionProvider implements CodeActionProvider {
     document: TextDocument,
     range: Range
   ): Promise<CodeAction[]> {
-    // Get all diagnostics from this extension
+    // Get all diagnostics from this extension.
     const diagnostics = languages
       .getDiagnostics(document.uri)
       .filter(
         (diagnostic) =>
           typeof diagnostic.code === "object" &&
-          diagnostic.code.value === DIAGNOSTIC_ACTION
+          diagnostic.code.value === DIAGNOSTIC_ACTION &&
+          (!PackageRelatedDiagnostic.is(diagnostic) || diagnostic.isSelectable)
       ) as PackageRelatedDiagnostic[]
 
     // Checks if an CodeAction comes through a diagnostic.

src/Diagnostic.ts

@@ -114,7 +114,8 @@ export class PackageRelatedDiagnostic extends Diagnostic {
     message: string,
     severity: DiagnosticSeverity,
     document: TextDocument,
-    public packageRelated: PackageInfo
+    public packageRelated: PackageInfo,
+    public isSelectable = true
   ) {
     super(range, message, severity)
 
@@ -173,6 +174,21 @@ export const getPackageDiagnostic = async (
   }
 
   if (!(await packageInfo.isVersionUpdatable())) {
+    // The user has the latest version defined in `package.json`,
+    // but still needs to run `npm install` to complete.
+    if (await packageInfo.requiresInstallCommand()) {
+      return new PackageRelatedDiagnostic(
+        packageInfo.versionRange,
+        l10n.t(
+          "Ready-to-install package. Just run your package manager install command."
+        ),
+        DiagnosticSeverity.Information,
+        document,
+        packageInfo,
+        false
+      )
+    }
+
     return
   }
 
@@ -200,7 +216,7 @@ export const getPackageDiagnostic = async (
     )
   }
 
-  // istanbul ignore next: must never happen
+  // istanbul ignore next
   return
 }
 

src/DocumentDecoration.ts

@@ -197,6 +197,17 @@ export class DocumentDecoration {
       ])
     }
 
+    if (await packageInfo.packageRelated.requiresInstallCommand()) {
+      return this.setLine(line, [
+        new Message(
+          Icons.PENDING,
+          ThemeLight.ICON_AVAILABLE,
+          ThemeDark.ICON_AVAILABLE
+        ),
+        new Message(l10n.t("Now run your package manager install command.")),
+      ])
+    }
+
     const updateDetails = [
       new Message(
         Icons.UPDATABLE,

src/PackageInfo.ts

@@ -102,6 +102,16 @@ export class PackageInfo {
     )
   }
 
+  // If the latest version is already to be installed.
+  public async requiresInstallCommand(): Promise<boolean> {
+    const versionClear = this.getVersionClear()
+
+    return (
+      (await this.getVersionLatest()) === versionClear &&
+      (await this.getVersionInstalled()) !== versionClear
+    )
+  }
+
   // Get the package version installed.
   public async getVersionInstalled(): Promise<string | undefined> {
     const packagesInstalled = await getPackagesInstalled()

src/Utils.test.ts

@@ -155,6 +155,6 @@ describe("utils", () => {
       { Accept: "application/vnd.npm.install-v1+json" }
     )
 
-    expect(fetchSuccess).toStrictEqual({})
+    expect(fetchSuccess).toBeInstanceOf(Object)
   })
 })

src/extension.test.ts

@@ -240,6 +240,19 @@ describe("package diagnostics", () => {
     expect(diagnostics).toHaveLength(0)
   })
 
+  it("valid dependency, waiting for run your package manager install", async () => {
+    const { decorations, diagnostics } = await vscodeSimulator({
+      packageJson: { dependencies: { "npm-outdated": "^1.0.1" } },
+      packagesInstalled: { "npm-outdated": "1.0.0" },
+      packagesRepository: { "npm-outdated": ["1.0.0", "1.0.1"] },
+    })
+
+    expect(diagnostics[0]?.message).toContain("run your package manager")
+    expect(decorations[0]).toContain(
+      "Now run your package manager install command."
+    )
+  })
+
   it("dependency name is invalid", async () => {
     const { decorations, diagnostics } = await vscodeSimulator({
       packageJson: { dependencies: { "invalid!": "^1.0.0" } },
@@ -616,7 +629,6 @@ describe("security advisories", () => {
 
   it("needs downgrade", async () => {
     const { decorations, diagnostics } = await vscodeSimulator({
-      cacheEnabled: true,
       packageJson: {
         dependencies: {
           "@types/jest": "1.0.0",