meta: enable jsdoc/check-tag-names rule

Author: anonrig

benchmark/common.js

@@ -386,7 +386,7 @@ function getUrlData(withBase) {
  * @param {number} e The repetition of the data, as exponent of 2
  * @param {boolean} withBase Whether to include a base URL
  * @param {boolean} asUrl Whether to return the results as URL objects
- * @return {string[] | string[][] | URL[]}
+ * @returns {string[] | string[][] | URL[]}
  */
 function bakeUrlData(type, e = 0, withBase = false, asUrl = false) {
   let result = [];

eslint.config.mjs

@@ -262,16 +262,15 @@ export default [
       // ESLint recommended rules that we disable.
       'no-inner-declarations': 'off',
 
-      // JSDoc recommended rules that we disable.
+      // JSDoc rules that we enable.
       'jsdoc/require-jsdoc': 'off',
       'jsdoc/require-param-description': 'off',
-      'jsdoc/newline-after-description': 'off',
       'jsdoc/require-returns-description': 'off',
       'jsdoc/valid-types': 'off',
       'jsdoc/no-defaults': 'off',
       'jsdoc/no-undefined-types': 'off',
       'jsdoc/require-param': 'off',
-      'jsdoc/check-tag-names': 'off',
+      'jsdoc/check-tag-names': 'error',
       'jsdoc/require-returns': 'off',
 
       // Stylistic rules.

lib/https.js

@@ -201,7 +201,7 @@ function createConnection(port, host, options) {
  *   maxCachedSessions?: number;
  *   servername?: string;
  *   }} [options]
- * @constructor
+ * @class
  */
 function Agent(options) {
   if (!(this instanceof Agent))

lib/internal/crypto/random.js

@@ -509,7 +509,7 @@ const numberToHexCharCode = (number) => (number < 10 ? 48 : 87) + number;
 
 /**
  * @param {ArrayBuffer} buf An ArrayBuffer.
- * @return {bigint}
+ * @returns {bigint}
  */
 function arrayBufferToUnsignedBigInt(buf) {
   const length = ArrayBufferPrototypeGetByteLength(buf);

lib/internal/event_target.js

@@ -373,9 +373,11 @@ function isCustomEvent(value) {
   return isEvent(value) && (value?.[kDetail] !== undefined);
 }
 
+/**
+ * @class
+ */
 class CustomEvent extends Event {
   /**
-   * @constructor
    * @param {string} type
    * @param {{
    *   bubbles?: boolean,

lib/internal/navigator.js

@@ -93,15 +93,15 @@ class Navigator {
   }
 
   /**
-   * @return {number}
+   * @returns {number}
    */
   get hardwareConcurrency() {
     this.#availableParallelism ??= getAvailableParallelism();
     return this.#availableParallelism;
   }
 
   /**
-   * @return {string}
+   * @returns {string}
    */
   get language() {
     // The default locale might be changed dynamically, so always invoke the
@@ -110,23 +110,23 @@ class Navigator {
   }
 
   /**
-   * @return {Array<string>}
+   * @returns {Array<string>}
    */
   get languages() {
     this.#languages ??= ObjectFreeze([this.language]);
     return this.#languages;
   }
 
   /**
-   * @return {string}
+   * @returns {string}
    */
   get userAgent() {
     this.#userAgent ??= `Node.js/${StringPrototypeSlice(nodeVersion, 1, StringPrototypeIndexOf(nodeVersion, '.'))}`;
     return this.#userAgent;
   }
 
   /**
-   * @return {string}
+   * @returns {string}
    */
   get platform() {
     this.#platform ??= getNavigatorPlatform(arch, platform);

lib/internal/source_map/source_map.js

@@ -86,9 +86,11 @@ const VLQ_CONTINUATION_MASK = 1 << 5;
 
 const kMappings = Symbol('kMappings');
 
+/**
+ * @class
+ */
 class StringCharIterator {
   /**
-   * @constructor
    * @param {string} string
    */
   constructor(string) {
@@ -97,28 +99,29 @@ class StringCharIterator {
   }
 
   /**
-   * @return {string}
+   * @returns {string}
    */
   next() {
     return StringPrototypeCharAt(this._string, this._position++);
   }
 
   /**
-   * @return {string}
+   * @returns {string}
    */
   peek() {
     return StringPrototypeCharAt(this._string, this._position);
   }
 
   /**
-   * @return {boolean}
+   * @returns {boolean}
    */
   hasNext() {
     return this._position < this._string.length;
   }
 }
 
 /**
+ * @class
  * Implements Source Map V3 model.
  * See https://github.com/google/closure-compiler/wiki/Source-Maps
  * for format description.
@@ -131,7 +134,6 @@ class SourceMap {
   #lineLengths = undefined;
 
   /**
-   * @constructor
    * @param {SourceMapV3} payload
    */
   constructor(payload, { lineLengths } = { __proto__: null }) {
@@ -150,7 +152,7 @@ class SourceMap {
   }
 
   /**
-   * @return {object} raw source map v3 payload.
+   * @returns {object} raw source map v3 payload.
    */
   get payload() {
     return cloneSourceMapV3(this.#payload);
@@ -161,7 +163,7 @@ class SourceMap {
   }
 
   /**
-   * @return {number[] | undefined} line lengths of generated source code
+   * @returns {number[] | undefined} line lengths of generated source code
    */
   get lineLengths() {
     if (this.#lineLengths) {
@@ -192,7 +194,7 @@ class SourceMap {
   /**
    * @param {number} lineOffset 0-indexed line offset in compiled resource
    * @param {number} columnOffset 0-indexed column offset in compiled resource
-   * @return {object} representing start of range if found, or empty object
+   * @returns {object} representing start of range if found, or empty object
    */
   findEntry(lineOffset, columnOffset) {
     let first = 0;
@@ -229,7 +231,7 @@ class SourceMap {
   /**
    * @param {number} lineNumber 1-indexed line number in compiled resource call site
    * @param {number} columnNumber 1-indexed column number in compiled resource call site
-   * @return {object} representing origin call site if found, or empty object
+   * @returns {object} representing origin call site if found, or empty object
    */
   findOrigin(lineNumber, columnNumber) {
     const range = this.findEntry(lineNumber - 1, columnNumber - 1);
@@ -319,15 +321,15 @@ class SourceMap {
 
 /**
  * @param {string} char
- * @return {boolean}
+ * @returns {boolean}
  */
 function isSeparator(char) {
   return char === ',' || char === ';';
 }
 
 /**
  * @param {SourceMap.StringCharIterator} stringCharIterator
- * @return {number}
+ * @returns {number}
  */
 function decodeVLQ(stringCharIterator) {
   // Read unsigned value.
@@ -359,7 +361,7 @@ function decodeVLQ(stringCharIterator) {
 
 /**
  * @param {SourceMapV3} payload
- * @return {SourceMapV3}
+ * @returns {SourceMapV3}
  */
 function cloneSourceMapV3(payload) {
   validateObject(payload, 'payload');
@@ -377,7 +379,7 @@ function cloneSourceMapV3(payload) {
  * @param {Array} entry1 source map entry [lineNumber, columnNumber, sourceURL,
  *  sourceLineNumber, sourceColumnNumber]
  * @param {Array} entry2 source map entry.
- * @return {number}
+ * @returns {number}
  */
 function compareSourceMapEntry(entry1, entry2) {
   const { 0: lineNumber1, 1: columnNumber1 } = entry1;

lib/internal/validators.js

@@ -534,7 +534,7 @@ const validateInternalField = hideStackFrames((object, fieldKey, className) => {
 
 /**
  * @param {any} hints
- * @return {string}
+ * @returns {string}
  */
 const validateLinkHeaderValue = hideStackFrames((hints) => {
   if (typeof hints === 'string') {

tools/eslint-rules/crypto-check.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Check that common.hasCrypto is used if crypto, tls,
+ * @file Check that common.hasCrypto is used if crypto, tls,
  * https, or http2 modules are required.
  * @author Daniel Bevenius <daniel.bevenius@gmail.com>
  */

tools/eslint-rules/eslint-check.js

@@ -1,5 +1,5 @@
 /**
- * @fileoverview Check that common.skipIfEslintMissing is used if
+ * @file Check that common.skipIfEslintMissing is used if
  *               the eslint module is required.
  */
 'use strict';