eslint-plugin-jsdoc 50.6.16 → 50.7.0

package/src/rules/sortTags.js

@@ -19,11 +19,11 @@ export default iterateJsdoc(({
      *   reportIntraTagGroupSpacing: boolean,
      * }}
      */ {
-      linesBetween = 1,
-      tagSequence = defaultTagOrder,
       alphabetizeExtras = false,
-      reportTagGroupSpacing = true,
+      linesBetween = 1,
       reportIntraTagGroupSpacing = true,
+      reportTagGroupSpacing = true,
+      tagSequence = defaultTagOrder,
     } = context.options[0] || {};
 
   const tagList = tagSequence.flatMap((obj) => {
@@ -142,10 +142,10 @@ export default iterateJsdoc(({
       return tag.source.reduce((acc, {
         tokens: {
           description,
-          name,
-          type,
           end,
+          name,
           tag: tg,
+          type,
         },
       }) => {
         const empty = !tg && !type && !name && !description;
@@ -342,10 +342,10 @@ export default iterateJsdoc(({
             {
               tokens: {
                 description,
-                name,
-                type,
                 end,
+                name,
                 tag: tg,
+                type,
               },
             },
           ] of jsdoc.source.entries()) {

package/src/rules/tagLines.js

@@ -8,10 +8,10 @@ export default iterateJsdoc(({
   const [
     alwaysNever = 'never',
     {
+      applyToEndTag = true,
       count = 1,
       endLines = 0,
       startLines = 0,
-      applyToEndTag = true,
       tags = {},
     } = {},
   ] = context.options;
@@ -34,11 +34,11 @@ export default iterateJsdoc(({
       idx,
       {
         tokens: {
-          tag,
-          name,
-          type,
           description,
           end,
+          name,
+          tag,
+          type,
         },
       },
     ] of tg.source.entries()) {
@@ -48,7 +48,7 @@ export default iterateJsdoc(({
       }
 
       if (lastTag && [
-        'any', 'always',
+        'always', 'any',
       ].includes(tags[lastTag.slice(1)]?.lines)) {
         continue;
       }
@@ -160,11 +160,11 @@ export default iterateJsdoc(({
       {
         number,
         tokens: {
-          tag,
-          name,
-          type,
           description,
           end,
+          name,
+          tag,
+          type,
         },
       },
     ] of tg.source.entries()) {

package/src/rules/textEscaping.js

@@ -76,6 +76,7 @@ export default iterateJsdoc(({
       if (tag.tag === 'example') {
         continue;
       }
+
       if (/** @type {string[]} */ (
         utils.getTagDescription(tag, true)
       ).some((desc) => {
@@ -106,6 +107,7 @@ export default iterateJsdoc(({
     if (tag.tag === 'example') {
       continue;
     }
+
     if (/** @type {string[]} */ (
       utils.getTagDescription(tag, true)
     ).some((desc) => {

package/src/rules/validTypes.js

@@ -11,10 +11,10 @@ const inlineTags = new Set([
 ]);
 
 const jsdocTypePrattKeywords = new Set([
-  'typeof',
-  'readonly',
   'import',
   'is',
+  'readonly',
+  'typeof',
 ]);
 
 const asExpression = /as\s+/u;
@@ -79,8 +79,8 @@ const suppressTypes = new Set([
 
   // Not documented?
   'unusedPrivateMembers',
-  'useOfGoogProvide',
   'uselessCode',
+  'useOfGoogProvide',
   'visibility',
   'with',
 ]);
@@ -103,11 +103,11 @@ const tryParsePathIgnoreError = (path) => {
 
 // eslint-disable-next-line complexity
 export default iterateJsdoc(({
+  context,
   jsdoc,
   report,
-  utils,
-  context,
   settings,
+  utils,
 }) => {
   const {
     allowEmptyNamepaths = false,
@@ -134,35 +134,35 @@ export default iterateJsdoc(({
 
       if (tagName) {
         switch (tagName) {
-        case 'requires':
-        case 'module': {
-          if (!namepath.startsWith('module:')) {
-            handled = tryParsePathIgnoreError(`module:${namepath}`);
+          case 'memberof':
+          case 'memberof!': {
+            const endChar = namepath.slice(-1);
+            if ([
+              '#', '.', '~',
+            ].includes(endChar)) {
+              handled = tryParsePathIgnoreError(namepath.slice(0, -1));
+            }
+
+            break;
           }
 
-          break;
-        }
+          case 'module': case 'requires': {
+            if (!namepath.startsWith('module:')) {
+              handled = tryParsePathIgnoreError(`module:${namepath}`);
+            }
 
-        case 'memberof': case 'memberof!': {
-          const endChar = namepath.slice(-1);
-          if ([
-            '#', '.', '~',
-          ].includes(endChar)) {
-            handled = tryParsePathIgnoreError(namepath.slice(0, -1));
+            break;
           }
 
-          break;
-        }
-
-        case 'borrows': {
-          const startChar = namepath.charAt(0);
-          if ([
-            '#', '.', '~',
-          ].includes(startChar)) {
-            handled = tryParsePathIgnoreError(namepath.slice(1));
+          case 'borrows': {
+            const startChar = namepath.charAt(0);
+            if ([
+              '#', '.', '~',
+            ].includes(startChar)) {
+              handled = tryParsePathIgnoreError(namepath.slice(1));
+            }
           }
         }
-        }
       }
 
       if (!handled) {
@@ -314,8 +314,8 @@ export default iterateJsdoc(({
     //  `require-param-name` (`@property` would similarly seem to require one,
     //  but is handled by `require-property-name`)
     if (tagMustHaveNamePosition !== false && !tag.name && !allowEmptyNamepaths && ![
-      'param', 'arg', 'argument',
-      'property', 'prop',
+      'arg', 'argument', 'param',
+      'prop', 'property',
     ].includes(tag.tag) &&
       (tag.tag !== 'see' || !utils.getTagDescription(tag).includes('{@link'))
     ) {

package/src/tagNames.js

@@ -179,10 +179,10 @@ const {
   inheritdoc,
   internal,
   overload,
-  satisfies,
-
   // Will be inverted to prefer `return`
   returns,
+
+  satisfies,
   /* eslint-enable no-unused-vars */
   ...typeScriptTagsInClosure
 } = typeScriptTags;