feat(node/url): Add url.format(URL[, options])

node/_tools/config.json

@@ -145,6 +145,7 @@
       "test-net-write-fully-async-buffer.js",
       "test-net-write-fully-async-hex-string.js",
       "test-url-fileurltopath.js",
+      "test-url-format-whatwg.js",
       "test-url-pathtofileurl.js",
       "test-util-inherits.js"
     ],

node/_tools/suites/parallel/test-url-format-whatwg.js

@@ -0,0 +1,128 @@
+// deno-fmt-ignore-file
+// deno-lint-ignore-file
+
+// Copyright Joyent and Node contributors. All rights reserved. MIT license.
+// Taken from Node 16.11.1
+// This file is automatically generated by "node/_tools/setup.ts". Do not modify this file manually
+
+'use strict';
+
+const common = require('../common');
+
+// TODO(wafuwafu): Implement `hasIntl`, `skip`
+// if (!common.hasIntl)
+//   common.skip('missing Intl');
+
+const assert = require('assert');
+const url = require('url');
+
+const myURL = new URL('http://xn--lck1c3crb1723bpq4a.com/a?a=b#c');
+
+assert.strictEqual(
+  url.format(myURL),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, {}),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+{
+  [true, 1, 'test', Infinity].forEach((value) => {
+    assert.throws(
+      () => url.format(myURL, value),
+      {
+        code: 'ERR_INVALID_ARG_TYPE',
+        name: 'TypeError',
+        message: 'The "options" argument must be of type object.' +
+                 common.invalidArgTypeHelper(value)
+      }
+    );
+  });
+}
+
+// Any falsy value other than undefined will be treated as false.
+// Any truthy value will be treated as true.
+
+assert.strictEqual(
+  url.format(myURL, { fragment: false }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b'
+);
+
+assert.strictEqual(
+  url.format(myURL, { fragment: '' }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b'
+);
+
+assert.strictEqual(
+  url.format(myURL, { fragment: 0 }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b'
+);
+
+assert.strictEqual(
+  url.format(myURL, { fragment: 1 }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { fragment: {} }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { search: false }),
+  'http://xn--lck1c3crb1723bpq4a.com/a#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { search: '' }),
+  'http://xn--lck1c3crb1723bpq4a.com/a#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { search: 0 }),
+  'http://xn--lck1c3crb1723bpq4a.com/a#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { search: 1 }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { search: {} }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+// TODO(wafuwafu13): Support unicode option
+
+// assert.strictEqual(
+//   url.format(myURL, { unicode: true }),
+//   'http://理容ナカムラ.com/a?a=b#c'
+// );
+
+// assert.strictEqual(
+//   url.format(myURL, { unicode: 1 }),
+//   'http://理容ナカムラ.com/a?a=b#c'
+// );
+
+// assert.strictEqual(
+//   url.format(myURL, { unicode: {} }),
+//   'http://理容ナカムラ.com/a?a=b#c'
+// );
+
+assert.strictEqual(
+  url.format(myURL, { unicode: false }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+assert.strictEqual(
+  url.format(myURL, { unicode: 0 }),
+  'http://xn--lck1c3crb1723bpq4a.com/a?a=b#c'
+);
+
+// assert.strictEqual(
+//   url.format(new URL('http://xn--0zwm56d.com:8080/path'), { unicode: true }),
+//   'http://测试.com:8080/path'
+// );

node/url.ts

@@ -45,6 +45,76 @@ const tabRegEx = /\t/g;
 const _url = URL;
 export { _url as URL };
 
+/**
+ * The URL object has both a `toString()` method and `href` property that return string serializations of the URL.
+ * These are not, however, customizable in any way.
+ * This method allows for basic customization of the output.
+ * @param urlObject
+ * @param options
+ * @param options.auth `true` if the serialized URL string should include the username and password, `false` otherwise. **Default**: `true`.
+ * @param options.fragment `true` if the serialized URL string should include the fragment, `false` otherwise. **Default**: `true`.
+ * @param options.search `true` if the serialized URL string should include the search query, **Default**: `true`.
+ * @param options.unicode `true` if Unicode characters appearing in the host component of the URL string should be encoded directly as opposed to being Punycode encoded. **Default**: `false`.
+ * @returns a customizable serialization of a URL `String` representation of a `WHATWG URL` object.
+ */
+export function format(
+  urlObject: URL,
+  options?: {
+    auth: boolean;
+    fragment: boolean;
+    search: boolean;
+    unicode: boolean;
+  },
+): string {
+  if (options) {
+    if (typeof options !== "object") {
+      throw new ERR_INVALID_ARG_TYPE("options", "object", options);
+    }
+  }
+
+  options = {
+    auth: true,
+    fragment: true,
+    search: true,
+    unicode: false,
+    ...options,
+  };
+
+  let ret = urlObject.protocol;
+  if (urlObject.host !== null) {
+    ret += "//";
+    const hasUsername = urlObject.username !== "";
+    const hasPassword = urlObject.password !== "";
+    if (options.auth && (hasUsername || hasPassword)) {
+      if (hasUsername) {
+        ret += urlObject.username;
+      }
+      if (hasPassword) {
+        ret += `:${urlObject.password}`;
+      }
+      ret += "@";
+    }
+    // TODO(wafuwfu13): Support unicode option
+    // ret += options.unicode ?
+    //   domainToUnicode(urlObject.host) : urlObject.host;
+    ret += urlObject.host;
+    if (urlObject.port) {
+      ret += `:${urlObject.port}`;
+    }
+  }
+
+  ret += urlObject.pathname;
+
+  if (options.search) {
+    ret += urlObject.search;
+  }
+  if (options.fragment) {
+    ret += urlObject.hash;
+  }
+
+  return ret;
+}
+
 /**
  * Get fully resolved platform-specific file path from the given URL string/ object
  * @param path The file URL string or URL object to convert to a path
@@ -196,6 +266,7 @@ export function pathToFileURL(filepath: string): URL {
 }
 
 export default {
+  format,
   fileURLToPath,
   pathToFileURL,
   URL,