chore: update jsdoccomment and devDeps.

Also: - chore: remove test dupes and fix output=null
gajus · Apr 6, 2024 · e343ab5 · e343ab5
1 parent ab5624b
commit e343ab5
Show file tree

Hide file tree

Showing 36 changed files with 1,287 additions and 1,825 deletions.
diff --git a/docs/rules/check-line-alignment.md b/docs/rules/check-line-alignment.md
@@ -128,16 +128,6 @@ const fn = ( lorem, sit ) => {}
 // "jsdoc/check-line-alignment": ["error"|"warn", "always"]
 // Message: Expected JSDoc block lines to be aligned.
 
-/**
- * Function description.
- *
- * @param {string} lorem Description.
- * @param {int} sit Description multi words.
- */
-const fn = ( lorem, sit ) => {}
-// "jsdoc/check-line-alignment": ["error"|"warn", "always"]
-// Message: Expected JSDoc block lines to be aligned.
-
 /**
  * Function description.
  *

diff --git a/docs/rules/check-param-names.md b/docs/rules/check-param-names.md
@@ -864,17 +864,9 @@ function quux (foo, bar, ...extra) {
 }
 
 /**
-* Converts an SVGRect into an object.
-* @param {SVGRect} bbox - a SVGRect
-*/
-const bboxToObj = function ({x, y, width, height}) {
-  return {x, y, width, height};
-};
-
-/**
-* Converts an SVGRect into an object.
-* @param {SVGRect} bbox - a SVGRect
-*/
+ * Converts an SVGRect into an object.
+ * @param {SVGRect} bbox - a SVGRect
+ */
 const bboxToObj = function ({x, y, width, height}) {
   return {x, y, width, height};
 };

