core(fr): more precise AnyFRInterface types #12622
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
patrickhulce
commented
Jun 4, 2021
| @@ -108,7 +108,9 @@ function resolveArtifactsToDefns(artifacts, configDir) { | |||
| throw new Error(`${gatherer.instance.name} gatherer does not support Fraggle Rock`); | |||
| } | |||
|
|
|||
| /** @type {LH.Config.ArtifactDefn<LH.Gatherer.DependencyKey>} */ | |||
| /** @type {LH.Config.AnyArtifactDefn} */ | |||
| // @ts-expect-error - Typescript can't validate the gatherer and dependencies match | |||
There was a problem hiding this comment.
this is the only place I couldn't figure out how to solve.
🤓 🔫 @brendankenny if you're interested :)
the only thing I could think was to re-validate that resolveArtifactDependencies matches outside the function, but that seemed excessive
adamraine
reviewed
Jun 4, 2021
Co-authored-by: Adam Raine <[email protected]>
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.
Summary
Fixes the issue raised in #12619
The type violations were in fact valid and stemmed from my abuse of
Interface<AllPossibleKeys>to be a substitute forInterface<Key1> | Interface<Key2> | Interface<Key3>. I introducedAnyInterfacetypes to more accurately reflect when a function accepts or returns any possible artifact/gatherer/dependency object instead. This still has the limitation that it doesn't programmatically generate the combinatorial versions, but I haven't bumped into a scenario where the handling differs/matters yet.Solves @adamraine 's original point (see screenshot)
Related Issues/PRs
fixes #12619
ref #11313