https://github.com/uhyo/nitrogql

GraphQL + TypeScript toolchain
https://github.com/uhyo/nitrogql

graphql typescript

Last synced: 4 days ago
JSON representation

GraphQL + TypeScript toolchain

• Host: GitHub
• URL: https://github.com/uhyo/nitrogql
• Owner: uhyo
• License: mit
• Created: 2023-02-11T14:24:43.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-08-19T13:57:32.000Z (4 months ago)
• Last Synced: 2024-12-12T17:44:42.787Z (12 days ago)
• Topics: graphql, typescript
• Language: Rust
• Homepage: https://nitrogql.vercel.app
• Size: 11.9 MB
• Stars: 320
• Watchers: 3
• Forks: 9
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
![nitrogql logo](./assets/logo/logo-and-text.png)

**GraphQL + TypeScript. Done right.**

**[Documentation](https://nitrogql.vercel.app/)**

# nitrogql

**nitrogql** is a toolchain for using GraphQL in TypeScript projects. Main features include:

## Type generation with sourcemap support.

nitrogql generates TypeScript types for your GraphQL schema and queries. It also generates a sourcemap file that maps the generated types to the original GraphQL schema and queries. With sourcemaps, you will never see generated code in your IDE, and you will always be able to jump to the original source code.

![VSCode's "Peek Definition" command showing the original GraphQL query](./assets/docs/screenshot-peek-definition.png)

## Static check for GraphQL code.

nitrogql can check your GraphQL code statically and guard you from any runtime errors caused by type mismatch.

![Result of running `nitrogql check` on a sample project](./assets/docs/screenshot-check.png)

## Installation

Install the nitrogql CLI with npm:

```sh

npm install --save-dev @nitrogql/cli

```

The CLI will enable you to check GraphQL files and generate types. Read more about the CLI in the [CLI documentation](https://nitrogql.vercel.app/cli).

To use GraphQL in your front-end project, you will also need to install appropriate loader.

For webpack-based projects:

```sh

npm install --save-dev @nitrogql/graphql-loader

```

For Rollup-based projects:

```sh

npm install --save-dev @nitrogql/rollup-plugin

```

## Feedback wanted!

Do you use [GraphQL Code Generator](https://the-guild.dev/graphql/codegen)? nitrogql wants to be a great alternative to GraphQL Code Generator.

If you are using it and you have time, read our [documentation](https://nitrogql.vercel.app/) to check whether you can replace GraphQL Code Generator with nitrogql.

If you can't, what blocks you from doing so? Please leave us feedback!