Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
JoshuaKGoldberg opened this issue Oct 29, 2023 · 0 comments · Fixed by #8145
Closed

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

JoshuaKGoldberg opened this issue Oct 29, 2023 · 0 comments · Fixed by #8145
Assignees
@JoshuaKGoldberg
Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs

Comments

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Oct 29, 2023 •
edited
Loading

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
@JoshuaKGoldberg JoshuaKGoldberg added triage Waiting for team members to take a look repo maintenance things to do with maintenance of the repo, and not with code/docs labels Oct 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Oct 29, 2023
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg self-assigned this Dec 27, 2023
@JoshuaKGoldberg JoshuaKGoldberg added accepting prs Go ahead, send a pull request that resolves this issue and removed triage Waiting for team members to take a look labels Dec 27, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 27, 2023
Merged
3 tasks
@JoshuaKGoldberg JoshuaKGoldberg changed the title Repo: Bring in eslint-plugin-jsdoc Repo: Bring in eslint-plugin-jsdoc recommended-typescript-error preset Dec 29, 2023
@JoshuaKGoldberg JoshuaKGoldberg mentioned this issue Dec 29, 2023
Closed
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 15, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@JoshuaKGoldberg JoshuaKGoldberg

Labels
accepting prs Go ahead, send a pull request that resolves this issue repo maintenance things to do with maintenance of the repo, and not with code/docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: enable eslint-plugin-jsdoc internally JoshuaKGoldberg/typescript-eslint
1 participant
@JoshuaKGoldberg