Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gabotechs/graphqxl

GraphQXL is a new language built on top of the GraphQL syntax that extends the original language with some additional features useful for creating scalable and big server side schemas. This repository contains the source code for the GraphQXL compiler.
https://github.com/gabotechs/graphqxl

api apollo apollo-server compiler graphql grapqhl-client language rust schema server transpiler

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/gabotechs/graphqxl
Owner: gabotechs
License: mit
Created: 2022-08-01T15:15:07.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2024-03-18T19:00:03.000Z (8 months ago)
Last Synced: 2024-10-16T06:16:03.184Z (25 days ago)
Topics: api, apollo, apollo-server, compiler, graphql, grapqhl-client, language, rust, schema, server, transpiler
Language: Rust
Homepage: https://gabotechs.github.io/graphqxl
Size: 1.5 MB
Stars: 272
Watchers: 7
Forks: 8
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

[![Coverage Status](https://coveralls.io/repos/github/gabotechs/graphqxl/badge.svg?branch=main)](https://coveralls.io/github/gabotechs/graphqxl?branch=main)
[![Book](https://img.shields.io/badge/book-WIP-4d76ae.svg)](https://gabotechs.github.io/graphqxl)
![](https://img.shields.io/github/v/release/gabotechs/graphqxl?color=%e535abff)

GraphQXL is a new language built on top of the GraphQL syntax that extends the original
language with some additional features useful for creating scalable and big server side schemas.

# Documentation

There is a WIP version of the `GraphQXL book` with some useful docs, you can check it [here](https://gabotechs.github.io/graphqxl)

# Features
### Object inheritance

Use the spread operator to inherit fields from other types or inputs. Descriptions
will also be inherited.

[Try it yourself!](https://graphqxl-explorer.vercel.app?code=dHlwZSBfT3RoZXJUeXBlIHsKICAgICJEZXNjcmlwdGlvbnMgYXJlIGFsc28gaW5oZXJpdGVkIgogICAgYmFyOiBJbnQhCn0KCnR5cGUgTXlUeXBlIHsKICAgIGZvbzogU3RyaW5nIQogICAgLi4uX090aGVyVHlwZQp9)

Source GraphQXL

Compiled GraphQL

```graphql
type _OtherType {
"Descriptions are also inherited"
bar: Int!
}

type MyType {
foo: String!
..._OtherType
}
#GraphQXL
```

```graphql
type MyType {
foo: String!
"Descriptions are also inherited"
bar: Int!
}

#GraphQL
```

### Generics

Declare generic types and inputs in order to reuse common structures across your schema.

[Try it yourself!](https://graphqxl-explorer.vercel.app?code=dHlwZSBHZW5lcmljPFQ%2bIHsKICAgIGZvbzogVAp9Cgp0eXBlIE15U3RyaW5nVHlwZSA9IEdlbmVyaWM8U3RyaW5nIT4KCnR5cGUgTXlJbnRUeXBlID0gR2VuZXJpYzxJbnQhPgo=)

Source GraphQXL

Compiled GraphQL

```graphql
type Generic {
foo: T
}

type MyStringType = Generic

type MyIntType = Generic

#GraphQXL
```

```graphql
type MyStringType {
foo: String!
}

type MyIntType {
foo: Int!
}

#GraphQL
```

### Modifiers

Modify `types` and `inputs` with built-in modifiers.

[Try it yourself!](https://graphqxl-explorer.vercel.app?code=dHlwZSBfTXlUeXBlIHsKICAgIGZvbzogU3RyaW5nCiAgICBiYXI6IFN0cmluZyEKfQoKdHlwZSBNeVR5cGVSZXF1aXJlZCA9IFJlcXVpcmVkPF9NeVR5cGU%2bCgp0eXBlIE15VHlwZU9wdGlvbmFsID0gT3B0aW9uYWw8X015VHlwZT4K)

Source GraphQXL

Compiled GraphQL

```graphql
type _MyType {
foo: String
bar: String!
}

type MyTypeRequired = Required<_MyType>

type MyTypeOptional = Optional<_MyType>

#GraphQXL
```

```graphql
type MyTypeRequired {
foo: String!
bar: String!
}

type MyTypeOptional {
foo: String
bar: String
}
#GraphQL
```

### Import statements

Import other `.graphqxl` files and use their definitions in the current file.

Source GraphQXL

Compiled GraphQL

```graphql
# my_file.graphqxl
import "other_file"

type MyType {
foo: OtherType!
}
#GraphQXL
```
```graphql
# other_file.graphqxl
type OtherType {
bar: Int!
}
#GraphQXL
```

```graphql
# my_file.graphql
type OtherType {
bar: Int!
}

type MyType {
foo: OtherType!
}

#GraphQL
```

## Install

For brew users:

```shell
brew install graphqxl
```

There is built-in support for the following programming languages:
- [Node](https://github.com/gabotechs/node-graphqxl)

There are also precompiled binaries for each architecture that you can download directly from
GitHub releases:

Mac M1

```shell
wget https://github.com/gabotechs/graphqxl/releases/latest/download/graphqxl-aarch64-apple-darwin.tar.gz
tar -xvf graphqxl-aarch64-apple-darwin.tar.gz
```

Mac Intel

```shell
wget https://github.com/gabotechs/graphqxl/releases/latest/download/graphqxl-x86_64-apple-darwin.tar.gz
tar -xvf graphqxl-x86_64-apple-darwin.tar.gz
```

Linux x86_64

```shell
wget https://github.com/gabotechs/graphqxl/releases/latest/download/graphqxl-x86_64-unknown-linux-gnu.tar.gz
tar -xvf graphqxl-x86_64-unknown-linux-gnu.tar.gz
```

Linux aarch64

```shell
wget https://github.com/gabotechs/graphqxl/releases/latest/download/graphqxl-aarch64-unknown-linux-gnu.tar.gz
tar -xvf graphqxl-aarch64-unknown-linux-gnu.tar.gz
```

## Usage

```shell
./graphqxl foo.graphqxl
```

this will output `foo.graphql` as a result