CODEWITHSUNDEEP
eslintpublictypescript-eslinteslint-plugin-jsdoc
lessandra
lessandra

Reputation: 11

How can I create linting errors (in typescript) if no jsdoc for public functions or variables is provided?

I want to make sure that all of my public variables and methods in my code are documented.

I have tried to use eslint-plugin-jsdoc and have activated all of the recommended rules. Additionally, I added the following rule to raise errors when there is no documentation for public methods:

"jsdoc/require-jsdoc": [
   "error",
      {
          "publicOnly": true,
      }
   ],

However, "publicOnly" in this case does not refer to public methods/variables but to those that are exported from the module. Is there a way (besides creating a custom plugin) to achieve the same behavior for public methods/variables?

Upvotes: 1

Views: 132

Answers (0)

Related Questions