refactor: Use node: protocol for built-in Node.js modules (#18434)

Author: mdjermanovic

.eslintrc.js

@@ -16,7 +16,7 @@
 
 "use strict";
 
-const path = require("path");
+const path = require("node:path");
 
 const INTERNAL_FILES = {
     CLI_ENGINE_PATTERN: "lib/cli-engine/**/*",

Makefile.js

@@ -12,12 +12,12 @@
 
 const checker = require("npm-license"),
     ReleaseOps = require("eslint-release"),
-    fs = require("fs"),
+    fs = require("node:fs"),
     glob = require("glob"),
     marked = require("marked"),
     matter = require("gray-matter"),
-    os = require("os"),
-    path = require("path"),
+    os = require("node:os"),
+    path = require("node:path"),
     semver = require("semver"),
     ejs = require("ejs"),
     loadPerf = require("load-perf"),
@@ -885,7 +885,7 @@ target.checkRuleFiles = function() {
 };
 
 target.checkRuleExamples = function() {
-    const { execFileSync } = require("child_process");
+    const { execFileSync } = require("node:child_process");
 
     // We don't need the stack trace of execFileSync if the command fails.
     try {

bin/eslint.js

@@ -64,7 +64,7 @@ function readStdin() {
 function getErrorMessage(error) {
 
     // Lazy loading because this is used only if an error happened.
-    const util = require("util");
+    const util = require("node:util");
 
     // Foolproof -- third-party module might throw non-object.
     if (typeof error !== "object" || error === null) {

docs/.eleventy.js

@@ -7,7 +7,7 @@ const pluginTOC = require("eleventy-plugin-nesting-toc");
 const markdownItAnchor = require("markdown-it-anchor");
 const markdownItContainer = require("markdown-it-container");
 const Image = require("@11ty/eleventy-img");
-const path = require("path");
+const path = require("node:path");
 const { slug } = require("github-slugger");
 const yaml = require("js-yaml");
 const { highlighter, lineNumberPlugin } = require("./src/_plugins/md-syntax-highlighter");

docs/src/_data/site.js

@@ -9,8 +9,8 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const path = require("path");
-const fs = require("fs");
+const path = require("node:path");
+const fs = require("node:fs");
 const yaml = require("js-yaml");
 
 //-----------------------------------------------------------------------------

docs/tools/validate-links.js

@@ -1,6 +1,6 @@
 "use strict";
 
-const path = require("path");
+const path = require("node:path");
 const TapRender = require("@munter/tap-render");
 const spot = require("tap-spot");
 const hyperlink = require("hyperlink");

eslint.config.js

@@ -25,7 +25,7 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const path = require("path");
+const path = require("node:path");
 const internalPlugin = require("eslint-plugin-internal-rules");
 const eslintPluginRulesRecommendedConfig = require("eslint-plugin-eslint-plugin/configs/rules-recommended");
 const eslintPluginTestsRecommendedConfig = require("eslint-plugin-eslint-plugin/configs/tests-recommended");

lib/cli-engine/cli-engine.js

@@ -15,8 +15,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs");
-const path = require("path");
+const fs = require("node:fs");
+const path = require("node:path");
 const defaultOptions = require("../../conf/default-cli-options");
 const pkg = require("../../package.json");
 

lib/cli-engine/file-enumerator.js

@@ -34,8 +34,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs");
-const path = require("path");
+const fs = require("node:fs");
+const path = require("node:path");
 const getGlobParent = require("glob-parent");
 const isGlob = require("is-glob");
 const escapeRegExp = require("escape-string-regexp");

lib/cli-engine/lint-result-cache.js

@@ -8,8 +8,8 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const assert = require("assert");
-const fs = require("fs");
+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");

lib/cli-engine/load-rules.js

@@ -9,8 +9,8 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs"),
-    path = require("path");
+const fs = require("node:fs"),
+    path = require("node:path");
 
 const rulesDirCache = {};
 

lib/cli.js

@@ -15,9 +15,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs"),
-    path = require("path"),
-    { promisify } = require("util"),
+const fs = require("node:fs"),
+    path = require("node:path"),
+    { promisify } = require("node:util"),
     { LegacyESLint } = require("./eslint"),
     { ESLint, shouldUseFlatConfig, locateConfigFileToUse } = require("./eslint/eslint"),
     createCLIOptions = require("./options"),

lib/eslint/eslint-helpers.js

@@ -9,8 +9,8 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const path = require("path");
-const fs = require("fs");
+const path = require("node:path");
+const fs = require("node:fs");
 const fsp = fs.promises;
 const isGlob = require("is-glob");
 const hash = require("../cli-engine/hash");

lib/eslint/eslint.js

@@ -9,9 +9,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs/promises");
-const { existsSync } = require("fs");
-const path = require("path");
+const fs = require("node:fs/promises");
+const { existsSync } = require("node:fs");
+const path = require("node:path");
 const findUp = require("find-up");
 const { version } = require("../../package.json");
 const { Linter } = require("../linter");
@@ -38,7 +38,7 @@ const {
 
     processOptions
 } = require("./eslint-helpers");
-const { pathToFileURL } = require("url");
+const { pathToFileURL } = require("node:url");
 const { FlatConfigArray } = require("../config/flat-config-array");
 const LintResultCache = require("../cli-engine/lint-result-cache");
 const { Retrier } = require("@humanwhocodes/retry");

lib/eslint/legacy-eslint.js

@@ -10,9 +10,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const path = require("path");
-const fs = require("fs");
-const { promisify } = require("util");
+const path = require("node:path");
+const fs = require("node:fs");
+const { promisify } = require("node:util");
 const { CLIEngine, getCLIEngineInternalSlots } = require("../cli-engine/cli-engine");
 const BuiltinRules = require("../rules");
 const {

lib/linter/code-path-analysis/code-path-analyzer.js

@@ -9,7 +9,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("assert"),
+const assert = require("node:assert"),
     { breakableTypePattern } = require("../../shared/ast-utils"),
     CodePath = require("./code-path"),
     CodePathSegment = require("./code-path-segment"),

lib/linter/code-path-analysis/fork-context.js

@@ -13,7 +13,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("assert"),
+const assert = require("node:assert"),
     CodePathSegment = require("./code-path-segment");
 
 //------------------------------------------------------------------------------

lib/linter/linter.js

@@ -11,7 +11,7 @@
 //------------------------------------------------------------------------------
 
 const
-    path = require("path"),
+    path = require("node:path"),
     eslintScope = require("eslint-scope"),
     evk = require("eslint-visitor-keys"),
     espree = require("espree"),

lib/linter/report-translator.js

@@ -9,7 +9,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("assert");
+const assert = require("node:assert");
 const ruleFixer = require("./rule-fixer");
 const { interpolate } = require("./interpolate");
 

lib/rule-tester/rule-tester.js

@@ -11,9 +11,9 @@
 //------------------------------------------------------------------------------
 
 const
-    assert = require("assert"),
-    util = require("util"),
-    path = require("path"),
+    assert = require("node:assert"),
+    util = require("node:util"),
+    path = require("node:path"),
     equal = require("fast-deep-equal"),
     Traverser = require("../shared/traverser"),
     { getRuleOptionsSchema } = require("../config/flat-config-helpers"),

lib/shared/runtime-info.js

@@ -9,9 +9,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const path = require("path");
+const path = require("node:path");
 const spawn = require("cross-spawn");
-const os = require("os");
+const os = require("node:os");
 const log = require("../shared/logging");
 const packageJson = require("../../package.json");
 

lib/source-code/token-store/index.js

@@ -8,7 +8,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const assert = require("assert");
+const assert = require("node:assert");
 const { isCommentToken } = require("@eslint-community/eslint-utils");
 const cursors = require("./cursors");
 const ForwardTokenCursor = require("./forward-token-cursor");

packages/eslint-config-eslint/nodejs.js

@@ -5,7 +5,8 @@ const recommendedModuleConfig = require("eslint-plugin-n/configs/recommended-mod
 
 const sharedRules = {
     "n/callback-return": ["error", ["cb", "callback", "next"]],
-    "n/handle-callback-err": ["error", "err"]
+    "n/handle-callback-err": ["error", "err"],
+    "n/prefer-node-protocol": "error"
 };
 
 const cjsConfigs = [

tests/_utils/test-lazy-loading-rules.js

@@ -11,8 +11,8 @@
 
 "use strict";
 
-const path = require("path");
-const assert = require("assert");
+const path = require("node:path");
+const assert = require("node:assert");
 const { addHook } = require("pirates");
 
 const {

tests/bin/eslint.js

@@ -9,10 +9,10 @@
 // Requirements
 //-----------------------------------------------------------------------------
 
-const childProcess = require("child_process");
-const fs = require("fs");
+const childProcess = require("node:child_process");
+const fs = require("node:fs");
 const assert = require("chai").assert;
-const path = require("path");
+const path = require("node:path");
 
 //------------------------------------------------------------------------------
 // Data

tests/lib/cli-engine/cli-engine.js

@@ -10,11 +10,11 @@
 //------------------------------------------------------------------------------
 
 const assert = require("chai").assert,
-    path = require("path"),
+    path = require("node:path"),
     sinon = require("sinon"),
     shell = require("shelljs"),
-    fs = require("fs"),
-    os = require("os"),
+    fs = require("node:fs"),
+    os = require("node:os"),
     hash = require("../../../lib/cli-engine/hash"),
     {
         Legacy: {
@@ -787,7 +787,7 @@ describe("CLIEngine", () => {
 
         // @scope for @scope/eslint-plugin
         describe("(plugin shorthand)", () => {
-            const Module = require("module");
+            const Module = require("node:module");
             let originalFindPath = null;
 
             /* eslint-disable no-underscore-dangle -- Private Node API overriding */
@@ -5123,7 +5123,7 @@ describe("CLIEngine", () => {
                     writeFileSync() {}
                 },
                 localCLIEngine = proxyquire("../../../lib/cli-engine/cli-engine", {
-                    fs: fakeFS
+                    "node:fs": fakeFS
                 }).CLIEngine,
                 report = {
                     results: [
@@ -5153,7 +5153,7 @@ describe("CLIEngine", () => {
                     writeFileSync() {}
                 },
                 localCLIEngine = proxyquire("../../../lib/cli-engine/cli-engine", {
-                    fs: fakeFS
+                    "node:fs": fakeFS
                 }).CLIEngine,
                 report = {
                     results: [

tests/lib/cli-engine/file-enumerator.js

@@ -8,9 +8,9 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const fs = require("fs");
-const path = require("path");
-const os = require("os");
+const fs = require("node:fs");
+const path = require("node:path");
+const os = require("node:os");
 const { assert } = require("chai");
 const sh = require("shelljs");
 const sinon = require("sinon");

tests/lib/cli-engine/lint-result-cache.js

@@ -10,8 +10,8 @@
 
 const assert = require("chai").assert,
     { CLIEngine } = require("../../../lib/cli-engine"),
-    fs = require("fs"),
-    path = require("path"),
+    fs = require("node:fs"),
+    path = require("node:path"),
     proxyquire = require("proxyquire"),
     sinon = require("sinon");
 

tests/lib/cli.js

@@ -15,13 +15,13 @@
 //------------------------------------------------------------------------------
 
 const assert = require("chai").assert,
-    stdAssert = require("assert"),
+    stdAssert = require("node:assert"),
     { ESLint, LegacyESLint } = require("../../lib/eslint"),
     BuiltinRules = require("../../lib/rules"),
-    path = require("path"),
+    path = require("node:path"),
     sinon = require("sinon"),
-    fs = require("fs"),
-    os = require("os"),
+    fs = require("node:fs"),
+    os = require("node:os"),
     sh = require("shelljs");
 
 const proxyquire = require("proxyquire").noCallThru().noPreserveCache();