@jsii/check-node 1.70.0 → 1.72.0

package/lib/constants.js

@@ -89,7 +89,7 @@ NodeRelease.ALL_RELEASES = [
     }),
     new NodeRelease(18, { endOfLife: new Date('2025-04-30') }),
     // Future (planned releases)
-    new NodeRelease(19, { endOfLife: new Date('2023-06-01'), untested: true }),
+    new NodeRelease(19, { endOfLife: new Date('2023-06-01') }),
     new NodeRelease(20, { endOfLife: new Date('2026-04-30'), untested: true }),
 ];
 //# sourceMappingURL=constants.js.map

package/lib/index.d.ts

@@ -2,6 +2,9 @@
  * Checks the current process' node runtime version against the release support
  * matrix, and issues a warning to STDERR if the current version is not fully
  * supported (i.e: it is deprecated, end-of-life, or untested).
+ *
+ * @param envPrefix will be prepended to environment variable names that can be
+ *                  used to silence version check warnings.
  */
-export declare function checkNode(): void;
+export declare function checkNode(envPrefix?: string): void;
 //# sourceMappingURL=index.d.ts.map

package/lib/index.js

@@ -9,9 +9,13 @@ const constants_1 = require("./constants");
  * Checks the current process' node runtime version against the release support
  * matrix, and issues a warning to STDERR if the current version is not fully
  * supported (i.e: it is deprecated, end-of-life, or untested).
+ *
+ * @param envPrefix will be prepended to environment variable names that can be
+ *                  used to silence version check warnings.
  */
-function checkNode() {
+function checkNode(envPrefix = 'JSII') {
     const { nodeRelease, knownBroken } = constants_1.NodeRelease.forThisRuntime();
+    const defaultCallToAction = 'Should you encounter odd runtime issues, please try using one of the supported release before filing a bug report.';
     if (nodeRelease === null || nodeRelease === void 0 ? void 0 : nodeRelease.endOfLife) {
         const qualifier = nodeRelease.endOfLifeDate
             ? ` on ${nodeRelease.endOfLifeDate.toISOString().slice(0, 10)}`
@@ -19,16 +23,24 @@ function checkNode() {
         veryVisibleMessage(chalk_1.bgRed.white.bold, `Node ${nodeRelease.majorVersion} has reached end-of-life${qualifier} and is not supported.`, `Please upgrade to a supported node version as soon as possible.`);
     }
     else if (knownBroken) {
-        veryVisibleMessage(chalk_1.bgRed.white.bold, `Node ${process_1.version} is unsupported and has known compatibility issues with this software.`);
+        const silenceVariable = `${envPrefix}_SILENCE_WARNING_KNOWN_BROKEN_NODE_VERSION`;
+        if (!process.env[silenceVariable])
+            veryVisibleMessage(chalk_1.bgRed.white.bold, `Node ${process_1.version} is unsupported and has known compatibility issues with this software.`, defaultCallToAction, silenceVariable);
     }
     else if (!nodeRelease || nodeRelease.untested) {
-        veryVisibleMessage(chalk_1.bgYellow.black, `This software has not been tested with node ${process_1.version}.`);
+        const silenceVariable = `${envPrefix}_SILENCE_WARNING_UNTESTED_NODE_VERSION`;
+        if (!process.env[silenceVariable]) {
+            veryVisibleMessage(chalk_1.bgYellow.black, `This software has not been tested with node ${process_1.version}.`, defaultCallToAction, silenceVariable);
+        }
     }
     else if (nodeRelease === null || nodeRelease === void 0 ? void 0 : nodeRelease.deprecated) {
-        const deadline = nodeRelease.endOfLifeDate.toISOString().slice(0, 10);
-        veryVisibleMessage(chalk_1.bgYellowBright.black, `Node ${nodeRelease.majorVersion} is approaching end-of-life and will no longer be supported in new releases after ${deadline}.`, `Please upgrade to a supported node version as soon as possible.`);
+        const silenceVariable = `${envPrefix}_SILENCE_WARNING_DEPRECATED_NODE_VERSION`;
+        if (!process.env[silenceVariable]) {
+            const deadline = nodeRelease.endOfLifeDate.toISOString().slice(0, 10);
+            veryVisibleMessage(chalk_1.bgYellowBright.black, `Node ${nodeRelease.majorVersion} is approaching end-of-life and will no longer be supported in new releases after ${deadline}.`, `Please upgrade to a supported node version as soon as possible.`, silenceVariable);
+        }
     }
-    function veryVisibleMessage(chalk, message, callToAction = 'You may to encounter runtime issues, and should switch to a supported release.') {
+    function veryVisibleMessage(chalk, message, callToAction, silenceVariable) {
         const lines = [
             message,
             callToAction,
@@ -43,6 +55,13 @@ function checkNode() {
                     ((_d = (_c = l.endOfLifeDate) === null || _c === void 0 ? void 0 : _c.getTime()) !== null && _d !== void 0 ? _d : 0);
             })
                 .map((release) => `- ${release.toString()}${release.deprecated ? ' [DEPRECATED]' : ''}`),
+            // Add blurb on how this message can be silenced (if it can be silenced).
+            ...(silenceVariable
+                ? [
+                    '',
+                    `This warning can be silenced by setting the ${silenceVariable} environment variable.`,
+                ]
+                : []),
         ];
         const len = Math.max(...lines.map((l) => l.length));
         const border = chalk('!'.repeat(len + 8));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsii/check-node",
-  "version": "1.70.0",
+  "version": "1.72.0",
   "description": "Checks for supported node versions",
   "license": "Apache-2.0",
   "author": {