fix(require-description-complete-sentence): allow all inline tags a…

…t beginning of sentence; fixes #1150
gajus · Sep 15, 2023 · e8b1475 · e8b1475
1 parent 8dbcb6f
commit e8b1475
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/docs/rules/require-description-complete-sentence.md b/docs/rules/require-description-complete-sentence.md
@@ -211,7 +211,7 @@ function quux (foo) {
 function quux (foo) {
 
 }
-// Message: Sentences should start with an uppercase character.
+// Message: Sentences must end with a period.
 
 /**
  * Foo.
@@ -816,5 +816,7 @@ function quux () {}
 function quux () {
 
 }
+
+/** @param options {@link RequestOptions} specifying path parameters and query parameters. */
 ````
 
diff --git a/src/rules/requireDescriptionCompleteSentence.js b/src/rules/requireDescriptionCompleteSentence.js
@@ -25,7 +25,7 @@ const extractParagraphs = (text) => {
 const extractSentences = (text, abbreviationsRegex) => {
   const txt = text
     // Remove all {} tags.
-    .replaceAll(/\{[\s\S]*?\}\s*/gu, '')
+    .replaceAll(/(?<!^)\{[\s\S]*?\}\s*/gu, '')
 
     // Remove custom abbreviations
     .replace(abbreviationsRegex, '');

diff --git a/test/rules/assertions/requireDescriptionCompleteSentence.js b/test/rules/assertions/requireDescriptionCompleteSentence.js
@@ -316,18 +316,14 @@ export default {
           }
       `,
       errors: [
-        {
-          line: 3,
-          message: 'Sentences should start with an uppercase character.',
-        },
         {
           line: 3,
           message: 'Sentences must end with a period.',
         },
       ],
       output: `
           /**
-           * {@see Foo.bar} Buz.
+           * {@see Foo.bar} buz.
            */
           function quux (foo) {
 
@@ -1576,5 +1572,10 @@ export default {
           }
       `,
     },
+    {
+      code: `
+      /** @param options {@link RequestOptions} specifying path parameters and query parameters. */
+      `,
+    },
   ],
 };