Finish update command

Author: mskelton

src/PackageJsonCodeActionProvider.ts

@@ -1,51 +1,64 @@
-import semverGt from "semver/functions/gt"
 import vscode from "vscode"
-import { fetchPackage, parsePackage } from "./utils/packages"
+import { fetchPackage } from "./utils/packages"
+import { parseDependency } from "./utils/parseDependency"
+import { DIAGNOSTIC_CODE } from "./utils/vars"
 
 export class PackageJsonCodeActionProvider
   implements vscode.CodeActionProvider {
-  public async provideCodeActions(
-    document: vscode.TextDocument,
-    range: vscode.Range | vscode.Selection,
-    context: vscode.CodeActionContext
-  ): Promise<(vscode.Command | vscode.CodeAction)[]> {
-    const line = document.lineAt(range.start.line)
-    const localInfo = parsePackage(line.text)
-    const registryInfo = localInfo.name
-      ? await fetchPackage(localInfo.name)
-      : undefined
-
-    if (localInfo?.version && registryInfo?.version) {
-      const outdated = semverGt(registryInfo.version, localInfo.version)
-      console.log(localInfo.name, outdated)
-      // return vscode.commands.executeCommand("workbench.action")
+  provideCodeActions(
+    doc: vscode.TextDocument,
+    range: vscode.Range,
+    ctx: vscode.CodeActionContext
+  ): Promise<vscode.CodeAction[]> {
+    // TODO: Add a single command to update all the packages
+    if (!range.isSingleLine) {
+      return Promise.resolve([])
     }
 
-    // const actions = context.diagnostics.map((error) => {
-    //   return {
-    //     diagnostics: [error],
-    //     edit: {
-    //       edits: [
-    //         {
-    //           edits: [
-    //             {
-    //               range: error,
-    //               text: "This text replaces the text with the error",
-    //             },
-    //           ],
-    //           resource: document.uri,
-    //         },
-    //       ],
-    //     },
-    //     isPreferred: true,
-    //     kind: "quickfix",
-    //     title: `Example quick fix`,
-    //   }
-    // })
-
-    // return {
-    //   actions,
-    //   dispose() {},
-    // }
+    // For each diagnostic entry that has the matching `code`,
+    // create a code action command.
+    const promises = ctx.diagnostics
+      .filter((diagnostic) => diagnostic.code === DIAGNOSTIC_CODE)
+      .map((diagnostic) => this.createCommandCodeAction(doc, diagnostic))
+
+    return Promise.all(promises)
+  }
+
+  private async createCommandCodeAction(
+    doc: vscode.TextDocument,
+    diagnostic: vscode.Diagnostic
+  ) {
+    const action = new vscode.CodeAction(
+      "Update package to latest version",
+      vscode.CodeActionKind.QuickFix
+    )
+
+    action.edit = await this.createEdit(doc, diagnostic.range)
+    action.diagnostics = [diagnostic]
+    action.isPreferred = true
+
+    return action
+  }
+
+  private async createEdit(doc: vscode.TextDocument, range: vscode.Range) {
+    const edit = new vscode.WorkspaceEdit()
+
+    // Get the latest version from the registry
+    const line = doc.lineAt(range.start.line)
+    const { name, version } = parseDependency(line.text)
+
+    // This check shouldn't be necessary, but the types are overly strong
+    // so this is an extra safety check
+    if (name && version) {
+      // Keep the existing version prefix if it exists.
+      const prefix = ["~", "^"].includes(version[0]) ? version[0] : ""
+      const info = await fetchPackage(name)
+
+      if (info) {
+        edit.replace(doc.uri, range, prefix + info.version)
+      }
+    }
+
+    return edit
   }
 }

src/diagnostics/getPackageRanges.ts

@@ -1,13 +1,10 @@
 import vscode from "vscode"
+import { parseDependency } from "../utils/parseDependency"
 
 const isDependencyBlock = (line: vscode.TextLine) =>
   line.text.includes('"dependencies"') ||
   line.text.includes('"devDependencies"')
 
-const getPackageName = (text: string) => {
-  return text.match(/"(.+)":/)?.[1]
-}
-
 export function getPackageRanges(doc: vscode.TextDocument) {
   let inDependencyBlock = false
   const ranges: Record<string, vscode.Range> = {}
@@ -20,16 +17,16 @@ export function getPackageRanges(doc: vscode.TextDocument) {
     }
 
     if (inDependencyBlock) {
-      const packageName = getPackageName(line.text)
+      const { name, version } = parseDependency(line.text)
 
-      if (packageName) {
-        const startIndex = line.text.indexOf(packageName)
+      if (name && version) {
+        const startIndex = line.text.indexOf(version)
 
-        ranges[packageName] = new vscode.Range(
+        ranges[name] = new vscode.Range(
           line.lineNumber,
           startIndex,
           line.lineNumber,
-          startIndex + packageName.length
+          startIndex + version.length
         )
       }
     }

src/extension.ts

@@ -3,6 +3,8 @@ import { PackageJsonCodeActionProvider } from "./PackageJsonCodeActionProvider"
 import { findOutdatedPackages } from "./diagnostics/findOutdatedPackages"
 import { getPackageRanges } from "./diagnostics/getPackageRanges"
 import { subscribeToDocument } from "./diagnostics/subscribeToDocument"
+import { updatePackage } from "./packages/updatePackage"
+import { DIAGNOSTIC_CODE } from "./utils/vars"
 
 let diagnosticCollection: vscode.DiagnosticCollection
 
@@ -15,11 +17,13 @@ export function activate(ctx: vscode.ExtensionContext): void {
     const ranges = getPackageRanges(doc)
 
     const diagnostics = results.map((result) => {
-      return new vscode.Diagnostic(
+      const diagnostic = new vscode.Diagnostic(
         ranges[result.name],
         `Newer version of ${result.name} is available (${result.latestVersion}).`,
         vscode.DiagnosticSeverity.Information
       )
+      diagnostic.code = DIAGNOSTIC_CODE
+      return diagnostic
     })
 
     // Clear any old diagnostics before creating the new diagnostics
@@ -34,7 +38,16 @@ export function activate(ctx: vscode.ExtensionContext): void {
         pattern: "**/package.json",
         scheme: "file",
       },
-      new PackageJsonCodeActionProvider()
+      new PackageJsonCodeActionProvider(),
+      {
+        providedCodeActionKinds: [vscode.CodeActionKind.QuickFix],
+      }
     )
   )
+
+  ctx.subscriptions.push(
+    vscode.commands.registerCommand(COMMANDS.update, (name: string) => {
+      updatePackage(name)
+    })
+  )
 }

src/utils/packages.ts

@@ -1,26 +1,9 @@
 import cp from "child_process"
-import semverCoerce from "semver/functions/coerce"
 import { PackageCache } from "../PackageCache"
 import { PackageInfo } from "../models"
 
-const regex = /"(.+)":\s*"(.+)"/
 const cache = new PackageCache()
 
-export function parsePackage(text: string) {
-  const matches = text.match(regex)
-
-  if (matches) {
-    const [_, name, version] = matches
-
-    return {
-      name,
-      version: semverCoerce(version)?.version,
-    }
-  }
-
-  return {}
-}
-
 function npmView(name: string): Promise<PackageInfo | undefined> {
   const command = `npm view --json ${name} dist-tags.latest version`
 

src/utils/parseDependency.ts

@@ -0,0 +1,8 @@
+export function parseDependency(text: string) {
+  const matches = text.match(/"(.+)":\s*"(.+)"/)
+
+  return {
+    name: matches?.[1],
+    version: matches?.[2],
+  }
+}

src/utils/vars.ts

@@ -0,0 +1 @@
+export const DIAGNOSTIC_CODE = "npm-outdated"