mirror of
https://github.com/ModernRelay/omnigraph.git
synced 2026-06-30 02:49:39 +02:00
Add query lint and check commands
This commit is contained in:
parent
4abe9e3627
commit
1bf55fa52d
7 changed files with 1088 additions and 9 deletions
36
og-cheet-sheet.md
Normal file
36
og-cheet-sheet.md
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
# Omnigraph Cheat Sheet
|
||||
|
||||
## Local Query Validation
|
||||
|
||||
Use an explicit schema file:
|
||||
|
||||
```bash
|
||||
omnigraph query lint --query ./queries.gq --schema ./schema.pg --json
|
||||
omnigraph query check --query ./queries.gq --schema ./schema.pg
|
||||
```
|
||||
|
||||
Use a local or `s3://` repo target:
|
||||
|
||||
```bash
|
||||
omnigraph query lint --query ./queries.gq ./repo.omni --json
|
||||
omnigraph query check --query ./queries.gq s3://bucket/repo
|
||||
```
|
||||
|
||||
Use `omnigraph.yaml` target resolution:
|
||||
|
||||
```bash
|
||||
omnigraph query lint --query ./queries.gq --target local --config ./omnigraph.yaml
|
||||
```
|
||||
|
||||
## What It Checks
|
||||
|
||||
- parses every query in the file
|
||||
- typechecks each query against the resolved schema
|
||||
- warns on hardcoded mutation queries with no params
|
||||
- warns when nullable node fields have no update-query coverage
|
||||
|
||||
## Current Limits
|
||||
|
||||
- repo-backed lint is local/S3-only in v1
|
||||
- HTTP targets need `--schema`
|
||||
- exit code is nonzero only when there are strict validation errors
|
||||
Loading…
Add table
Add a link
Reference in a new issue