Skip to content

Repo: Bring in eslint-plugin-jsdoc recommended-typescript-error preset #7855

Closed
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Suggestion

I've been using https://github.com/gajus/eslint-plugin-jsdoc for a little while now in my personal repos and quite like it. Especially its "plugin:jsdoc/recommended-typescript-error" preset has quite a few rules that generally adhere to how we ask folks to write things in this repo.

Also of interest is https://github.com/gajus/eslint-plugin-jsdoc/blob/aefceca7413ac0263ed1b58127fff4efca89de4f/docs/rules/informative-docs.md. IMO we should enable this to help folks accustomed to writing comments like @param id the id (it happens sometimes). Split out to #8156

Metadata

Metadata

Labels

accepting prsGo ahead, send a pull request that resolves this issuerepo maintenancethings to do with maintenance of the repo, and not with code/docs

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions