fix(check-values): allow @version and @since to have versions s…

…urrounded by whitespace `semver.valid()` requires a trimmed string. With leading or trailing whitespace, `semver.valid()` returns `false`.
gajus · Jan 15, 2020 · 37466a8 · 37466a8
1 parent 422a48e
commit 37466a8
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -3890,13 +3890,27 @@ function quux (foo) {
 
 }
 
+/**
+ * @version      3.4.1
+ */
+function quux (foo) {
+
+}
+
 /**
  * @since 3.4.1
  */
 function quux (foo) {
 
 }
 
+/**
+ * @since      3.4.1
+ */
+function quux (foo) {
+
+}
+
 /**
  * @license MIT
  */

diff --git a/src/rules/checkValues.js b/src/rules/checkValues.js
@@ -15,8 +15,8 @@ export default iterateJsdoc(({
   } = options;
 
   utils.forEachPreferredTag('version', (jsdocParameter, targetTagName) => {
-    const version = jsdocParameter.description;
-    if (!version.trim()) {
+    const version = jsdocParameter.description.trim();
+    if (!version) {
       report(
         `Missing JSDoc @${targetTagName}.`,
         null,
@@ -31,8 +31,8 @@ export default iterateJsdoc(({
     }
   });
   utils.forEachPreferredTag('since', (jsdocParameter, targetTagName) => {
-    const version = jsdocParameter.description;
-    if (!version.trim()) {
+    const version = jsdocParameter.description.trim();
+    if (!version) {
       report(
         `Missing JSDoc @${targetTagName}.`,
         null,

diff --git a/test/rules/assertions/checkValues.js b/test/rules/assertions/checkValues.js
@@ -218,6 +218,16 @@ export default {
       }
       `,
     },
+    {
+      code: `
+      /**
+       * @version      3.4.1
+       */
+      function quux (foo) {
+
+      }
+      `,
+    },
     {
       code: `
       /**
@@ -228,6 +238,16 @@ export default {
       }
       `,
     },
+    {
+      code: `
+      /**
+       * @since      3.4.1
+       */
+      function quux (foo) {
+
+      }
+      `,
+    },
     {
       code: `
       /**