meta: enable jsdoc/no-defaults rule

anonrig · anonrig · commit 4165c4f599df · 2025-05-31T11:46:55.000-04:00
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -267,7 +267,7 @@ export default [
       'jsdoc/require-param-description': 'off',
       'jsdoc/require-returns-description': 'off',
       'jsdoc/valid-types': 'off',
-      'jsdoc/no-defaults': 'off',
+      'jsdoc/no-defaults': 'error',
       'jsdoc/no-undefined-types': 'off',
       'jsdoc/require-param': 'off',
       'jsdoc/check-tag-names': 'error',
diff --git a/lib/internal/data_url.js b/lib/internal/data_url.js
@@ -295,8 +295,8 @@ function isASCIIWhitespace(char) {
 /**
  * @see https://infra.spec.whatwg.org/#strip-leading-and-trailing-ascii-whitespace
  * @param {string} str
- * @param {boolean} [leading=true]
- * @param {boolean} [trailing=true]
+ * @param {boolean} [leading]
+ * @param {boolean} [trailing]
  */
 function removeASCIIWhitespace(str, leading = true, trailing = true) {
   return removeChars(str, leading, trailing, isASCIIWhitespace);
diff --git a/lib/internal/dns/promises.js b/lib/internal/dns/promises.js
@@ -185,12 +185,11 @@ function createLookupPromise(family, hostname, all, hints, dnsOrder) {
  * Get the IP address for a given hostname.
  * @param {string} hostname - The hostname to resolve (ex. 'nodejs.org').
  * @param {object} [options] - Optional settings.
- * @param {boolean} [options.all=false] - Whether to return all or just the first resolved address.
- * @param {0 | 4 | 6} [options.family=0] - The record family. Must be 4, 6, or 0 (for both).
+ * @param {boolean} [options.all] - Whether to return all or just the first resolved address.
+ * @param {0 | 4 | 6} [options.family] - The record family. Must be 4, 6, or 0 (for both).
  * @param {number} [options.hints] - One or more supported getaddrinfo flags (supply multiple via
  * bitwise OR).
- * @param {string} [options.order='verbatim'] - Return results in same order DNS resolved them;
- * Must be `ipv4first`, `ipv6first` or `verbatim`.
+ * @param {'ipv4first' | 'ipv6first' | 'verbatim'} [options.order] - Return results in same order DNS resolved them;
  * New code should supply `verbatim`.
  */
 function lookup(hostname, options) {
diff --git a/lib/internal/modules/esm/create_dynamic_module.js b/lib/internal/modules/esm/create_dynamic_module.js
@@ -41,7 +41,7 @@ import.meta.exports[${nameStringLit}] = {
  * Creates a dynamic module with the given imports, exports, URL, and evaluate function.
  * @param {string[]} imports - An array of imports.
  * @param {string[]} exports - An array of exports.
- * @param {string} [url=''] - The URL of the module.
+ * @param {string} [url] - The URL of the module.
  * @param {(reflect: DynamicModuleReflect) => void} evaluate - The function to evaluate the module.
  * @typedef {object} DynamicModuleReflect
  * @property {Record<string, Record<string, any>>} imports - The imports of the module.
diff --git a/lib/internal/modules/esm/resolve.js b/lib/internal/modules/esm/resolve.js
@@ -931,7 +931,7 @@ function throwIfInvalidParentURL(parentURL) {
  * Resolves the given specifier using the provided context, which includes the parent URL and conditions.
  * Attempts to resolve the specifier and returns the resulting URL and format.
  * @param {string} specifier - The specifier to resolve.
- * @param {object} [context={}] - The context object containing the parent URL and conditions.
+ * @param {object} [context] - The context object containing the parent URL and conditions.
  * @param {string} [context.parentURL] - The URL of the parent module.
  * @param {string[]} [context.conditions] - The conditions for resolving the specifier.
  */
diff --git a/lib/internal/modules/esm/translators.js b/lib/internal/modules/esm/translators.js
@@ -176,7 +176,7 @@ const cjsCache = new SafeMap();
  * @param {string} source - The source code of the module.
  * @param {boolean} isMain - Whether the module is the main module.
  * @param {string} format - Format of the module.
- * @param {typeof loadCJSModule} [loadCJS=loadCJSModule] - The function to load the CommonJS module.
+ * @param {typeof loadCJSModule} [loadCJS] - The function to load the CommonJS module.
  * @returns {ModuleWrap} The ModuleWrap object for the CommonJS module.
  */
 function createCJSModuleWrap(url, source, isMain, format, loadCJS = loadCJSModule) {
diff --git a/lib/internal/modules/esm/utils.js b/lib/internal/modules/esm/utils.js
@@ -283,7 +283,7 @@ let _forceDefaultLoader = false;
  * Initializes handling of ES modules.
  * This is configured during pre-execution. Specifically it's set to true for
  * the loader worker in internal/main/worker_thread.js.
- * @param {boolean} [forceDefaultLoader=false] - A boolean indicating disabling custom loaders.
+ * @param {boolean} [forceDefaultLoader] - A boolean indicating disabling custom loaders.
  */
 function initializeESM(forceDefaultLoader = false) {
   _forceDefaultLoader = forceDefaultLoader;
diff --git a/lib/internal/modules/esm/worker.js b/lib/internal/modules/esm/worker.js
@@ -242,7 +242,7 @@ module.exports = function setupModuleWorker(workerData, syncCommPort) {
   /**
    * Handles errors that occur in the worker thread.
    * @param {Error} err - The error that occurred.
-   * @param {string} [origin='unhandledRejection'] - The origin of the error.
+   * @param {string} [origin] - The origin of the error.
    */
   function errorHandler(err, origin = 'unhandledRejection') {
     AtomicsAdd(lock, WORKER_TO_MAIN_THREAD_NOTIFICATION, 1);
diff --git a/lib/internal/test_runner/mock/mock.js b/lib/internal/test_runner/mock/mock.js
@@ -302,7 +302,7 @@ class MockTracker {
    * @param {Function} [original] - The original function to be tracked.
    * @param {Function} [implementation] - An optional replacement function for the original one.
    * @param {object} [options] - Additional tracking options.
-   * @param {number} [options.times=Infinity] - The maximum number of times the mock function can be called.
+   * @param {number} [options.times] - The maximum number of times the mock function can be called.
    * @returns {ProxyConstructor} The mock function tracker.
    */
   fn(
@@ -334,9 +334,9 @@ class MockTracker {
    * @param {string} methodName - The name of the method to be tracked.
    * @param {Function} [implementation] - An optional replacement function for the original method.
    * @param {object} [options] - Additional tracking options.
-   * @param {boolean} [options.getter=false] - Indicates whether this is a getter method.
-   * @param {boolean} [options.setter=false] - Indicates whether this is a setter method.
-   * @param {number} [options.times=Infinity] - The maximum number of times the mock method can be called.
+   * @param {boolean} [options.getter] - Indicates whether this is a getter method.
+   * @param {boolean} [options.setter] - Indicates whether this is a setter method.
+   * @param {number} [options.times] - The maximum number of times the mock method can be called.
    * @returns {ProxyConstructor} The mock method tracker.
    */
   method(
@@ -425,9 +425,9 @@ class MockTracker {
    * @param {string} methodName - The name of the getter method to be mocked.
    * @param {Function} [implementation] - An optional replacement function for the targeted method.
    * @param {object} [options] - Additional tracking options.
-   * @param {boolean} [options.getter=true] - Indicates whether this is a getter method.
-   * @param {boolean} [options.setter=false] - Indicates whether this is a setter method.
-   * @param {number} [options.times=Infinity] - The maximum number of times the mock method can be called.
+   * @param {boolean} [options.getter] - Indicates whether this is a getter method.
+   * @param {boolean} [options.setter] - Indicates whether this is a setter method.
+   * @param {number} [options.times] - The maximum number of times the mock method can be called.
    * @returns {ProxyConstructor} The mock method tracker.
    */
   getter(
@@ -465,9 +465,9 @@ class MockTracker {
    * @param {string} methodName  - The setter method to be mocked.
    * @param {Function} [implementation] - An optional replacement function for the targeted method.
    * @param {object} [options] - Additional tracking options.
-   * @param {boolean} [options.getter=false] - Indicates whether this is a getter method.
-   * @param {boolean} [options.setter=true] - Indicates whether this is a setter method.
-   * @param {number} [options.times=Infinity] - The maximum number of times the mock method can be called.
+   * @param {boolean} [options.getter] - Indicates whether this is a getter method.
+   * @param {boolean} [options.setter] - Indicates whether this is a setter method.
+   * @param {number} [options.times] - The maximum number of times the mock method can be called.
    * @returns {ProxyConstructor} The mock method tracker.
    */
   setter(
diff --git a/lib/internal/test_runner/mock/mock_timers.js b/lib/internal/test_runner/mock/mock_timers.js
@@ -666,7 +666,7 @@ class MockTimers {
   /**
    * Advances the virtual time of MockTimers by the specified duration (in milliseconds).
    * This method simulates the passage of time and triggers any scheduled timers that are due.
-   * @param {number} [time=1] - The amount of time (in milliseconds) to advance the virtual time.
+   * @param {number} [time] - The amount of time (in milliseconds) to advance the virtual time.
    * @throws {ERR_INVALID_STATE} If MockTimers are not enabled.
    * @throws {ERR_INVALID_ARG_VALUE} If a negative time value is provided.
    */
diff --git a/lib/internal/vm.js b/lib/internal/vm.js
@@ -117,11 +117,11 @@ function registerImportModuleDynamically(referrer, importModuleDynamically) {
  * @param {string} filename - The filename to use for the compiled function.
  * @param {number} lineOffset - The line offset to use for the compiled function.
  * @param {number} columnOffset - The column offset to use for the compiled function.
- * @param {Buffer} [cachedData=undefined] - The cached data to use for the compiled function.
+ * @param {Buffer} [cachedData] - The cached data to use for the compiled function.
  * @param {boolean} produceCachedData - Whether to produce cached data for the compiled function.
- * @param {ReturnType<import('vm').createContext} [parsingContext=undefined] - The parsing context to use for the
+ * @param {ReturnType<import('node:vm').createContext>} [parsingContext] - The parsing context to use for the
  * compiled function.
- * @param {object[]} [contextExtensions=[]] - An array of context extensions to use for the compiled function.
+ * @param {object[]} [contextExtensions] - An array of context extensions to use for the compiled function.
  * @param {string[]} [params] - An optional array of parameter names for the compiled function.
  * @param {symbol} hostDefinedOptionId - A symbol referenced by the field `host_defined_option_symbol`.
  * @param {VmImportModuleDynamicallyCallback} [importModuleDynamically] -
diff --git a/lib/os.js b/lib/os.js
@@ -244,8 +244,8 @@ function networkInterfaces() {
 }
 
 /**
- * @param {number} [pid=0]
- * @param {number} priority
+ * @param {number} [pid]
+ * @param {number} [priority]
  * @returns {void}
  */
 function setPriority(pid, priority) {
@@ -264,7 +264,7 @@ function setPriority(pid, priority) {
 }
 
 /**
- * @param {number} [pid=0]
+ * @param {number} [pid]
  * @returns {number}
  */
 function getPriority(pid) {
@@ -283,7 +283,7 @@ function getPriority(pid) {
 }
 
 /**
- * @param {{ encoding?: string }} [options=utf8] If `encoding` is set to
+ * @param {{ encoding?: string }} [options] If `encoding` is set to
  * `'buffer'`, the `username`, `shell`, and `homedir` values will
  * be `Buffer` instances.
  * @returns {{
diff --git a/lib/string_decoder.js b/lib/string_decoder.js
@@ -53,9 +53,9 @@ const kNativeDecoder = Symbol('kNativeDecoder');
 
 /**
  * StringDecoder provides an interface for efficiently splitting a series of
- * buffers into a series of JS strings without breaking apart multi-byte
+ * buffers into a series of JS strings without breaking apart multibyte
  * characters.
- * @param {string} [encoding=utf-8]
+ * @param {string} [encoding]
  */
 function StringDecoder(encoding) {
   this.encoding = normalizeEncoding(encoding);
diff --git a/lib/util.js b/lib/util.js
@@ -111,9 +111,9 @@ function escapeStyleCode(code) {
 /**
  * @param {string | string[]} format
  * @param {string} text
- * @param {object} [options={}]
- * @param {boolean} [options.validateStream=true] - Whether to validate the stream.
- * @param {Stream} [options.stream=process.stdout] - The stream used for validation.
+ * @param {object} [options]
+ * @param {boolean} [options.validateStream] - Whether to validate the stream.
+ * @param {Stream} [options.stream] - The stream used for validation.
  * @returns {string}
  */
 function styleText(format, text, { validateStream = true, stream = process.stdout } = {}) {
