gajus/
JSDoc specific linting rules for ESLint.
USD raised
Recent activities
jsdoc/no-undefined-types is particularly slow
Matching between @param definition and function parameters no longer works
Options for `lines-before-block` to ignore the beginning of a class, function or other block
Option for `lines-before-block` to ignore single-line jsdoc comments
generate readme programatically
better support for enforcing required tags
TypeScript error when require eslint-plugin-jsdoc in a CommonJS file
parser does not recognize JSDoc blocks without initial whitespace
Revive the `no-undefined-types` rule for all mods/configs
Prevent line break between JSDoc comment and following (non comment) statement
Rule to report invalid inline jsdoc tags
Switch recommended to errors, and from recommended-error to recommended-warn?
An equivalent rule for unused imported `@typedef` similar to `no-unused-vars`
Enforcing single line JSDoc comments if it fits within a line length
Ignore certain sections of Vue components
v46.5.0's `engines.node` constraint is wrong
Add rule to lint for spacing of type parameters
Force consistent object typedef
require-throws recursion
With 46.4.2 match-description reports error when require-description is off
`no-undefined-types`: Include instance property names in the set of defined types
imports-as-dependencies: prints error on missing package.json even if not active
Parser shouldn't allow consider slash names to be JSDoc tags
`imports-as-dependencies`: package with `exports` instead of `types`
Add a TypeScript config for mixed TS/JS projects
Better error message on invalid types
check-tag-names: autofix @prop tags onto props if they exist?
Autofix breaks comments removing zero/final line
`typeAnnotation` can be undefined
[`check-line-alignment`] `postHyphen` VS `postHyphens` (with 's')
For object types, switch between single line and multiline display
Is an jsdoc/no-extra-parens rule planned?
Require description and type on `@throws` tag
Field docs are ignored
check-param-names - False positives with TypeScript "this" parameter
Return checks are matched against a bodyless type signature, not the function body implementation
custom context iteration issue
`check-param-names` should have a `contexts` option like the rest of the rules do
report an error when a package imported in a `@type` is not present in `package.json`
`check-line-alignment` with "always" breaks with @param, @return, and no types
Bug: require-returns-check even when missing
check-line-alignment with "always" option breaks if there is no @param or @return type
valid-types cannot valid combination type
`no-undefined-types`: false positive for template tags with defaults
README.md file is getting truncated on GitHub homepage
Failed to load plugin 'jsdoc' declared in '.eslintrc.json': Cannot find module 'eslint-plugin-jsdoc'
eslint vscode plugin not working
Don't require Docs for short methods in `require-jsdoc`
Applying fixes with object syntax via `require-param` rule
`exemptedBy` for `check-types` and expanded
require-jsdoc with different reporting levels
check-types can't decide on object vs. Object<>
Rule to mark types in JSDoc as used
38.0.5 generates `Cannot read property 'tags' of undefined` when comment includes extra asterisks
Automatic Line Breaks
const assertions is not supported
`jsdoc/require-returns` emits a warning for function returning `Promise<void>`
Working with Emacs
Predefine TypeScript globals for `no-undefined-types`
TypeScript type linting with typescript-eslint plugin
Switch default type mode to `typescript`
TypeError: Cannot read property 'kind' of null
Not working with Eslint 8
`no-undefined-types` error when casting a generic template
`jsdoc/no-restricted-syntax`: `context` does not support full range of selectors if any other `context` is any/*
publicOnly ignored when inside public functions that are missing jsdoc
require-jsdoc autofix breaks export default arrow function
require-jsdoc: exempt functions with no arguments and a return value
Documenting an object parameter with the name `module` triggers `jsdoc/valid-types`
jsdoc/check-examples fails in eslint 8
Indentation after an decorator in an example
ClassProperty context not working if publicOnly set to true
Overly strict node versions specified in engine
False positive with `no-multi-asterisks`
`jsdoc/require-param` adds missing parameters multiple times
jsdoc/require-jsdoc: False positive when documentation is inherited from interface
jsdoc/require-returns: Fails inside classes and interfaces
Feature request: Check validity of @inheritdoc
require-jsdoc fixer improvement
valid-types erroneously requires "function()" type to always have a return type
[jsdoc/require-returns] Allow specific contexts to have `forceRequireReturn`
Add rule for custom `@rejects` tag
require-param-names ignore "@param path declaration appears before any real parameter" warning
check-line-alignment throwing warnings in GitHub Actions on Windows
Exclude @example from tag-lines
Add publicOnly option to other rules
no-undefined-types should check `@type`
allow more "require" for fields
Error when using ignored values in destructuring assignments
check-line-alignment breaks if there is no @param type
publicOnly throws Missing JSDoc on private constructors or methods
Fix validity of autogenerated destructuring namepaths
Mechanism to escape `*/` in JSDoc descriptions, types, and examples
TOC links in README are all broken on NPM
Add a config with ALL options turned on ("plugin:jsdoc/all")
Function straight after "require" adds "ccccccccccccccccc" before require argument
[require-jsdoc] Question: Is it possible to not require jsdoc if the interface or abstraction already provide jsdoc?
check-types with option exemptTagContexts.tag still warns for no-undefined-types
multiline object types with indentation are not detected properly
More complete throw/yield detection
[Regression] newline-after-description false-positive for description starting on first line of comment
leading whitespace before the hyphen in require-hyphen-before-param-description
How to configure the mandatory @author field
Support ignore-next-line inside JSDoc comment block
max-len + jsdoc/check-examples
Handle @internal in the same way as @private
Multiple templates not supported
[jsdoc/require-jsdoc] : 'checkConstructors' + 'require' = fail
require-description with descriptionStyle: body produces "Missing JSDoc block description" when @description is used
jsdoc/valid-types throwing warning when using import syntax
Does not support destructuring in function arguments if the key in a destructured object is a string
Optionally allow bullet lists and other indented text in comments when `check-indentation` is enabled
Destructuring improvements/fixes
Disallow certain types on root params/properties (primitives, overly generic `any`, and whitelist/blacklist of (elsewhere-documented) user types)
`check-param-names`: check duplicate nested names
Rule (or `check-tag-names` option) to check that tags do not appear in wrong context
Make existing fixers apply recursively
Add a whitelist option for `require-description`
Redesign option for require-jsdoc
Have namepath checks in `valid-types` only allow strict namepaths
JSDoc/GCC/TypeScript mode
Missing fixers
Custom tag (`@readonly-properties`?) which enforced that a function would not modify passed-in and/or closure-obtained objects unless whitelisted
`require-returns` requires `@return` if there is an arrow in some comment
Ensure setting and option defaults are documented
Change `*WithoutParam` setting defaults to `true`
Check for more matching returns and param type checks
Options to validate descriptions more precisely based on the specific tag
Move settings to options
Except for return/param rules, most rules should not be limited to functions
valid-types can't work with inline param names
Precise validation of assorted tag type descriptions (including presence or absence)
[bug] TypeScript "Parameter properties" unsupported
Typescript types should be supported in jsdoc type positions
A custom @use tag for restricting closure variables
Tweak ESLint `no-warning-comments` (or make new rule) to optionally do `@todo` check
`jsdoc/check-param-names` should be fixable if order is wrong
Ā© 2019 BoostIO, Inc.
IssueHunt
