fix(require-yields-description, require-next-description): handle multiline descriptions; fixes #1528

Author: brettz9

docs/rules/require-yields-description.md

@@ -37,5 +37,11 @@ The following patterns are not considered problems:
 /**
  * @yields {SomeType} Has a description
  */
+
+/**
+ * @yields
+ *  The results.
+ */
+export function *test1(): IterableIterator<string> { yield "hello"; }
 ````
 

package.json

@@ -160,7 +160,7 @@
     "build": "node ./src/bin/buildEntryFileForTS.js && rimraf ./dist && NODE_ENV=production babel ./src --out-file-extension .cjs --out-dir ./dist --copy-files --source-maps --ignore ./src/bin/*.js --no-copy-ignored && replace 'require\\(\"\\.(.*?)\\.[^.]*?\"\\)' 'require(\".$1.cjs\")' 'dist' -r --include=\"*.cjs\" && pnpm tsc-build && pnpm tsc-cjs",
     "attw": "attw --pack .",
     "check-docs": "node ./src/bin/generateDocs.js --check",
-    "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js",
+    "create-docs": "pnpm run create-options && node ./src/bin/generateDocs.js && pnpm ruleTypes",
     "create-rule": "node ./src/bin/generateRule.js",
     "create-options": "node ./src/bin/generateOptions.js",
     "install-offline": "pnpm install --prefer-offline --no-audit",

src/index-cjs.js

@@ -147,7 +147,7 @@ index.rules = {
   'require-next-description': buildForbidRuleDefinition({
     contexts: [
       {
-        comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]))',
+        comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]):not([description!=""]))',
         context: 'any',
         message: '@next should have a description',
       },
@@ -207,7 +207,7 @@ index.rules = {
   'require-yields-description': buildForbidRuleDefinition({
     contexts: [
       {
-        comment: 'JsdocBlock:has(JsdocTag[tag=yields]:not([name!=""]))',
+        comment: 'JsdocBlock:has(JsdocTag[tag=yields]:not([name!=""]):not([description!=""]))',
         context: 'any',
         message: '@yields should have a description',
       },

src/index.js

@@ -153,7 +153,7 @@ index.rules = {
   'require-next-description': buildForbidRuleDefinition({
     contexts: [
       {
-        comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]))',
+        comment: 'JsdocBlock:has(JsdocTag[tag=next]:not([name!=""]):not([description!=""]))',
         context: 'any',
         message: '@next should have a description',
       },
@@ -213,7 +213,7 @@ index.rules = {
   'require-yields-description': buildForbidRuleDefinition({
     contexts: [
       {
-        comment: 'JsdocBlock:has(JsdocTag[tag=yields]:not([name!=""]))',
+        comment: 'JsdocBlock:has(JsdocTag[tag=yields]:not([name!=""]):not([description!=""]))',
         context: 'any',
         message: '@yields should have a description',
       },

test/rules/assertions/requireYieldsDescription.js

@@ -1,4 +1,8 @@
-export default {
+import {
+  parser as typescriptEslintParser,
+} from 'typescript-eslint';
+
+export default /** @type {import('../index.js').TestCases} */ ({
   invalid: [
     {
       code: `
@@ -22,5 +26,17 @@ export default {
          */
       `,
     },
+    {
+      code: `
+        /**
+         * @yields
+         *  The results.
+         */
+        export function *test1(): IterableIterator<string> { yield "hello"; }
+      `,
+      languageOptions: {
+        parser: typescriptEslintParser,
+      },
+    },
   ],
-};
+});