module: add createRequire method

This is an abstraction on top of creatRequireFromPath that can accept
both paths, URL Strings, and URL Objects.

PR-URL: nodejs/node#27405
Reviewed-By: Benjamin Gruenbaum <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jan Krems <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: Rich Trott <[email protected]>

doc/api/deprecations.md

@@ -2107,7 +2107,6 @@ Type: Documentation-only
 [`fs.read()`]: fs.html#fs_fs_read_fd_buffer_offset_length_position_callback
 [`fs.readSync()`]: fs.html#fs_fs_readsync_fd_buffer_offset_length_position
 [`fs.stat()`]: fs.html#fs_fs_stat_path_options_callback
-[`os.networkInterfaces`]: os.html#os_os_networkinterfaces
 [`os.tmpdir()`]: os.html#os_os_tmpdir
 [`process.env`]: process.html#process_process_env
 [`punycode`]: punycode.html

doc/api/modules.md

@@ -905,6 +905,26 @@ by the [module wrapper][]. To access it, require the `Module` module:
 const builtin = require('module').builtinModules;
 ```
 
+### module.createRequire(filename)
+<!-- YAML
+added:
+  - REPLACEME
+  - v12.2.0
+-->
+
+* `filename` {string|URL} Filename to be used to construct the require
+  function. Must be a file URL object, file URL string, or absolute path
+  string.
+* Returns: {[`require`][]} Require function
+
+```js
+const { createRequire } = require('module');
+const requireUtil = createRequire(require.resolve('../src/utils/'));
+
+// Require `../src/utils/some-tool`
+requireUtil('./some-tool');
+```
+
 ### module.createRequireFromPath(filename)
 <!-- YAML
 added: v10.12.0

lib/internal/modules/cjs/loader.js

@@ -23,7 +23,7 @@
 
 const { NativeModule } = require('internal/bootstrap/loaders');
 const util = require('util');
-const { pathToFileURL } = require('internal/url');
+const { pathToFileURL, fileURLToPath, URL } = require('internal/url');
 const vm = require('vm');
 const assert = require('assert').ok;
 const fs = require('fs');
@@ -834,12 +834,48 @@ Module.runMain = function() {
   process._tickCallback();
 };
 
-Module.createRequireFromPath = (filename) => {
-  const m = new Module(filename);
-  m.filename = filename;
-  m.paths = Module._nodeModulePaths(path.dirname(filename));
+function createRequireFromPath(filename) {
+  // Allow a directory to be passed as the filename
+  const trailingSlash =
+    filename.endsWith(path.sep) || path.sep !== '/' && filename.endsWith('\\');
+
+  const proxyPath = trailingSlash ?
+    path.join(filename, 'noop.js') :
+    filename;
+
+  const m = new Module(proxyPath);
+  m.filename = proxyPath;
+
+  m.paths = Module._nodeModulePaths(path.dirname(proxyPath));
   return makeRequireFunction(m);
-};
+}
+
+Module.createRequireFromPath = createRequireFromPath;
+
+const createRequireError = 'must be a file URL object, file URL string, or' +
+  'absolute path string';
+
+function createRequire(filename) {
+  let filepath;
+  if (typeof filename === 'object' && !(filename instanceof URL)) {
+    throw new ERR_INVALID_ARG_VALUE('filename', filename, createRequireError);
+  } else if (typeof filename === 'object' ||
+    typeof filename === 'string' && !path.isAbsolute(filename)) {
+    try {
+      filepath = fileURLToPath(filename);
+    } catch {
+      throw new ERR_INVALID_ARG_VALUE('filename', filename,
+                                      createRequireError);
+    }
+  } else if (typeof filename !== 'string') {
+    throw new ERR_INVALID_ARG_VALUE('filename', filename, createRequireError);
+  } else {
+    filepath = filename;
+  }
+  return createRequireFromPath(filepath);
+}
+
+Module.createRequire = createRequire;
 
 Module._initPaths = function() {
   const isWindows = process.platform === 'win32';

test/fixtures/experimental

@@ -0,0 +1 @@
+module.exports.ofLife=42

test/parallel/test-module-create-require.js

@@ -4,9 +4,31 @@ require('../common');
 const assert = require('assert');
 const path = require('path');
 
-const { createRequireFromPath } = require('module');
+const { createRequire, createRequireFromPath } = require('module');
 
 const p = path.resolve(__dirname, '..', 'fixtures', 'fake.js');
+const u = new URL(`file://${p}`);
 
 const req = createRequireFromPath(p);
 assert.strictEqual(req('./baz'), 'perhaps I work');
+
+const reqToo = createRequire(u);
+assert.deepStrictEqual(reqToo('./experimental'), { ofLife: 42 });
+
+assert.throws(() => {
+  createRequire('https://github.com/nodejs/node/pull/27405/');
+}, {
+  code: 'ERR_INVALID_ARG_VALUE'
+});
+
+assert.throws(() => {
+  createRequire('../');
+}, {
+  code: 'ERR_INVALID_ARG_VALUE'
+});
+
+assert.throws(() => {
+  createRequire({});
+}, {
+  code: 'ERR_INVALID_ARG_VALUE'
+});