feat(vscode): add update-cli command (#751)

Author: alestiago

extensions/vscode/README.md

@@ -14,6 +14,7 @@ Dart Frog can be installed from the [VS Code Marketplace](https://marketplace.vi
 | Command                     | Description                |
 | --------------------------- | -------------------------- |
 | `Dart Frog: Install CLI`    | Installs Dart Frog CLI     |
+| `Dart Frog: Update CLI`     | Updates Dart Frog CLI      |
 | `Dart Frog: New Route`      | Generates a new route      |
 | `Dart Frog: New Middleware` | Generates a new middleware |
 

extensions/vscode/package.json

@@ -35,6 +35,10 @@
         "command": "extension.install-cli",
         "title": "Dart Frog: Install CLI"
       },
+      {
+        "command": "extension.update-cli",
+        "title": "Dart Frog: Update CLI"
+      },
       {
         "command": "extension.new-route",
         "title": "Dart Frog: New Route"

extensions/vscode/src/commands/index.ts

@@ -1,3 +1,4 @@
 export * from "./install-cli";
+export * from "./update-cli";
 export * from "./new-route";
 export * from "./new-middleware";

extensions/vscode/src/commands/install-cli.ts

@@ -1,13 +1,13 @@
 const cp = require("child_process");
 
 import { window, ProgressOptions } from "vscode";
-import { isDartFrogCliInstalled } from "../utils/utils";
+import { isDartFrogCLIInstalled } from "../utils/utils";
 
 /**
  * Installs Dart Frog CLI in the user's system if not already installed.
  */
 export const installCLI = async (): Promise<void> => {
-  if (!isDartFrogCliInstalled()) {
+  if (!isDartFrogCLIInstalled()) {
     const options: ProgressOptions = {
       location: 15,
       title: "Installing Dart Frog CLI...",

extensions/vscode/src/commands/update-cli.ts

@@ -0,0 +1,38 @@
+const cp = require("child_process");
+
+import { window, ProgressOptions } from "vscode";
+import { isDartFrogCLIInstalled } from "../utils/utils";
+
+/**
+ * Update Dart Frog CLI in the user's system.
+ *
+ * If Dart Frog CLI is not installed, this function does nothing.
+ */
+export const updateCLI = async (): Promise<void> => {
+  if (!isDartFrogCLIInstalled()) {
+    return;
+  }
+
+  const options: ProgressOptions = {
+    location: 15,
+    title: "Updating Dart Frog CLI...",
+  };
+  window.withProgress(options, updateDartFrogCLIVersion);
+};
+
+/**
+ * Updates Dart Frog CLI to the latest version.
+ *
+ * @returns {Promise<void>} A promise that resolves when the update is
+ * complete.
+ */
+async function updateDartFrogCLIVersion(): Promise<void> {
+  await cp.exec(
+    `dart_frog update`,
+    function (error: Error, stdout: String, stderr: String) {
+      if (error) {
+        window.showErrorMessage(error.message);
+      }
+    }
+  );
+}

extensions/vscode/src/extension.ts

@@ -1,5 +1,5 @@
 import * as vscode from "vscode";
-import { installCLI, newRoute, newMiddleware } from "./commands";
+import { installCLI, newRoute, newMiddleware, updateCLI } from "./commands";
 
 /**
  * This method is called when the extension is activated.
@@ -16,6 +16,7 @@ export function activate(
 
   context.subscriptions.push(
     vscode.commands.registerCommand("extension.install-cli", installCLI),
+    vscode.commands.registerCommand("extension.update-cli", updateCLI),
     vscode.commands.registerCommand("extension.new-route", newRoute),
     vscode.commands.registerCommand("extension.new-middleware", newMiddleware)
   );

extensions/vscode/src/test/suite/commands/install-cli.test.ts

@@ -5,7 +5,7 @@ import { afterEach, beforeEach } from "mocha";
 import * as assert from "assert";
 
 suite("install-cli command", () => {
-  const updateCommand = `dart pub global activate dart_frog_cli`;
+  const installCommand = `dart pub global activate dart_frog_cli`;
 
   let vscodeStub: any;
   let childProcessStub: any;
@@ -24,7 +24,7 @@ suite("install-cli command", () => {
       execSync: sinon.stub(),
     };
     utilsStub = {
-      isDartFrogCliInstalled: sinon.stub(),
+      isDartFrogCLIInstalled: sinon.stub(),
     };
 
     command = proxyquire("../../../commands/install-cli", {
@@ -41,19 +41,19 @@ suite("install-cli command", () => {
   });
 
   test("does not install if Dart Frog CLI is already installed", async () => {
-    utilsStub.isDartFrogCliInstalled.returns(true);
+    utilsStub.isDartFrogCLIInstalled.returns(true);
 
     await command.installCLI();
 
     const wantedCalls = childProcessStub.exec
       .getCalls()
-      .filter((call: any) => call.args[0] === updateCommand);
+      .filter((call: any) => call.args[0] === installCommand);
     assert.equal(wantedCalls.length, 0);
   });
 
   suite("installs Dart Frog CLI", () => {
     beforeEach(() => {
-      utilsStub.isDartFrogCliInstalled.returns(false);
+      utilsStub.isDartFrogCLIInstalled.returns(false);
     });
 
     test("when not already installed", async () => {
@@ -62,7 +62,7 @@ suite("install-cli command", () => {
       let progressFunction = vscodeStub.window.withProgress.getCall(0).args[1];
       await progressFunction();
 
-      sinon.assert.calledWith(childProcessStub.exec, updateCommand);
+      sinon.assert.calledWith(childProcessStub.exec, installCommand);
     });
 
     test("shows progress", async () => {
@@ -76,7 +76,7 @@ suite("install-cli command", () => {
 
     test("shows error message on failure", async () => {
       const error = new Error("Command failed");
-      childProcessStub.exec.withArgs(updateCommand).yields(error);
+      childProcessStub.exec.withArgs(installCommand).yields(error);
 
       await command.installCLI();
 

extensions/vscode/src/test/suite/commands/update-cli.test.ts

@@ -0,0 +1,92 @@
+const sinon = require("sinon");
+var proxyquire = require("proxyquire");
+
+import { afterEach, beforeEach } from "mocha";
+import * as assert from "assert";
+
+suite("update-cli", () => {
+  const updateCommand = `dart_frog update`;
+
+  let vscodeStub: any;
+  let childProcessStub: any;
+  let utilsStub: any;
+  let command: any;
+
+  beforeEach(() => {
+    vscodeStub = {
+      window: {
+        showErrorMessage: sinon.stub(),
+        withProgress: sinon.stub(),
+      },
+    };
+    childProcessStub = {
+      exec: sinon.stub(),
+      execSync: sinon.stub(),
+    };
+    utilsStub = {
+      isDartFrogCLIInstalled: sinon.stub(),
+    };
+
+    command = proxyquire("../../../commands/update-cli", {
+      vscode: vscodeStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      child_process: childProcessStub,
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      "../utils/utils": utilsStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  suite("updates Dart Frog CLI", () => {
+    beforeEach(() => {
+      utilsStub.isDartFrogCLIInstalled.returns(true);
+    });
+
+    test("when already installed", async () => {
+      await command.updateCLI();
+
+      let progressFunction = vscodeStub.window.withProgress.getCall(0).args[1];
+      await progressFunction();
+
+      sinon.assert.calledWith(childProcessStub.exec, updateCommand);
+    });
+
+    test("shows progress", async () => {
+      await command.updateCLI();
+
+      const progressOptions = vscodeStub.window.withProgress.getCall(0).args[0];
+
+      assert.strictEqual(progressOptions.title, "Updating Dart Frog CLI...");
+      assert.strictEqual(progressOptions.location, 15);
+    });
+
+    test("shows error message on failure", async () => {
+      const error = new Error("Command failed");
+      childProcessStub.exec.withArgs(updateCommand).yields(error);
+
+      await command.updateCLI();
+
+      const progressFunction =
+        vscodeStub.window.withProgress.getCall(0).args[1];
+      await progressFunction();
+
+      sinon.assert.calledWith(
+        vscodeStub.window.showErrorMessage,
+        error.message
+      );
+    });
+  });
+
+  test("does nothing when not installed", async () => {
+    utilsStub.isDartFrogCLIInstalled.returns(false);
+
+    await command.updateCLI();
+
+    sinon.assert.notCalled(childProcessStub.exec);
+    sinon.assert.notCalled(vscodeStub.window.withProgress);
+    sinon.assert.notCalled(vscodeStub.window.showErrorMessage);
+  });
+});

extensions/vscode/src/test/suite/extension.test.ts

@@ -3,7 +3,7 @@ var proxyquire = require("proxyquire");
 
 import * as assert from "assert";
 import * as vscode from "vscode";
-import { installCLI, newMiddleware, newRoute } from "../../commands";
+import { installCLI, newMiddleware, newRoute, updateCLI } from "../../commands";
 import { afterEach, beforeEach } from "mocha";
 
 suite("activate", () => {
@@ -51,6 +51,16 @@ suite("activate", () => {
       );
     });
 
+    test("update-cli", async () => {
+      extension.activate(context);
+
+      sinon.assert.calledWith(
+        vscodeStub.commands.registerCommand,
+        "extension.update-cli",
+        updateCLI
+      );
+    });
+
     test("new-route", async () => {
       extension.activate(context);
 

extensions/vscode/src/utils/cli-version.ts

@@ -41,6 +41,6 @@ export function isCompatibleCLIVersion(version: String): Boolean {
  * @returns {boolean} True if the user has Dart Frog CLI installed in their
  * system, false otherwise.
  */
-export function isDartFrogCliInstalled(): boolean {
+export function isDartFrogCLIInstalled(): boolean {
   return readDartFrogVersion() !== undefined;
 }