fix(check-examples): disallow empty caption (as with missing caption); fixes #330

Author: brettz9

src/rules/checkExamples.js

@@ -6,7 +6,7 @@ import warnRemovedSettings from '../warnRemovedSettings';
 const zeroBasedLineIndexAdjust = -1;
 const likelyNestedJSDocIndentSpace = 1;
 const preTagSpaceLength = 1;
-const hasCaptionRegex = /^\s*<caption>.*?<\/caption>/;
+const hasCaptionRegex = /^\s*<caption>(.*?)<\/caption>/;
 
 const escapeStringRegexp = (str) => {
   return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
@@ -81,7 +81,7 @@ export default iterateJsdoc(({
     let source = tag.source.slice(initialTagLength);
     const match = source.match(hasCaptionRegex);
 
-    if (captionRequired && !match) {
+    if (captionRequired && (!match || !match[1].trim())) {
       report('Caption is expected for examples.', null, tag);
     }
 

test/rules/assertions/checkExamples.js

@@ -443,6 +443,24 @@ export default {
           reportUnusedDisableDirectives: true
         }
       }
+    },
+    {
+      code: `
+      /**
+       * @typedef {string} Foo
+       * @example <caption></caption>
+       * 'foo'
+       */
+     `,
+      errors: [
+        {
+          message: 'Caption is expected for examples.'
+        }
+      ],
+      options: [{
+        captionRequired: true,
+        eslintrcForExamples: false
+      }]
     }
   ],
   valid: [