eslint-config-jsdoc-strict
ESLint shareable config for JSDoc-related rules:
- ESLint require-jsdoc and valid-jsdoc rules,
- All eslint-plugin-jsdoc plugin rules.
Example of valid code:
/** * Description must be capitalised, end with a dot, and have a trailing new line. * * @example * // Functions must have a `@example` declaration * myFunction(null, 1, true, 'hello', () => {}, {}, []); * // => ... * * @param * be preceded by a hyphen, and end with a dot. * @param * @param * @param * @param * @param * @param * @returns */ { // ...}
Installation
Prerequisites:
npm install --save-dev eslint-plugin-jsdoc eslint-config-jsdoc-strict
Usage
Add this to your .eslintrc.json
:
Contributing
Please refer to the guidelines for contributing.
License
Created with npm-package-skeleton.