Skip to content

Show config help hint on config parse errors#5312

Open
captbaritone wants to merge 2 commits into
facebook:mainfrom
captbaritone:config-error-help
Open

Show config help hint on config parse errors#5312
captbaritone wants to merge 2 commits into
facebook:mainfrom
captbaritone:config-error-help

Conversation

@captbaritone

@captbaritone captbaritone commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

Summary

Relay config is quite extensive and as a result and be quite confusing. Our error messages are pretty good, but both humans and agents are easily confused. This allows us to give direct access to what config options exist:

  1. Agents can invoke the compiler and parse/explore the json schema
  2. Humans can visit our docs (which are generated from the json schema)

Example output on a config error:

Unable to initialize relay compiler configuration. Error details:
Error searching config: Invalid config file: ...

Hint: You can dump the config JSON schema with:
  relay-compiler config-json-schema

For documentation, see:
  https://relay.dev/docs/getting-started/compiler-config/

Test plan

  • CI passes
  • Manually verify with an invalid relay.config.json that the hint appears

When the compiler fails to parse or validate the config file, append a
hint pointing users to the `config-json-schema` CLI subcommand and the
config documentation page on relay.dev.
@meta-cla meta-cla Bot added the CLA Signed label Jun 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant