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

Stricter types #1077

Merged
merged 14 commits into from
Nov 20, 2024
Merged

Stricter types #1077

merged 14 commits into from
Nov 20, 2024

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Nov 15, 2024

Description of proposed changes

While working on #1073, I thought it was reasonable to avoid casting and non-null assertions across the entire codebase. This is an attempt to enforce it and address outstanding violations.

Related

Follow-up to #1073 (comment)

Checklist

@victorlin victorlin self-assigned this Nov 15, 2024
@nextstrain-bot nextstrain-bot temporarily deployed to nextstrain-s-victorlin--3p4dgg November 15, 2024 02:47 Inactive
@victorlin victorlin marked this pull request as ready for review November 15, 2024 02:47
@victorlin victorlin temporarily deployed to nextstrain-s-victorlin--3p4dgg November 19, 2024 18:20 Inactive
Base automatically changed from victorlin/type-narrowing to master November 19, 2024 18:23
I originally wanted `no-non-null-assertion`, then realized that it was
part of the strict ruleset. All violations of this ruleset seem
reasonable to address, which I will do in subsequent commits.

<https://typescript-eslint.io/users/configs/#strict>
This makes it appropriate for other components outside of ListResources
to re-use this functionality.
With the current code, it is not possible for these values to be
undefined. Make this clear with type narrowing.
Instead of checking null-ness to initialize an empty array then using a
non-null assertion which is loosely coupled to the preceding line, do
both in one line.
With the current code, it is not possible for this to be
undefined. Make this clear with type narrowing.
ESLint has no way of knowing that this is safe code. Add an exception
for this line with a comment explaining what it does.
The parent constructor is automatically used by default.

<https://typescript-eslint.io/rules/no-useless-constructor/>
This should not be used unless there is no other way for the TypeScript
compiler to infer the type properly. In such cases, a comment with
per-line exception should be used.

I will address existing violations in subsequent commits.
This properly handles any new changes to input values defined by the
form.
I remember this was tricky and couldn't figure out a way to map
featured-analyses.yaml to SplashTile[] without this type assertion.
The type is already set on this variable.
I'm not sure if it's possible for a non-Error error to be thrown in
these parts, but TypeScript thinks it is possible and it's easy to
handle.
@victorlin victorlin temporarily deployed to nextstrain-s-victorlin--3p4dgg November 19, 2024 23:13 Inactive
@victorlin victorlin temporarily deployed to nextstrain-s-victorlin--3p4dgg November 20, 2024 01:09 Inactive
@victorlin
Copy link
Member Author

@genehack could you re-review? I've pushed 4982fa8 to account for the OpenGraph addition in 639eae0.

@victorlin victorlin merged commit 1d8c627 into master Nov 20, 2024
7 checks passed
@victorlin victorlin deleted the victorlin/stricter-types branch November 20, 2024 19:30
@victorlin victorlin mentioned this pull request Nov 20, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants