GraphQL-Parser 9.3.1

dotnet add package GraphQL-Parser --version 9.3.1
NuGet\Install-Package GraphQL-Parser -Version 9.3.1
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="GraphQL-Parser" Version="9.3.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add GraphQL-Parser --version 9.3.1
#r "nuget: GraphQL-Parser, 9.3.1"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install GraphQL-Parser as a Cake Addin
#addin nuget:?package=GraphQL-Parser&version=9.3.1

// Install GraphQL-Parser as a Cake Tool
#tool nuget:?package=GraphQL-Parser&version=9.3.1

GraphQL.NET Parser

License codecov Nuget Nuget GitHub Release Date GitHub commits since latest release (by date) GitHub contributors Size

This library contains a lexer and parser as well as the complete GraphQL AST model that allows you to work with GraphQL documents compatible with the October 2021 spec.

The parser from this library is used by the GraphQL.NET project and was verified by many test data sets.

Preview versions of this package are available on GitHub Packages.

1. Lexer

Generates token based on input text. Lexer takes advantage of ReadOnlyMemory<char> and in most cases does not allocate memory on the managed heap at all.

Usage:

var token = Lexer.Lex("\"str\"");

Lex method always returns the first token it finds. In this case case the result would look like following. lexer example

2. Parser

Parses provided GraphQL expression into AST (abstract syntax tree). Parser also takes advantage of ReadOnlyMemory<char> but still allocates memory for AST.

Usage:

var ast1 = Parser.Parse(@"
{
  field
}");

var ast2 = Parser.Parse(@"
{
  field
}", new ParserOptions { Ignore = IgnoreOptions.Comments });

By default ParserOptions.Ignore is IgnoreOptions.None. If you want to ignore all comments use IgnoreOptions.Comments. If you don't need information about tokens locations in the source document, then use flag IgnoreOptions.Locations. Or just use IgnoreOptions.All and this will maximize the saving of memory allocated in the managed heap for AST.

You can parse not only entire GraphQLDocument but also concrete AST nodes. Use generic overload.

string text1 = "enum Color { RED }"
var ast1 = Parser.Parse<GraphQLEnumTypeDefinition>(text1);

string text2 = "{ a: 1, b: \"abc\", c: RED, d: $id }";
var ast2 = Parser.Parse<GraphQLValue>(text2); // returns GraphQLObjectValue

3. ASTVisitor

ASTVisitor provides API to traverse AST of the parsed GraphQL document. Default implementation traverses all AST nodes of the provided one. You can inherit from it and override desired methods to implement your own AST processing algorithm.

SDLPrinter

For printing SDL from AST, you can use SDLPrinter. This is a highly optimized visitor for asynchronous non-blocking SDL output into provided TextWriter. In the majority of cases it does not allocate memory in the managed heap at all. Extension methods are also provided for printing directly to a string, which utilize the StringBuilder and StringWriter classes.

var document = Parser.Parse("query { hero { name age } }");

// print to a string with default options
var sdl = new SDLPrinter().Print(document);

// print to a string builder
var sb = new StringBuilder();
new SDLPrinter().Print(document, sb);

// print to a string with some options
var sdlPrinter = new SDLPrinter(
    new SDLPrinterOptions
    {
        PrintComments = true,
        EachDirectiveLocationOnNewLine = true,
        EachUnionMemberOnNewLine = true,
    });
var sdl = sdlPrinter.Print(document);

// print to a stream asynchronously
using var writer = new StreamWriter(stream);
await sdlPrinter.PrintAsync(document, writer, default);
await writer.FlushAsync();

Output:

query {
  hero {
    name
    age
  }
}

SDLSorter

An AST document can be sorted with the SDLSorter using a predefined sort order. You can specify the string comparison; by default it uses a culture-invariant case-insensitive comparison. Any futher customization is possible by deriving from SDLSorterOptions and overriding the Compare methods.

var document = Parser.Parse("query { hero { name age } }");
SDLSorter.Sort(document);
var sdl = new SDLPrinter().Print(document);

Output:

query {
  hero {
    age
    name
  }
}

StructurePrinter

You can also find a StructurePrinter visitor that prints AST into the provided TextWriter as a hierarchy of node types. It can be useful when debugging for better understanding the AST structure. Consider the following GraphQL document:

query a { name age }

After StructurePrinter processing the output text will be

Document
  OperationDefinition
    Name [a]
    SelectionSet
      Field
        Name [name]
      Field
        Name [age]

Usage:

public static async Task PrintStructure(string sdl)
{
    var document = Parser.Parse(sdl);
    using var writer = new StringWriter(); 
    var printer = new StructurePrinter()
    await printer.PrintAsync(document, writer);
    var rendered = writer.ToString();
    Console.WriteLine(rendered);
}

Contributors

This project exists thanks to all the people who contribute. <a href="https://github.com/graphql-dotnet/parser/graphs/contributors"><img src="https://contributors-img.web.app/image?repo=graphql-dotnet/parser" /></a>

PRs are welcome! Looking for something to work on? The list of open issues is a great place to start. You can help the project by simply responding to some of the asked questions.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (19)

Showing the top 5 NuGet packages that depend on GraphQL-Parser:

Package Downloads
GraphQL

GraphQL for .NET

HQ

This package contains the full-stack build for HQ.io.

CoreSharp.GraphQL

GraphQL CQRS integration and extension

SER.Graphql.Reflection.NetCore

This is a complement to graphql-dotnet (https://github.com/graphql-dotnet/graphql-dotnet) to avoid boilerplate

Friflo.Json.Fliox.Hub.GraphQL The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

GraphQL API for a JSON Fliox Hub

GitHub repositories (5)

Showing the top 5 popular GitHub repositories that depend on GraphQL-Parser:

Repository Stars
graphql-dotnet/graphql-dotnet
GraphQL for .NET
graphql-dotnet/examples
Examples for GraphQL.NET
byme8/ZeroQL
C# GraphQL client with Linq-like syntax
nightroman/FarNet
Far Manager framework for .NET modules and scripts in PowerShell, F#, JavaScript.
friflo/Friflo.Json.Fliox
C# ORM for .NET with Messaging and Pub-Sub. C# ECS for high performance DoD.
Version Downloads Last updated
9.3.1 18,165 12/11/2023
9.3.0 27,973 10/16/2023
9.2.1 2,362 10/12/2023
9.2.0 114,430 7/26/2023
9.1.0 32,709 4/21/2023
9.0.2 897 4/21/2023
9.0.1 712 4/20/2023
9.0.0 620 4/20/2023
8.4.2 194,896 12/11/2023
8.4.1 2,322 10/12/2023
8.4.0 337,697 7/26/2023
8.3.0 2,681,123 4/21/2023
8.2.0 2,190 4/15/2023
8.1.0 1,454,293 8/15/2022
8.0.0 2,787,666 3/30/2022
7.2.0 4,041,762 7/7/2021
7.1.0 1,147,095 4/7/2021
7.0.0 1,047,653 3/9/2021
6.0.0 41,317 1/4/2021
5.3.3 3,133,457 10/10/2020
5.3.2 1,473 10/8/2020
5.3.1 1,542 10/8/2020
5.3.0 953,688 8/18/2020
5.2.0 5,049 8/8/2020
5.1.2 163,607 5/5/2020
5.1.0 252,867 2/19/2020
4.1.2 281,899 10/25/2019
4.1.1 313,043 7/3/2019
4.1.0 48,307 6/7/2019
4.0.0 99,018 5/6/2019
3.1.0-preview-39 1,033 3/21/2019
3.0.0 8,133,892 9/8/2017
2.0.0 347,310 10/14/2016
1.0.0 18,122 8/7/2016