feat: extra properties of objects can be documented

smartcar · Jul 14, 2022 · a6de3a1 · a6de3a1
1 parent 59f6530
commit a6de3a1
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 21 deletions.
diff --git a/index.js b/index.js
@@ -542,6 +542,7 @@ module.exports = {
         checkDestructured: true,
         checkRestProperty: true,
         allowExtraTrailingParamDocs: false,
+        useDefaultObjectProperties: true,
       },
     ],
     'jsdoc/check-property-names': 'error',
@@ -590,6 +591,14 @@ module.exports = {
         forceReturnsWithAsync: false,
       },
     ],
+    'jsdoc/require-yields': [
+      'error',
+      { withGeneratorTag: true, next: true, forceRequireNext: false },
+    ],
+    'jsdoc/require-yields-check': [
+      'error',
+      { checkGeneratorsOnly: true, next: true },
+    ],
     'jsdoc/require-throws': 'off',
     'jsdoc/valid-types': ['error', { allowEmptyNamepaths: true }],
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "eslint-plugin-ava": "13.2.0",
     "eslint-plugin-eslint-comments": "3.2.0",
     "eslint-plugin-import": "2.26.0",
-    "eslint-plugin-jsdoc": "30.7.8",
+    "eslint-plugin-jsdoc": "^31.2.3",
     "eslint-plugin-lodash": "7.4.0",
     "eslint-plugin-mocha": "10.0.5",
     "eslint-plugin-no-use-extend-native": "0.5.0",