eslint-plugin-jsdoc
eslint-plugin-jsdoc copied to clipboard
gajus
JSDoc specific linting rules for ESLint.
The README link to "ASTs and Selectors" in rules/require-returns-type.md does not currently work. This pull request updates the link to use the correct URL and anchor.
This issue is very similar to #891, except it applies when both the param and return (or returns) tags are present. Rather than aligning the return description with the param...
## Expected behavior The sample should fail `require-param` (due to a `@param` missing). ## Actual behavior The issue passes. (The issue is apparently due to some caching of.comment nodes in...
## Motivation i use [`import/no-extraneous-dependencies`](https://github.com/import-js/eslint-plugin-import/blob/main/docs/rules/no-extraneous-dependencies.md) to ensure that i don't accidentally install and import dependencies without adding to `package.json`. it would be nice to have that functionality in jsdoc `@type`s...
The README.md file on the GitHub repo homepage (https://github.com/gajus/eslint-plugin-jsdoc) is getting truncated to 512kB. This cuts off the `valid-types` section. You can test this by looking at the table of...
This might await some `jsdoc-type-pratt-parser` changes (@simonseyock ), but I'd like to move toward enabling `typescript` mode by default. This change is not proposed out of a desire to move...
if type is non-void but void return is used, we should get an error. When we do this: ```js /** * @param {string} message * @return {Boolean} */ function abc(...
the require-returns-check stops at the first occurence of "return". However all functions (except void/undefined) need a return statement at the end of the function too, otherwise the function can return...
This fixes #725 by creating a method based on the current `isUncommentedExport` and checking in `iterateJsdoc`, so other rules may be added as well. Currently it adds the option to...
## Motivation Add the `publicOnly` option from `require-jsdoc` to other rules. Personally I want to require jsdoc for all top-level functions for the types and only require descriptions when the...