Add editor support for JSON config schema #4724
Conversation
tobias-tengler
changed the title
tobias-tengler
force-pushed
the
json-schema-editor-support
branch
from
f99e430 to
82ea067
Compare
captbaritone
force-pushed
the
json-schema
branch
from
e7e0561 to
eb29575
Compare
tobias-tengler
force-pushed
the
json-schema-editor-support
branch
3 times, most recently
from
65293b7 to
29ede39
Compare
|
I just had another idea. Since the VSCode extension already knows how to invoke the compiler binary, and the compiler binary can construct the json schema, what if we added a separate compiler command to return the schema text on stdout? It seems like that might be simpler. It would also work better for us internally since we don't access the compiler via an NPM module but a separate binary deployment which would be hard to update to also sync a sibling file. I'll work on a compile diff to add this support. |
tobias-tengler
force-pushed
the
json-schema-editor-support
branch
2 times, most recently
from
9c31623 to
0982908
Compare
tobias-tengler
changed the title
|
|
||
| provideTextDocumentContent(uri: Uri): ProviderResult<string> { | ||
| if (uri.authority === PACKAGE_JSON_RELAY_CONFIG_SCHEMA_PATH) { | ||
| return `{"properties": { "relay": { "$ref": "${RelayTextDocumentContentProvider.scheme}://${RELAY_CONFIG_SCHEMA_PATH}", "description": "Relay.js configuration" }}}`; |
There was a problem hiding this comment.
This little recursion trick is so clever. Nice.
| } | ||
|
|
||
| if (uri.authority === RELAY_CONFIG_SCHEMA_PATH) { | ||
| this.cachedJsonSchema ||= this.loadConfigJsonSchema(); |
There was a problem hiding this comment.
If the user changes their relay binary path in the config file, does this get invalidated correctly?
There was a problem hiding this comment.
No, but you have to restart the extension anyways because the binary information is only loaded once at startup atm.
|
|
||
| if (binaryVersion) { | ||
| const hasConfigJsonSchemaCommand = | ||
| semver.satisfies(binaryVersion, '>=18.0') || |
There was a problem hiding this comment.
This probably needs to be updated depending on what the release schedule will be like. Just picked the next major for now.
There was a problem hiding this comment.
Since it will be in the next release, can we just say >17.0.0?
There was a problem hiding this comment.
Sorry, one more realization. What happens if you use a version of the compiler from the @main NPM tag? Will that work or not? Would be cool to be able to test this end to end before the next release by installing the new version of the extension and installing relay-compiler@main (note that @main releases are currently stuck due to broken CI)
tobias-tengler
force-pushed
the
json-schema-editor-support
branch
from
0982908 to
7e70f40
Compare
|
The Prettier and ESLint rules are conflicting... Nice |
tobias-tengler
force-pushed
the
json-schema-editor-support
branch
from
7e70f40 to
8a02bdb
Compare
| @@ -25,6 +25,7 @@ module.exports = { | |||
| 'operator-linebreak': 'off', | |||
| '@typescript-eslint/indent': 'off', | |||
| '@typescript-eslint/object-curly-spacing': 'off', | |||
| '@typescript-eslint/brace-style': 'off', | |||
|
Verified that it would attempt to load the JSON schema for a prerelease compiler (but it wasn't working of course since there isn't a released version with the |
|
@captbaritone has imported this pull request. If you are a Meta employee, you can view this diff on Phabricator. |
|
@captbaritone merged this pull request in c434290. |
No description provided.