☂️ eslint-plugin-jsdoc

[!WARNING] This comment is maintained by CI. Do not edit this comment directly. To update comment template, see https://github.com/oxc-project/oxc/tree/main/tasks/lint_rules

This is the tracking issue for eslint-plugin-jsdoc.

There are 78(+ 0 deprecated) rules.

• 17/37 recommended rules are remaining as TODO
  • 8 of which have pending fixes
• 35/41 not recommended rules are remaining as TODO

To get started, run the following command:

just new-jsdoc-rule <RULE_NAME>

Then implement the rule and get all the tests passing.

Recommended rules

✅: 20, : 0, ⏳: 8 / total: 37

Status	Name	Rationale
✅	jsdoc/check-access
	jsdoc/check-alignment
	jsdoc/check-param-names
✅⏳	jsdoc/check-property-names
✅⏳	jsdoc/check-tag-names
	jsdoc/check-types
	jsdoc/check-values
✅⏳	jsdoc/empty-tags
	jsdoc/escape-inline-tags
✅	jsdoc/implements-on-classes
	jsdoc/multiline-blocks
✅⏳	jsdoc/no-defaults
	jsdoc/no-multi-asterisks
	jsdoc/no-undefined-types
	jsdoc/reject-any-type
	jsdoc/reject-function-type
	jsdoc/require-jsdoc
	jsdoc/require-next-type
✅⏳	jsdoc/require-param
✅⏳	jsdoc/require-param-description
✅	jsdoc/require-param-name
✅	jsdoc/require-param-type
✅⏳	jsdoc/require-property
✅	jsdoc/require-property-description
✅	jsdoc/require-property-name
✅	jsdoc/require-property-type
✅⏳	jsdoc/require-returns
	jsdoc/require-returns-check
✅	jsdoc/require-returns-description
✅	jsdoc/require-returns-type
✅	jsdoc/require-throws-type
✅	jsdoc/require-yields
	jsdoc/require-yields-check
✅	jsdoc/require-yields-type
	jsdoc/tag-lines
	jsdoc/ts-no-empty-object-type
	jsdoc/valid-types

✅ = Implemented, = Not intending to implement, ⏳ = Fix pending

Not recommended rules

✅: 3, : 3, ⏳: 0 / total: 41

Status	Name	Rationale
	jsdoc/check-examples	Deprecated.
	jsdoc/check-indentation
	jsdoc/check-line-alignment
	jsdoc/check-syntax
	jsdoc/check-template-names
	jsdoc/convert-to-jsdoc-comments	Experimental rule in the original plugin, may reconsider once stable.
	jsdoc/imports-as-dependencies
	jsdoc/informative-docs
	jsdoc/lines-before-block
	jsdoc/match-description
	jsdoc/match-name
	jsdoc/no-bad-blocks
	jsdoc/no-blank-block-descriptions
✅	jsdoc/no-blank-blocks
	jsdoc/no-missing-syntax
	jsdoc/no-restricted-syntax
	jsdoc/no-types
	jsdoc/no-unnecessary-type-assertion
	jsdoc/normalize-see-links
	jsdoc/prefer-import-tag
	jsdoc/require-asterisk-prefix
	jsdoc/require-description
	jsdoc/require-description-complete-sentence
	jsdoc/require-example
	jsdoc/require-file-overview
	jsdoc/require-hyphen-before-param-description
	jsdoc/require-next-description
	jsdoc/require-rejects
	jsdoc/require-tags
	jsdoc/require-template
	jsdoc/require-template-description
	jsdoc/require-throws
✅	jsdoc/require-throws-description
✅	jsdoc/require-yields-description
	jsdoc/sort-tags
	jsdoc/text-escaping
	jsdoc/ts-ban-ts-comment
	jsdoc/ts-method-signature-style
	jsdoc/ts-no-unnecessary-template-expression
	jsdoc/ts-prefer-function-type
	jsdoc/type-formatting	Experimental rule in the original plugin, may reconsider once stable.

✅ = Implemented, = Not intending to implement, ⏳ = Fix pending