enforce more documentation types

nlxai · Mar 26, 2024 · 2672a0b · 2672a0b
1 parent 94a938e
commit 2672a0b
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/packages/eslint-config-nlx/documentation.js b/packages/eslint-config-nlx/documentation.js
@@ -3,6 +3,14 @@ module.exports = {
   extends: ["plugin:jsdoc/recommended-typescript-error"],
   plugins: ["eslint-plugin-tsdoc"],
   rules: {
+    "jsdoc/require-jsdoc": [
+      "error",
+      {
+        publicOnly: true,
+        // these ensure that documentation of various type script constructs is required. Will tweak as we go.
+        contexts: ["TSTypeAliasDeclaration","TSInterfaceDeclaration","TSMethodSignature","TSPropertySignature"]
+      }
+    ],
     "jsdoc/check-tag-names": ["error", { definedTags: ["category", "hidden"] }],
     "jsdoc/require-param": ["error", { checkDestructured: false }],
     "jsdoc/check-param-names": ["error", { checkDestructured: false }],