add jsdoc type

Author: czb3279338858

docs/rules/require-prop-comment.md

@@ -67,7 +67,8 @@ const props = defineProps({
   }]
 }
 ```
-- `type` ... Type of comment.Default is `"block"`
+- `type` ... Type of comment.Default is `"JSDoc"`
+  - `"JSDoc"` ... Only JSDoc comment are allowed,one is allowed.
   - `"line"` ... Only line comment are allowed,one or more.
   - `"block"` ... Only block comment are allowed,one is allowed.
   - `"unlimited"` ... There is no limit to the number and type.
@@ -78,7 +79,7 @@ const props = defineProps({
 <!-- ✓ GOOD -->
 <script setup>
 const props = defineProps({
-  /**
+  /*
    * a comment
    */
   a: Number,
@@ -88,10 +89,10 @@ const props = defineProps({
 <!-- ✗ BAD -->
 <script setup>
 const props = defineProps({
-  /**
+  /*
    * a comment
    */
-  /**
+  /*
    * a other comment
    */
   a: Number,

lib/rules/require-prop-comment.js

@@ -1,5 +1,5 @@
 /**
- * @author *****your name*****
+ * @author *****CZB*****
  * See LICENSE file in root directory for full license.
  */
 'use strict'
@@ -44,11 +44,11 @@ module.exports = {
   },
   /** @param {RuleContext} context */
   create(context) {
-    /** @type {{type: "line" | "block" | "unlimited"}|undefined} */
+    /** @type {{type: "line" | "block" | "unlimited" | "JSDoc"}|undefined} */
     const schema = context.options[0]
 
-    /** @type {"line" | "block" | "unlimited"} */
-    const type = schema ? schema.type : 'block'
+    /** @type {"line" | "block" | "unlimited" | "JSDoc"} */
+    const type = schema ? schema.type : 'JSDoc'
 
     const sourceCode = context.getSourceCode()
 
@@ -69,6 +69,16 @@ module.exports = {
       if (comments.length > 0) return ''
       return 'The "{{name}}" property should have a comment.'
     }
+    /** @type {{(comments:Comment[]):string}} */
+    const verifyJSDoc = (comments) => {
+      if (
+        comments.length === 1 &&
+        comments[0].type === 'Block' &&
+        /^\*[^*]+/.test(comments[0].value)
+      )
+        return ''
+      return 'The "{{name}}" property should have one JSDoc comment.'
+    }
 
     /**
      * @param {import('../utils').ComponentProp[]} props
@@ -90,6 +100,7 @@ module.exports = {
             message = verifyUnlimited(beforeComments)
             break
           default:
+            message = verifyJSDoc(beforeComments)
             break
         }
 

tests/lib/rules/require-prop-comment.js

@@ -1,5 +1,5 @@
 /**
- * @author *****your name*****
+ * @author *****CZB*****
  * See LICENSE file in root directory for full license.
  */
 'use strict'
@@ -43,10 +43,14 @@ tester.run('require-prop-comment', rule, {
       </template>
       <script setup>
       const props = defineProps({
-        /**
+        /*
          * a comment
          */
-        a: Number
+        a: Number,
+        /**
+         * b comment
+         */
+        b: Number
       })
       </script>
       `,
@@ -60,9 +64,6 @@ tester.run('require-prop-comment', rule, {
           // a comment
           // a other comment
           a: Number
-        },
-        render() {
-          return <div>1</div>
         }
       })
       `,
@@ -79,9 +80,6 @@ tester.run('require-prop-comment', rule, {
           a: Number,
           // a comment
           b: Number
-        },
-        render() {
-          return <div>1</div>
         }
       })
       `,
@@ -107,10 +105,54 @@ tester.run('require-prop-comment', rule, {
            * b other comment
            */
           b: Number,
+          /*
+           * c comment
+           */
+          c: Number
         }
       })
       </script>
       `,
+      errors: [
+        {
+          line: 10,
+          message: 'The "a" property should have one JSDoc comment.'
+        },
+        {
+          line: 17,
+          message: 'The "b" property should have one JSDoc comment.'
+        },
+        {
+          line: 21,
+          message: 'The "c" property should have one JSDoc comment.'
+        }
+      ]
+    },
+    {
+      code: `
+      <template>
+        <div>1</div>
+      </template>
+      <script>
+      import { defineComponent } from '@vue/composition-api'
+
+      export default defineComponent({
+        props: {
+          a: Number,
+          /*
+           * b comment
+           */
+          /*
+           * b other comment
+           */
+          b: Number,
+          // c comment
+          c: Number
+        }
+      })
+      </script>
+      `,
+      options: [{ type: 'block' }],
       errors: [
         {
           line: 10,
@@ -119,6 +161,10 @@ tester.run('require-prop-comment', rule, {
         {
           line: 17,
           message: 'The "b" property should have one block comment.'
+        },
+        {
+          line: 19,
+          message: 'The "c" property should have one block comment.'
         }
       ]
     },
@@ -193,7 +239,7 @@ tester.run('require-prop-comment', rule, {
       errors: [
         {
           line: 7,
-          message: 'The "a" property should have one block comment.'
+          message: 'The "a" property should have one JSDoc comment.'
         }
       ]
     },
@@ -209,7 +255,7 @@ tester.run('require-prop-comment', rule, {
       errors: [
         {
           line: 5,
-          message: 'The "a" property should have one block comment.'
+          message: 'The "a" property should have one JSDoc comment.'
         }
       ]
     }