grats

Grats: Implementation-First GraphQL for TypeScript

Beta Software: Grats is largely stable and being used in production in multiple places. If you encounter any issues, don't hesitate to let us know.

What if building a GraphQL server were as simple as just writing functions?

When you write your GraphQL server in TypeScript, your fields and resolvers are already annotated with type information. Grats leverages your existing type annotations to automatically extract an executable GraphQL schema from your generic TypeScript resolver code.

By making your TypeScript implementation the source of truth, you never have to worry about validating that your implementation matches your schema. Your implementation is your schema!

Example

Here's what it looks like to define a User type with a greeting field using Grats:

/** @gqlType */
class User {
  /** @gqlField */
  name: string;

  /** @gqlField */
  greet(args: { greeting: string }): string {
    return `${args.greeting}, ${this.name}`;
  }
}

After running npx grats, you'll find a schema.ts module that exports an executable schema, and a schema.graphql file contains your GraphQL schema definition:

type User {
  name: String
  greet(greeting: String!): String
}

That's just the beginning! To learn more, Read the docs: https://grats.capt.dev/

Contributing

See CONTRIBUTING.md in the repo root for details on how to make changes to this project.

Acknowledgements

• @mofeiZ and @alunyov for their Relay hack-week project exploring a similar idea.
• @josephsavona for input on the design of Relay Resolvers which inspired this project.
• @bradzacher for tips on how to handle TypeScript ASTs.
• Everyone who worked on Meta's Hack GraphQL server, the developer experience of which inspired this project.
• A number of other projects which seem to have explored similar ideas in the past:
  • ts2gql
  • ts2graphql
  • typegraphql-reflection-poc