diff --git a/packages/eslint-config-nlx/documentation.js b/packages/eslint-config-nlx/documentation.js index 5a8faf4d..076ec2f6 100644 --- 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 }],