diff --git a/docs/rules/check-tag-names.md b/docs/rules/check-tag-names.md
@@ -517,15 +517,6 @@ function quux () {
  */
 function quux () {
 
-}
-// Settings: {"jsdoc":{"tagNamePreference":{"todo":{"message":"Please use x-todo instead of todo","replacement":"x-todo"}}}}
-// Message: Please use x-todo instead of todo
-
-/**
- * @todo
- */
-function quux () {
-
 }
 // Settings: {"jsdoc":{"tagNamePreference":{"todo":55}}}
 // Message: Invalid `settings.jsdoc.tagNamePreference`. Values must be falsy, a string, or an object.

diff --git a/docs/rules/check-types.md b/docs/rules/check-types.md
@@ -352,15 +352,6 @@ function qux(baz) {
 // Settings: {"jsdoc":{"preferredTypes":{"*":"aaa","abc":"Abc","string":"Str"}}}
 // Message: Invalid JSDoc @param "baz" type "*"; prefer: "aaa".
 
-/**
- * @param {abc} foo
- * @param {Number} bar
- */
-function qux(foo, bar) {
-}
-// Settings: {"jsdoc":{"preferredTypes":{"abc":"Abc","string":"Str"}}}
-// Message: Invalid JSDoc @param "foo" type "abc"; prefer: "Abc".
-
 /**
  * @param {Array} foo
  */

diff --git a/docs/rules/match-description.md b/docs/rules/match-description.md
@@ -241,12 +241,6 @@ const q = class {
 // "jsdoc/match-description": ["error"|"warn", {"contexts":["any"]}]
 // Message: JSDoc description does not satisfy the regex pattern.
 
-/**
- * foo.
- */
-// "jsdoc/match-description": ["error"|"warn", {"contexts":["any"]}]
-// Message: JSDoc description does not satisfy the regex pattern.
-
 /**
  * foo.
  */

diff --git a/docs/rules/no-undefined-types.md b/docs/rules/no-undefined-types.md
@@ -361,15 +361,6 @@ const MyType = require('my-library').MyType;
 
 }
 
-const MyType = require('my-library').MyType;
-
-/**
- * @param {MyType} foo - Bar.
- */
-  function quux(foo) {
-
-}
-
 import {MyType} from 'my-library';
 
 /**

diff --git a/docs/rules/require-description.md b/docs/rules/require-description.md
@@ -133,24 +133,6 @@ class quux {
 // "jsdoc/require-description": ["error"|"warn", {"contexts":["any"],"descriptionStyle":"tag"}]
 // Message: Missing JSDoc @description declaration.
 
-/**
- *
- */
-class quux {
-
-}
-// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
-// Message: Missing JSDoc @description declaration.
-
-/**
- *
- */
-class quux {
-
-}
-// "jsdoc/require-description": ["error"|"warn", {"contexts":["ClassDeclaration"],"descriptionStyle":"tag"}]
-// Message: Missing JSDoc @description declaration.
-
 /**
  * @description
  */

diff --git a/docs/rules/require-jsdoc.md b/docs/rules/require-jsdoc.md
@@ -600,12 +600,6 @@ export function someMethod() {
 // "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
 // Message: Missing JSDoc comment.
 
-export function someMethod() {
-
-}
-// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":false,"esm":true,"window":false},"require":{"FunctionDeclaration":true}}]
-// Message: Missing JSDoc comment.
-
 const myObject = {
   myProp: true
 };
@@ -1566,11 +1560,6 @@ export function someMethod() {
 }
 // "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
 
-export function someMethod() {
-
-}
-// "jsdoc/require-jsdoc": ["error"|"warn", {"publicOnly":{"cjs":true,"esm":false,"window":false},"require":{"FunctionDeclaration":true}}]
-
 exports.someMethod = function() {
 
 }

diff --git a/docs/rules/require-param.md b/docs/rules/require-param.md
@@ -627,14 +627,6 @@ function quux (foo) {
 // Settings: {"jsdoc":{"tagNamePreference":{"param":"arg"}}}
 // Message: Missing JSDoc @arg "foo" declaration.
 
-/**
- * @param foo
- */
-function quux (foo, bar) {
-
-}
-// Message: Missing JSDoc @param "bar" declaration.
-
 /**
  * @override
  */
@@ -1351,22 +1343,6 @@ function quux (foo) {
 
 }
 
-/**
- * @augments
- */
-function quux (foo) {
-
-}
-// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
-
-/**
- * @extends
- */
-function quux (foo) {
-
-}
-// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
-
 /**
  * @override
  */
@@ -1480,32 +1456,6 @@ class A {
   }
 }
 
-/**
- * @augments
- */
-class A {
-  /**
-   *
-   */
-  quux (foo) {
-
-  }
-}
-// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
-
-/**
- * @extends
- */
-class A {
-  /**
-   *
-   */
-  quux (foo) {
-
-  }
-}
-// Settings: {"jsdoc":{"augmentsExtendsReplacesDocs":true}}
-
 /**
  * @internal
  */

diff --git a/docs/rules/require-returns-check.md b/docs/rules/require-returns-check.md
@@ -368,20 +368,6 @@ function foo() {
 };
 // Message: JSDoc @returns declaration present but return expression not available in function.
 
-/**
- * @returns {SomeType} Baz.
- */
-function foo() {
-    switch (true) {
-        default:
-            switch (false) {
-                default: return;
-            }
-            return "baz";
-    }
-};
-// Message: JSDoc @returns declaration present but return expression not available in function.
-
 /**
  * @returns {number}
  */
@@ -422,14 +408,6 @@ function quux () {
   return foo;
 }
 
-/**
- * @returns {string} Foo.
- */
-function quux () {
-
-  return foo;
-}
-
 /**
  *
  */
@@ -580,17 +558,6 @@ function quux () {
   return true;
 }
 
-/**
- * @returns {true}
- */
-function quux () {
-  try {
-    return true;
-  } catch (err) {
-  }
-  return true;
-}
-
 /**
  * @returns {true}
  */
@@ -614,17 +581,6 @@ function quux () {
   return true;
 }
 
-/**
- * @returns {true}
- */
-function quux () {
-  switch (true) {
-  case 'abc':
-    return true;
-  }
-  return true;
-}
-
 /**
  * @returns {true}
  */
@@ -1016,19 +972,6 @@ function foo() {
     }
 };
 
-/**
- * @returns Baz.
- */
-function foo() {
-    switch (true) {
-        default:
-            switch (false) {
-                default: return;
-            }
-            return "baz";
-    }
-};
-
 /**
  * @returns
  */

diff --git a/docs/rules/require-returns.md b/docs/rules/require-returns.md
@@ -864,12 +864,6 @@ const quux = () => {
 
 }
 
-/**
- *
- */
-function quux () {
-}
-
 /**
  *
  */
@@ -924,13 +918,6 @@ function quux () {
   return;
 }
 
-/**
- * @returns {void}
- */
-function quux () {
-}
-// "jsdoc/require-returns": ["error"|"warn", {"forceRequireReturn":true}]
-
 /**
  * @returns {void}
  */

diff --git a/docs/rules/require-yields-check.md b/docs/rules/require-yields-check.md
@@ -238,14 +238,6 @@ function * quux () {
   yield foo;
 }
 
-/**
- * @yields {string} Foo.
- */
-function * quux () {
-
-  yield foo;
-}
-
 /**
  *
  */

diff --git a/docs/rules/require-yields.md b/docs/rules/require-yields.md
@@ -443,17 +443,6 @@ function * quux () {
 }
 // Message: Missing JSDoc @yields declaration.
 
-/**
- *
- */
-function * quux () {
-  if (true) {
-    yield;
-  }
-  yield true;
-}
-// Message: Missing JSDoc @yields declaration.
-
 /**
  *
  */
@@ -586,12 +575,6 @@ function * quux (foo) {
   yield foo;
 }
 
-/**
- * @constructor
- */
-function * quux (foo) {
-}
-
 /**
  * @yields {object}
  */
@@ -612,12 +595,6 @@ function * quux () {
 function * quux () {
 }
 
-/**
- *
- */
-function * quux () {
-}
-
 /**
  * @yields {void}
  */