Skip to content
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.

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

🛠️ Repo: Lint/validate JSDoc #4228

Open
boneskull opened this issue Apr 14, 2020 · 1 comment
Open

🛠️ Repo: Lint/validate JSDoc #4228

boneskull opened this issue Apr 14, 2020 · 1 comment
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team status: accepting prs Mocha can use your help with this one! type: chore generally involving deps, tooling, configuration, etc.

Comments

@boneskull
Copy link
Contributor

I'm getting bit with failing documentation builds because I'm writing docstrings that JSDoc doesn't like (specifically, TS-style). But there's no linting happening before getting to Netlify.

We may be able to make JSDoc just check the syntax and exit (and make it part of the lint scripts).

This is moot if we want to move forward with maintaining our own TS types (for which there is an open PR that I cannot find atm). That will most likely require dumping JSDoc in lieu of a TS-based API doc generator, because the types aren't really compatible.

There may be another ESLint-based solution, but I'm not sure. If someone else thinks this is worth doing, please add help wanted label, but I don't want anyone to pick this up unless there's agreement that it's worth bothering with (if we're going to eventually have to drop JSDoc).

@boneskull boneskull added area: documentation anything involving docs or mochajs.org type: chore generally involving deps, tooling, configuration, etc. labels Apr 14, 2020
@JoshuaKGoldberg JoshuaKGoldberg changed the title lint the jsdoc 🛠️ Repo: Lint/validate JSDoc Dec 27, 2023
@JoshuaKGoldberg JoshuaKGoldberg added area: repository tooling concerning ease of contribution and removed area: documentation anything involving docs or mochajs.org labels Dec 27, 2023
@JoshuaKGoldberg
Copy link
Member

Marking as accepting PRs in lieu of #4154. Even if the whole repo were to be converted to TypeScript it'd still be good to have some linting for JSDocs (i.e. eslint-plugin-jsdoc).

@JoshuaKGoldberg JoshuaKGoldberg added status: accepting prs Mocha can use your help with this one! core-team issues which must be handled by Mocha's core team type: feature enhancement proposal type: chore generally involving deps, tooling, configuration, etc. and removed type: chore generally involving deps, tooling, configuration, etc. type: feature enhancement proposal labels Feb 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: repository tooling concerning ease of contribution core-team issues which must be handled by Mocha's core team status: accepting prs Mocha can use your help with this one! type: chore generally involving deps, tooling, configuration, etc.
Projects
None yet
Development

No branches or pull requests

2 participants