Add schema.json to have a better IDE intellisense
#634
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
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/vercel/turbo-site/F3tW9nj4vsT5hEGsXLUK2re33ZvD |
|
https://turbo-site-git-fork-arthurfiorette-main.vercel.sh/schema.json Another thing that can be done is also mention the hability to get from |
jaredpalmer
reviewed
Jan 31, 2022
|
@jaredpalmer anything more? |
jaredpalmer
suggested changes
Feb 8, 2022
jaredpalmer
suggested changes
Feb 8, 2022
jaredpalmer
approved these changes
Feb 9, 2022
Schniz
added a commit
that referenced
this pull request
Mar 3, 2022
This commit continues the amazing work done in #634 and #726. Instead of generating the JSON schema from a separate TypeScript file, this commit introduces a new CLI (to avoid bloating the main one) that will output a JSON schema from the struct definition itself, including the actual code comments. This will allow to better integration and to avoid differences between the two codebases.
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 an
schema.d.tsfile with all (documented ones) properties in theturbo.jsonfile. This way, and combining with the newnpm run jsonschemascript, it's possible to generate an Json schema file.I configured to the generated file be placed at
docs/public/schema.json, so it can be requested from the urlhttps://turborepo.org/schema.json. You can test how powerfull it is with in IDE autocompletion, intellisense and inline documentation.Try it out in your IDE by adding
"$schema": "./docs/public/schema.json"It also updated all (that i saw :P) documentation examples to include the
$schemaproperty, this way, it will go by default for allCtrl C/Vusers out there.But i still need to point out some things:
jsonschema(Is that even a good name?) script is going to be ran a lot, may we addts-json-schema-generatorto thedevDependenciesgroup?turbo.jsonfile, i saw anenvproperty, but it is not documented, should i add it or it just shouldn't be there?schema.d.tsfile, it is not perfect and it probably has some typos.That's it for now. Thanks for this amazing package!