Add type system tests for SettingsDefinition#747
Merged
Conversation
Contributor
NPM Publishing labels 🏷️🔵 This PR has the |
dae64a6 to
396f593
Compare
mxiao-cll
approved these changes
Apr 24, 2026
Contributor
|
❌ failed to create version bump PR |
This file contains hidden or 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
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.
Description
The config system defines some intricate types that enforce certain characteristics on the settings derived from the definition. Things like "if a setting of type
'number'has a default value, that default value must be anumberor "only settings of type'enum'can haveoptions.I'm looking into extending the config system to support variable variables where the actual variable name depends on a parameter such as
network.In the process, I'll be changing the types and I want to make sure I don't break the existing restriction imposed by the type system.
Change
Add a file with "type system tests". These are type declarations that either must be accepted or rejected by the compiler. The ones that must be rejected are annotated with
@ts-expect-error. This will cause the compiler to produce an error if the type declaration ever becomes valid.Testing
yarn test.