fix(tag-lines): avoid new startLines option expecting whitespace …

…when no tags are present; fixes #1024
gajus · Apr 18, 2023 · a9cd1db · a9cd1db
1 parent 9bb4bfd
commit a9cd1db
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -23481,6 +23481,13 @@ function processSass (input) {
 function processSass (input) {
 }
 // "jsdoc/tag-lines": ["error"|"warn", "never",{"startLines":1}]
+
+/**
+ * Toggles the deselect all icon button action
+ */
+function updateIconButton () {
+}
+// "jsdoc/tag-lines": ["error"|"warn", "never",{"startLines":1}]
 ````
 
 

diff --git a/src/rules/tagLines.js b/src/rules/tagLines.js
@@ -199,6 +199,10 @@ export default iterateJsdoc(({
   });
 
   if (typeof startLines === 'number') {
+    if (!jsdoc.tags.length) {
+      return;
+    }
+
     const {
       description,
       lastDescriptionLine,

diff --git a/test/rules/assertions/tagLines.js b/test/rules/assertions/tagLines.js
@@ -1124,5 +1124,20 @@ export default {
         },
       ],
     },
+    {
+      code: `
+      /**
+       * Toggles the deselect all icon button action
+       */
+      function updateIconButton () {
+      }
+      `,
+      options: [
+        'never',
+        {
+          startLines: 1,
+        },
+      ],
+    },
   ],
 };