fix(match-description): ensure prop and property matching excludes name

Author: brettz9

README.md

@@ -2655,6 +2655,17 @@ function quux (foo) {
 // Options: [{"tags":{"param":true}}]
 // Message: JSDoc description does not satisfy the regex pattern.
 
+/**
+ * Foo.
+ *
+ * @prop foo foo.
+ */
+function quux (foo) {
+
+}
+// Options: [{"tags":{"prop":true}}]
+// Message: JSDoc description does not satisfy the regex pattern.
+
 /**
  * Foo.
  *
@@ -3122,6 +3133,16 @@ function quux () {
 
 }
 // Options: [{"tags":{"x-tag":".+"}}]
+
+/**
+ * Foo.
+ *
+ * @prop foo Foo.
+ */
+function quux (foo) {
+
+}
+// Options: [{"tags":{"prop":true}}]
 ````
 
 

src/jsdocUtils.js

@@ -524,7 +524,9 @@ const filterTags = (tags = [], filter) => {
   return tags.filter(filter);
 };
 
-const tagsWithNamesAndDescriptions = ['param', 'arg', 'argument', 'returns', 'return'];
+const tagsWithNamesAndDescriptions = [
+  'param', 'arg', 'argument', 'property', 'prop', 'returns', 'return'
+];
 
 const getTagsByType = (tags, tagPreference) => {
   const descName = getPreferredTagName('description', tagPreference);

test/rules/assertions/matchDescription.js

@@ -160,6 +160,31 @@ export default {
         }
       ]
     },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @prop foo foo.
+           */
+          function quux (foo) {
+
+          }
+      `,
+      errors: [
+        {
+          line: 5,
+          message: 'JSDoc description does not satisfy the regex pattern.'
+        }
+      ],
+      options: [
+        {
+          tags: {
+            prop: true
+          }
+        }
+      ]
+    },
     {
       code: `
           /**
@@ -1086,6 +1111,25 @@ export default {
           }
         }
       ]
+    },
+    {
+      code: `
+          /**
+           * Foo.
+           *
+           * @prop foo Foo.
+           */
+          function quux (foo) {
+
+          }
+      `,
+      options: [
+        {
+          tags: {
+            prop: true
+          }
+        }
+      ]
     }
   ]
 };