Add static schema.json
for Inngest config JSON Schema typing
#231
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.
Summary
Adds a static
schema.json
in the root directory to be used to provide type hinting and validation to users while creating/editing Inngest config files.We could also refer to specific versions of the schema, though I think it makes sense to target main so we're looking at the very latest valid version.
I'd love to generate this directly from pkg/cuedefs/v1/function.cue, but our path to conversion doesn't yet support comments - see cue-lang/cue#1180. The comments are crucial to fulfil the purpose of teaching the user through tooling, hence the static version.
We could potentially introduce a very simple Dangerfile to prompt in PRs if
function.cue
is changed andschema.json
is not to ensure they're kept in sync until cue-lang/cue#1180 is resolved.Next