add check to soundness script for even numbered versions in the package.json

Author: matthewbastien

scripts/check_package_json.ts

@@ -0,0 +1,25 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the VS Code Swift open source project
+//
+// Copyright (c) 2025 the VS Code Swift project authors
+// Licensed under Apache License v2.0
+//
+// See LICENSE.txt for license information
+// See CONTRIBUTORS.txt for the list of VS Code Swift project authors
+//
+// SPDX-License-Identifier: Apache-2.0
+//
+//===----------------------------------------------------------------------===//
+/* eslint-disable no-console */
+
+import { getExtensionVersion, main } from "./lib/utilities";
+
+main(async () => {
+    const version = await getExtensionVersion();
+    if (version.minor % 2 !== 0) {
+        throw new Error(
+            `Invalid version number in package.json. ${version.toString()} does not have an even numbered minor version.`
+        );
+    }
+});

scripts/lib/utilities.ts

@@ -14,6 +14,9 @@
 /* eslint-disable no-console */
 
 import * as child_process from "child_process";
+import { readFile } from "fs/promises";
+import * as path from "path";
+import * as semver from "semver";
 
 /**
  * Executes the provided main function for the script while logging any errors.
@@ -31,6 +34,30 @@ export async function main(mainFn: () => Promise<void>): Promise<void> {
     }
 }
 
+/**
+ * Returns the root directory of the repository.
+ */
+export function getRootDirectory(): string {
+    return path.join(__dirname, "..", "..");
+}
+
+/**
+ * Retrieves the version number from the package.json.
+ */
+export async function getExtensionVersion(): Promise<semver.SemVer> {
+    const packageJSON = JSON.parse(
+        await readFile(path.join(getRootDirectory(), "package.json"), "utf-8")
+    );
+    if (typeof packageJSON.version !== "string") {
+        throw new Error("Version number in package.json is not a string");
+    }
+    const version = semver.parse(packageJSON.version);
+    if (version === null) {
+        throw new Error("Unable to parse version number in package.json");
+    }
+    return version;
+}
+
 /**
  * Executes the given command, inheriting the current process' stdio.
  *

scripts/preview_package.ts

@@ -13,10 +13,7 @@
 //===----------------------------------------------------------------------===//
 /* eslint-disable no-console */
 
-import * as path from "path";
-import * as semver from "semver";
-import { readFile } from "fs/promises";
-import { exec, main } from "./lib/utilities";
+import { exec, getExtensionVersion, getRootDirectory, main } from "./lib/utilities";
 
 /**
  * Formats the given date as a string in the form "YYYYMMddhhmm".
@@ -34,18 +31,8 @@ function formatDate(date: Date): string {
 }
 
 main(async () => {
-    const rootDirectory = path.join(__dirname, "..");
-    // Grab the existing version number from the package.json
-    const packageJSON = JSON.parse(
-        await readFile(path.join(rootDirectory, "package.json"), "utf-8")
-    );
-    if (typeof packageJSON.version !== "string") {
-        throw new Error("Version number in package.json is not a string");
-    }
-    const version = semver.parse(packageJSON.version);
-    if (version === null) {
-        throw new Error("Unable to parse version number in package.json");
-    }
+    const rootDirectory = getRootDirectory();
+    const version = await getExtensionVersion();
     // Increment the minor version and set the patch version to today's date
     const minor = version.minor + 1;
     const patch = formatDate(new Date());

scripts/soundness.sh

@@ -36,6 +36,9 @@ function replace_acceptable_years() {
     sed -e 's/20[12][0123456789]-20[12][0123456789]/YEARS/' -e 's/20[12][0123456789]/YEARS/'
 }
 
+printf "=> Checking package.json..."
+npm run check-package-json
+
 printf "=> Checking license headers... "
 tmp=$(mktemp /tmp/.vscode-swift-soundness_XXXXXX)