infra: modernize and improve rigor/safety of ferris.js #3937
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
- Use `let` instead of `var` throughout. All modern browsers support it
and have for many years, even the now-EOL IE11.[^ie]
- Add a `@ts-check` annotation so that anyone working on a TS-enabled
editor will get feedback inline about cases they may otherwise miss.
- Add JSDoc-based type definitions for the script, and fix some errors
that may occur at runtime. (These will be rare if they happen, but
getting rid of them is still a win!)
[^ie]: IE11 did not correctly support the semantics of `let` for `for`
loops, but the uses in the existing code here already used `var` in
a way which would trigger the same behavior as using `let` does.
chriskrycho
commented
May 22, 2024
| @@ -1,4 +1,11 @@ | |||
| var ferrisTypes = [ | |||
| // @ts-check | |||
There was a problem hiding this comment.
Note: this does not require folks to have or use TS to contribute to this; it just enables inline feedback when working on the file for people who do use editors which integrate TS, or for folks who opt into it.
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.
letinstead ofvarthroughout. All modern browsers support it and have for many years, even the now-EOL IE11.1@ts-checkannotation so that anyone working on a TS-enabled editor will get feedback inline about cases they may otherwise miss.screenshots to show it still works
Footnotes
IE11 did not correctly support the semantics of
letforforloops, but the uses in the existing code here already usedvarin a way which would trigger the same behavior as usingletdoes. ↩