Improvements to JSDoc and constructors #1120
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
Problem
We do not have any lint checks on the JSDoc, which is a bit arcane. We do not generate JSDoc based documentation any more, but it may be used by smart editors for autocomplete et al.
Solution
TypeScript supports processing javascript files. I ran the following command and fixed a number of issues it picked up. The two most common were properties missing from constructor (and so unrecognised as valid), and issues with JSDoc declarations being inaccurate compared with the code.
npx tsc --allowJS --checkJS index.js --noEmit