fix(cli): improve error handling on missing extracted schema #6204
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
|
No changes to documentation |
|
Component Testing Report Updated Apr 4, 2024 5:32 PM (UTC)
|
rexxars
force-pushed
the
fix/typegen-cli-hint-on-error
branch
from
9061cbc
to
1a01fa1
Compare
sgulseth
requested changes
Apr 4, 2024
Co-authored-by: Sindre Gulseth <sgulseth@gmail.com>
rexxars
force-pushed
the
fix/typegen-cli-hint-on-error
branch
from
348bd5e
to
ef550f1
Compare
sgulseth
approved these changes
Apr 4, 2024
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
When you run
sanity typegen generate, a fairly common case is that one may have forgotten to runsanity schema extractfirst. This currently gives a rather unhelpful error (if you're unfamiliar with the setup):With this PR, I propose that we give a more helpful error if you have not provided even a custom path for the schema:
I also noticed that using a
--config-pathflag did not work, only--configPath. To be consistent with other CLI commands, I changed this to allow both forms.Testing
Added some basic tests to ensure that the different forms work and gives the expected output.
Notes for release
sanity schema extract) could not be found when runningsanity typegen generate