eslint-plugin-require-jsdoc

1.0.4 • Public • Published

eslint-plugin-require-jsdoc

This is a plugin for eslint for enforcing all FUNCTIONS should have jsdoc.
I had to write this because the (valid-jsdoc)(http://eslint.org/docs/rules/valid-jsdoc) rule in eslint did not help me to enforce that the functions MSUT have a jsdoc.Instead it validated the jsdoc. So for the best results use both together to make sure jsdoc is a must for all methods and they are valid.

usage

Follow the instructions here

eg:
(in your eslintrc)

  "plugins"[   
    "require-jsdoc"   
  ],
  "rules"{   
    "require-jsdoc": 2,  
    "valid-jsdoc": 2   
  }   

future

In future I hope to add jsdoc validation as well. Hence two rules can be avoided.
Please let me know your feedbacks.

Package Sidebar

Install

npm i eslint-plugin-require-jsdoc

Weekly Downloads

3,140

Version

1.0.4

License

ISC

Last publish

Collaborators

  • nrsnaithalath