feat: strongly type with jsdoc typings #2612
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Conflicts: # lib/Instance/CustomVariable.js # lib/Instance/Variable.js # lib/UI/Express.js # package.json
# Conflicts: # lib/Graphics/Controller.js
|
I am merging this into develop so that it can get a bit of testing by both me and other adventurous users. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
There have been a bunch of bugs recently due to either typos made during development, or introduced during merges. Without static typings these are really hard to spot without encountering them while using the software.
I chose jsdoc as a middle-ground for not being as strict and opinionated as typescript, and as an easier first step. There are some typescript files introduced here, but containing purely interfaces, so are not needed to have a runnable application. Using typescript for these files made the types easier to write and understand than the more awkward jsdoc.
Some of the bugs that were found recently:
Some fixes backported from this jsdoc work (not everything was):