fix: switch away from Node.js node:assert and AssertionError (#19082)

JoshuaKGoldberg · amareshsm · web-flow · commit bd35098f5b94 · 2024-11-13T08:38:35.000+01:00
* fix: switch away from Node.js node:assert and AssertionError

* Apply suggestions from code review

Co-authored-by: Amaresh  S M  &lt;amareshsm13@gmail.com&gt;

* Trim out unused portions of assert.js

* Switch to straightforward function

* Default ok message

---------

Co-authored-by: Amaresh  S M &lt;amareshsm13@gmail.com&gt;
diff --git a/lib/cli-engine/lint-result-cache.js b/lib/cli-engine/lint-result-cache.js
@@ -8,11 +8,11 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const assert = require("node:assert");
 const fs = require("node:fs");
 const fileEntryCache = require("file-entry-cache");
 const stringify = require("json-stable-stringify-without-jsonify");
 const pkg = require("../../package.json");
+const assert = require("../shared/assert");
 const hash = require("./hash");
 
 const debug = require("debug")("eslint:lint-result-cache");
diff --git a/lib/languages/js/source-code/token-store/index.js b/lib/languages/js/source-code/token-store/index.js
@@ -8,8 +8,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("node:assert");
 const { isCommentToken } = require("@eslint-community/eslint-utils");
+const assert = require("../../../../shared/assert");
 const cursors = require("./cursors");
 const ForwardTokenCursor = require("./forward-token-cursor");
 const PaddedTokenCursor = require("./padded-token-cursor");
diff --git a/lib/linter/code-path-analysis/code-path-analyzer.js b/lib/linter/code-path-analysis/code-path-analyzer.js
@@ -9,7 +9,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("node:assert"),
+const assert = require("../../shared/assert"),
     { breakableTypePattern } = require("../../shared/ast-utils"),
     CodePath = require("./code-path"),
     CodePathSegment = require("./code-path-segment"),
diff --git a/lib/linter/code-path-analysis/fork-context.js b/lib/linter/code-path-analysis/fork-context.js
@@ -13,7 +13,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("node:assert"),
+const assert = require("../../shared/assert"),
     CodePathSegment = require("./code-path-segment");
 
 //------------------------------------------------------------------------------
diff --git a/lib/linter/report-translator.js b/lib/linter/report-translator.js
@@ -9,7 +9,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("node:assert");
+const assert = require("../shared/assert");
 const { RuleFixer } = require("./rule-fixer");
 const { interpolate } = require("./interpolate");
 
diff --git a/lib/shared/assert.js b/lib/shared/assert.js
@@ -0,0 +1,22 @@
+/**
+ * @fileoverview Assertion utilities equivalent to the Node.js node:asserts module.
+ * @author Josh Goldberg
+ */
+
+"use strict";
+
+/**
+ * Throws an error if the input is not truthy.
+ * @param {unknown} value The input that is checked for being truthy.
+ * @param {string} message Message to throw if the input is not truthy.
+ * @returns {void}
+ * @throws {Error} When the condition is not truthy.
+ */
+function ok(value, message = "Assertion failed.") {
+    if (!value) {
+        throw new Error(message);
+    }
+}
+
+
+module.exports = ok;
