feat: Check Node Version (#8)

Check the Node version being ran and exit out if using an incompatible Node version.

Author: nsdeschenes

bundlers/next-js/tsconfig.json

@@ -22,6 +22,12 @@
       "@/*": ["./src/*"]
     }
   },
-  "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx", ".next/types/**/*.ts"],
+  "include": [
+    "next-env.d.ts",
+    "**/*.ts",
+    "**/*.tsx",
+    ".next/types/**/*.ts",
+    "next.config.js"
+  ],
   "exclude": ["node_modules"]
 }

bundlers/vite/package.json

@@ -26,5 +26,8 @@
     "@codecov/vite-plugin": "workspace:^",
     "typescript": "^5.0.2",
     "vite": "^4.4.5"
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

bundlers/webpack/package.json

@@ -16,5 +16,8 @@
   "dependencies": {
     "@codecov/webpack-plugin": "workspace:^",
     "lodash": "^4.17.21"
+  },
+  "volta": {
+    "extends": "../../package.json"
   }
 }

package.json

@@ -35,4 +35,4 @@
   "engines": {
     "node": ">=20.0.0"
   }
-}
+}

packages/bundler-plugin-core/package.json

@@ -35,11 +35,14 @@
   "author": "",
   "license": "Apache-2.0",
   "dependencies": {
+    "chalk": "4.1.2",
+    "semver": "^7.5.4",
     "unplugin": "^1.5.0",
     "zod": "^3.22.4"
   },
   "devDependencies": {
     "@types/node": "^20.8.6",
+    "@types/semver": "^7.5.5",
     "typescript": "^5.0.4",
     "unbuild": "^2.0.0"
   },

packages/bundler-plugin-core/src/index.ts

@@ -1,4 +1,7 @@
 import { type UnpluginOptions, createUnplugin } from "unplugin";
+import { satisfies } from "semver";
+import { z } from "zod";
+
 import {
   type BundleAnalysisUploadPlugin,
   type Asset,
@@ -9,17 +12,27 @@ import {
 } from "./types.js";
 
 import { jsonSchema } from "./schemas.js";
-import { z } from "zod";
+import { red } from "./utils/logging.js";
+
+const NODE_VERSION_RANGE = ">=18.18.0";
+
 interface CodecovUnpluginFactoryOptions {
   bundleAnalysisUploadPlugin: BundleAnalysisUploadPlugin;
 }
 
 export function codecovUnpluginFactory({
   bundleAnalysisUploadPlugin,
 }: CodecovUnpluginFactoryOptions) {
-  return createUnplugin<Options, true>((userOptions, _unpluginMetaContext) => {
+  return createUnplugin<Options, true>((userOptions, unpluginMetaContext) => {
     const plugins: UnpluginOptions[] = [];
 
+    if (!satisfies(process.version, NODE_VERSION_RANGE)) {
+      red(
+        `Codecov ${unpluginMetaContext.framework} bundler plugin requires Node.js ${NODE_VERSION_RANGE}. You are using Node.js ${process.version}. Please upgrade your Node.js version.`,
+      );
+      process.exit(1);
+    }
+
     if (userOptions?.enableBundleAnalysis) {
       const statsFileName = z
         .string()

packages/bundler-plugin-core/src/utils/logging.ts

@@ -0,0 +1,45 @@
+import Chalk from "chalk";
+
+export function prepareMessage(msg: unknown): string {
+  if (typeof msg === "string") {
+    return msg;
+  }
+  if (msg instanceof Error) {
+    return `${msg.stack ?? ""}`;
+  }
+  return JSON.stringify(msg, null, "\t");
+}
+
+export function l(msg: string): void {
+  console.log(msg);
+}
+
+export function nl(): void {
+  return l("");
+}
+
+export function green(msg: string): void {
+  return l(Chalk.green(prepareMessage(msg)));
+}
+
+export function red(msg: string): void {
+  return l(Chalk.red(prepareMessage(msg)));
+}
+
+export function dim(msg: string): void {
+  return l(Chalk.dim(prepareMessage(msg)));
+}
+
+export function yellow(msg: string): void {
+  return l(Chalk.yellow(prepareMessage(msg)));
+}
+
+export function cyan(msg: string): void {
+  return l(Chalk.cyan(prepareMessage(msg)));
+}
+
+// Disable eslint because we want to allow any type of message when debugging
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export function debug(msg: any): void {
+  return l(Chalk.italic.yellow(prepareMessage(msg)));
+}