Use @ethdebug/format as home package for TypeScript types and type predicates #130
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
gnidan
force-pushed
the
packages
branch
2 times, most recently
from
b92bb58 to
eb71979
Compare
gnidan
force-pushed
the
packages
branch
2 times, most recently
from
7329bee to
80a037d
Compare
gnidan
changed the title
- Setup jest in @ethdebug/format
- Centralize all the schema types and type predicates into a src/types
directory
- Turn on strict optional property business even though it makes
describeSchema a bit uglier
- Don't stare too long at describeSchema right now even though you want
to fix it
- Move jest stuff back from the root into @ethdebug/format's directory
- Get rid of the `/// <reference` garbage, yay
- Downgrade chalk to avoid turning @ethdebug/format into ESM
- Fix implementation guide code listing for Pointer, which was just
removed from @ethdebug/pointers
- Add @ethdebug/format to CodeListing's internal package awareness
- Define new `includePackageNameInTitle?: boolean` property on
CodeListing, so that the implementation guide can be explicit on
that page.
- Fix some wording
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.
This PR adds types and type predicates for schemas in the following ethdebug/format namespaces:
These new implementations follow the convention previously established by @ethdebug/pointers, to use the official schema examples as the test cases for the new type predicates.
Going a step further, this PR also moves the existing pointer types/type predicates from its home in @ethdebug/pointers into @ethdebug/format.
As a consequence of this new code centralization, this PR also moves the jest custom matchers stuff out of the repo root (where I just put it), since it's easier and makes more sense now to include this in the only package that will be doing this kind of automated predicate testing.
Besides all this, this PR also has some various required configuration changes, including tweaks to the website's implementation guide stuff (since there's been a change to a referenced code location)