feat(vscode): add CLI version compatibility functions (#747)

Author: alestiago

extensions/vscode/package-lock.json

@@ -85,5 +85,8 @@
     "proxyquire": "^2.1.3",
     "sinon": "^15.1.2",
     "typescript": "^5.1.3"
+  },
+  "dependencies": {
+    "semver": "^7.5.4"
   }
 }

extensions/vscode/package.json

@@ -0,0 +1,55 @@
+const sinon = require("sinon");
+var proxyquire = require("proxyquire");
+
+import { afterEach, beforeEach } from "mocha";
+import * as assert from "assert";
+
+suite("readDartFrogVersion", () => {
+  let cpStub: any;
+  let cliVersion: any;
+
+  beforeEach(() => {
+    cpStub = {
+      execSync: sinon.stub(),
+    };
+
+    cliVersion = proxyquire("../../../utils/cli-version", {
+      // eslint-disable-next-line @typescript-eslint/naming-convention
+      child_process: cpStub,
+    });
+  });
+
+  afterEach(() => {
+    sinon.restore();
+  });
+
+  test("returns the version of Dart Frog CLI installed in the user's system", () => {
+    cpStub.execSync.returns("0.3.7");
+
+    assert.strictEqual(cliVersion.readDartFrogVersion(), "0.3.7");
+  });
+
+  test("returns undefined if Dart Frog CLI is not installed", () => {
+    cpStub.execSync.throws();
+
+    assert.strictEqual(cliVersion.readDartFrogVersion(), undefined);
+  });
+});
+
+suite("isCompatibleCLIVersion", () => {
+  let cliVersion: any;
+
+  beforeEach(() => {
+    cliVersion = proxyquire("../../../utils/cli-version", {});
+  });
+
+  test("returns true if the version of Dart Frog CLI installed in the user's system is compatible with this extension", () => {
+    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.8"), true);
+    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.7"), true);
+  });
+
+  test("returns false if the version of Dart Frog CLI installed in the user's system is not compatible with this extension", () => {
+    assert.strictEqual(cliVersion.isCompatibleCLIVersion("1.0.0"), false);
+    assert.strictEqual(cliVersion.isCompatibleCLIVersion("0.3.6"), false);
+  });
+});

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

@@ -0,0 +1,36 @@
+const cp = require("child_process");
+const semver = require("semver");
+
+/**
+ * The semantic version constraints for Dart Frog CLI to be compatible with this
+ * extension.
+ */
+const compatibleCLIVersion = ">=0.3.7 <1.0.0";
+
+/**
+ * Collects the version of Dart Frog CLI installed in the user's system.
+ *
+ * @returns {String | undefined} The semantic version of Dart Frog CLI installed
+ * in the user's system, or null if Dart Frog CLI is not installed.
+ */
+export function readDartFrogVersion(): String | undefined {
+  try {
+    return cp.execSync(`dart_frog --version`);
+  } catch (error) {
+    return undefined;
+  }
+}
+
+/**
+ * Checks if the version of Dart Frog CLI installed in the user's system is
+ * compatible with this extension.
+ *
+ * @param {String} version The semantic version of Dart Frog CLI installed in
+ * the user's system.
+ * @returns {Boolean} True if the version of Dart Frog CLI installed in the
+ * user's system is compatible with this extension, false otherwise.
+ * @see {@link readDartFrogVersion}, to collect the version of Dart Frog CLI.
+ */
+export function isCompatibleCLIVersion(version: String): Boolean {
+  return semver.satisfies(version, compatibleCLIVersion);
+}