diff options
Diffstat (limited to 'vendor/github.com/vektah/gqlparser/readme.md')
| -rw-r--r-- | vendor/github.com/vektah/gqlparser/readme.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/vendor/github.com/vektah/gqlparser/readme.md b/vendor/github.com/vektah/gqlparser/readme.md new file mode 100644 index 00000000..976d202b --- /dev/null +++ b/vendor/github.com/vektah/gqlparser/readme.md @@ -0,0 +1,17 @@ +gqlparser [](https://circleci.com/gh/vektah/gqlparser) [](https://goreportcard.com/report/github.com/vektah/gqlparser) [](https://coveralls.io/github/vektah/gqlparser?branch=master) +=== + +This is a parser for graphql, written to mirror the graphql-js reference implementation as closely while remaining idiomatic and easy to use. + +spec target: June 2018 (Schema definition language, block strings as descriptions, error paths & extension) + +This parser is used by [gqlgen](https://github.com/99designs/gqlgen), and it should be reasonablly stable. + +Guiding principles: + + - maintainability: It should be easy to stay up to date with the spec + - well tested: It shouldnt need a graphql server to validate itself. Changes to this repo should be self contained. + - server agnostic: It should be usable by any of the graphql server implementations, and any graphql client tooling. + - idiomatic & stable api: It should follow go best practices, especially around forwards compatibility. + - fast: Where it doesnt impact on the above it should be fast. Avoid unnecessary allocs in hot paths. + - close to reference: Where it doesnt impact on the above, it should stay close to the [graphql/graphql-js](github.com/graphql/graphql-js) reference implementation. |