fix(api): nestling generated schemas into a new schemas/ directory
#756
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
erunion
added
bug
erunion
commented
Oct 12, 2023
| readonly title: "Tag"; | ||
| readonly "x-readme-ref-name": "Tag"; | ||
| }; | ||
| import Category from './schemas/Category'; |
There was a problem hiding this comment.
This is wrong because CJS and ESM compilation with ts-morph don't create this schemas/ directory but because we're overhauling the CJS and ESM compilation work with #754 I'm going to leave this breakage alone.
|
hell yeah 🫶🏽 |
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.
🧰 Changes
With the ESM and tsup work we're doing in #754 I discovered that the way we're currently generating
schemas.tsmight result in an uncompilable file due to the way we're processing OpenAPI component schemas top-down.Basically what happens is that if you use a
$refcomponent in a schema and that component exists further down in the API definition we'll generate aschemas.tsin the order they were specified resulting in us attempting to useconstthat has not been created yet:There are a number of ways that we can fix this but @kanadgupta had the great idea to shove these schemas into individual files in a new
schemas/directory. The result is that codegen'd SDKs have n more files now but they'll at least be able to be compiled with tooling liketsup.