Improve codegen typings #2999
Open
Improve codegen typings #2999
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
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
3 times, most recently
from
2abd90e to
ef8af3f
Compare
matthieusieben
changed the title
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
2 times, most recently
from
bebca0e to
0bea135
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
0bea135 to
02ddb9a
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
02ddb9a to
1a337a2
Compare
rafaelbsky
approved these changes
Nov 18, 2024
devinivy
reviewed
Dec 2, 2024
devinivy
reviewed
Dec 2, 2024
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
2714235 to
617d86c
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
6e398be to
17b3081
Compare
devinivy
approved these changes
Dec 19, 2024
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
3 times, most recently
from
49690ba to
819eeac
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
5e0b6ff to
a101316
Compare
matthieusieben
changed the title
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
7 times, most recently
from
0133f4a to
7fa74c3
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
7fa74c3 to
6630a9b
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
6630a9b to
6fa83af
Compare
This was referenced Jan 26, 2025
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
3 times, most recently
from
9bbc1ae to
cfa432c
Compare
matthieusieben
force-pushed
the
msi/lex-gen-optimization
branch
from
cfa432c to
78c8561
Compare
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 is the first of a 2 steps changes aimed at improving typing in the atproto repo:
$typeproperty to records and user object types. Improves the typing of isX and validateX helpers.Breaking changes
This PR changes the interfaces of the generated code in the following ways:
[x: string]: unknownindex signature in objects & records. Because of this, access to un-speccified fields must be explicit.$typeproperty explicit (though optional, except in open unions). This allows to properly discriminate entity types, especially when used in open unions.isMyType(value)utilities no longer type cast thevaluebeing checked. They only type the presence of the$typeproperty. UseisValidMyTypeto assert the type through validation.Note
When reviewing, "codegen" commits can be ignored as they only contain generated code changes.
Fixes #2952