Derive @bust/config types from the schema - #5
Merged
Merged
Conversation
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
Config.get()returned a seven-member union for a key typed as plainstring, so every call site had to coerce or cast the result and a typo'd key only surfaced at runtime. This threads the schema's shape through as a type parameter, so e.g.get('app.port')returnsnumber, an enum format returns its literal union, and an undeclared key is a compile error.How to Test
npm testnpm run test:e2epackages/config/src/, callcreateConfig()with a schema using several formats, in your IDE hover theget()results, then runnpm run typecheckOutcome
All tests pass. Each
get()call reports the type its format implies rather thanSettingsValue, an undeclared key failstypecheck, and an untypednew Config()still accepts any string key.Related / Discussions
N/A
Completeness
npm run docs:build)main)