Merge from master

.github/workflows/codeql-analysis.yml

@@ -14,12 +14,14 @@ jobs:
 
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          show-progress: false
 
       - name: Setup .NET SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
-           dotnet-version: 7.0.x
+           dotnet-version: 8.0.x
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2

.github/workflows/label.yml

@@ -15,7 +15,7 @@ jobs:
   label:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/labeler@v4
+    - uses: actions/labeler@v5
       with:
         sync-labels: ""
         repo-token: "${{ secrets.GITHUB_TOKEN }}"

.github/workflows/publish-preview.yml

@@ -21,11 +21,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          show-progress: false
       - name: Setup .NET SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
           source-url: https://nuget.pkg.github.com/graphql-dotnet/index.json
         env:
           NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}

.github/workflows/publish-release.yml

@@ -13,7 +13,10 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout source
+        uses: actions/checkout@v4
+        with:
+          show-progress: false
       - name: Check github.ref starts with 'refs/tags/'
         if: ${{ !startsWith(github.ref, 'refs/tags/') }}
         run: |
@@ -28,9 +31,9 @@ jobs:
           echo version=$version
           echo "version=$version" >> $GITHUB_ENV
       - name: Setup .NET SDK
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: 7.0.x
+          dotnet-version: 8.0.x
           source-url: https://api.nuget.org/v3/index.json
         env:
           NUGET_AUTH_TOKEN: ${{secrets.NUGET_AUTH_TOKEN}}
@@ -53,7 +56,7 @@ jobs:
         working-directory: src
         run: dotnet nuget push "out/*" -k ${{secrets.NUGET_AUTH_TOKEN}}
       - name: Upload Nuget packages as release artifacts
-        uses: actions/github-script@v6
+        uses: actions/github-script@v7
         with:
           github-token: ${{secrets.GITHUB_TOKEN}}
           script: |

.github/workflows/test.yml

@@ -5,7 +5,7 @@ on:
     branches:
       - master
       - develop
-      - v8 
+      - v8
     paths:
       - src/**
       - .github/workflows/**
@@ -31,21 +31,19 @@ jobs:
     runs-on: ${{ matrix.os }}
     steps:
       - name: Checkout source
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          show-progress: false
       - name: Setup .NET SDKs
-        uses: actions/setup-dotnet@v3
+        uses: actions/setup-dotnet@v4
         with:
           dotnet-version: |
-            3.1.x
-            5.0.x
             6.0.x
             7.0.x
+            8.0.x
           source-url: https://nuget.pkg.github.com/graphql-dotnet/index.json
         env:
           NUGET_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}}
-      - name: Disable MSVS Nuget Source # see https://github.com/graphql-dotnet/graphql-dotnet/issues/2422
-        if: ${{ startsWith(matrix.os, 'windows') }}
-        run: dotnet nuget disable source 'Microsoft Visual Studio Offline Packages'
       - name: Install dependencies
         working-directory: src
         run: dotnet restore
@@ -72,7 +70,7 @@ jobs:
         if: ${{ startsWith(matrix.os, 'ubuntu') }}
         uses: codecov/codecov-action@v3
         with:
-          files: .coverage/GraphQLParser.Tests/coverage.net5.opencover.xml
+          files: .coverage/GraphQLParser.Tests/coverage.net8.opencover.xml
 
   buildcheck:
     needs:

README.md

@@ -3,15 +3,11 @@
 [![License](https://img.shields.io/github/license/graphql-dotnet/parser)](LICENSE.md)
 [![codecov](https://codecov.io/gh/graphql-dotnet/parser/branch/master/graph/badge.svg?token=GEjwg1by60)](https://codecov.io/gh/graphql-dotnet/parser)
 [![Nuget](https://img.shields.io/nuget/dt/GraphQL-Parser)](https://www.nuget.org/packages/GraphQL-Parser)
-[![NuGet](https://img.shields.io/nuget/v/GraphQL-Parser.svg)](https://www.nuget.org/packages/GraphQL-Parser)
+[![Nuget](https://img.shields.io/nuget/v/GraphQL-Parser)](https://www.nuget.org/packages/GraphQL-Parser)
 [![GitHub Release Date](https://img.shields.io/github/release-date/graphql-dotnet/parser?label=released)](https://github.com/graphql-dotnet/parser/releases)
 [![GitHub commits since latest release (by date)](https://img.shields.io/github/commits-since/graphql-dotnet/parser/latest?label=new+commits)](https://github.com/graphql-dotnet/parser/commits/master)
-![Size](https://img.shields.io/github/repo-size/graphql-dotnet/parser)
-
 [![GitHub contributors](https://img.shields.io/github/contributors/graphql-dotnet/parser)](https://github.com/graphql-dotnet/parser/graphs/contributors)
-![Activity](https://img.shields.io/github/commit-activity/w/graphql-dotnet/parser)
-![Activity](https://img.shields.io/github/commit-activity/m/graphql-dotnet/parser)
-![Activity](https://img.shields.io/github/commit-activity/y/graphql-dotnet/parser)
+![Size](https://img.shields.io/github/repo-size/graphql-dotnet/parser)
 
 This library contains a lexer and parser as well as the complete [GraphQL AST model](http://spec.graphql.org/October2021/#sec-Appendix-Grammar-Summary)
 that allows you to work with GraphQL documents compatible with the [October 2021 spec](https://spec.graphql.org/October2021/).
@@ -26,7 +22,7 @@ Preview versions of this package are available on [GitHub Packages](https://gith
 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
+Usage:
 
 ```csharp
 var token = Lexer.Lex("\"str\"");
@@ -40,7 +36,7 @@ Lex method always returns the first token it finds. In this case case the result
 Parses provided GraphQL expression into AST (abstract syntax tree). Parser also takes advantage of
 `ReadOnlyMemory<char>` but still allocates memory for AST.
 
-### Usage
+Usage:
 
 ```csharp
 var ast1 = Parser.Parse(@"
@@ -78,15 +74,83 @@ 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.
+the managed heap at all. Extension methods are also provided for printing
+directly to a string, which utilize the `StringBuilder` and `StringWriter`
+classes.
+
+```csharp
+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:
+
+```graphql
+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.
+
+```csharp
+var document = Parser.Parse("query { hero { name age } }");
+SDLSorter.Sort(document);
+var sdl = new SDLPrinter().Print(document);
+```
+
+Output:
+
+```graphql
+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 GraphQL document
+Consider the following GraphQL document:
 
 ```graphql
 query a { name age }
@@ -105,14 +169,14 @@ Document
         Name [age]
 ```
 
-### Usage
+Usage:
 
 ```csharp
-public static async Task Print(string text)
+public static async Task PrintStructure(string sdl)
 {
-    using var document = Parser.Parse(text);
-    var writer = new StringWriter(); 
-    var printer = new SDLPrinter()
+    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);

src/Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
 
   <PropertyGroup>
-    <VersionPrefix>9.2.0-preview</VersionPrefix>
+    <VersionPrefix>9.3.0-preview</VersionPrefix>
     <LangVersion>latest</LangVersion>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <NoWarn>$(NoWarn);CA1707</NoWarn>
@@ -31,7 +31,7 @@
   <ItemGroup Condition="'$(IsPackable)' == 'true'">
     <None Include="..\..\assets\logo.64x64.png" Pack="true" PackagePath="\" Visible="false" />
     <None Include="..\..\README.md" Pack="true" PackagePath="\" Visible="false" />
-    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
+    <PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>

src/GraphQLParser.ApiTests/ApiApprovalTests.cs

@@ -34,7 +34,7 @@ public void Public_Api_Should_Not_Change_Inadvertently(Type type)
         {
             IncludeAssemblyAttributes = false,
             //WhitelistedNamespacePrefixes = new[] { "Microsoft.Extensions.DependencyInjection" },
-            ExcludeAttributes = new[] { "System.Diagnostics.DebuggerDisplayAttribute", "System.Diagnostics.CodeAnalysis.AllowNullAttribute" }
+            ExcludeAttributes = ["System.Diagnostics.DebuggerDisplayAttribute", "System.Diagnostics.CodeAnalysis.AllowNullAttribute"]
         }))).ToArray();
 
         if (publicApi.DistinctBy(item => item.content).Count() == 1)

src/GraphQLParser.ApiTests/GraphQLParser.ApiTests.csproj

@@ -1,17 +1,17 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7</TargetFramework>
+    <TargetFramework>net8</TargetFramework>
     <NoWarn>$(NoWarn);1591</NoWarn>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
     <PackageReference Include="Shouldly" Version="4.2.1" />
-    <PackageReference Include="xunit" Version="2.5.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" />
-    <PackageReference Include="PublicApiGenerator" Version="11.0.0" />
+    <PackageReference Include="xunit" Version="2.6.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.5" />
+    <PackageReference Include="PublicApiGenerator" Version="11.1.0" />
   </ItemGroup>
 
   <ItemGroup>

src/GraphQLParser.ApiTests/GraphQLParser.approved.txt

@@ -907,6 +907,12 @@ namespace GraphQLParser.Visitors
             public System.IO.TextWriter Writer { get; }
         }
     }
+    public enum SDLPrinterArgumentsMode
+    {
+        None = 0,
+        PreferNewLine = 1,
+        ForceNewLine = 2,
+    }
     public static class SDLPrinterExtensions
     {
         public static string Print(this GraphQLParser.Visitors.SDLPrinter printer, GraphQLParser.AST.ASTNode node) { }
@@ -916,6 +922,7 @@ namespace GraphQLParser.Visitors
     public class SDLPrinterOptions
     {
         public SDLPrinterOptions() { }
+        public GraphQLParser.Visitors.SDLPrinterArgumentsMode ArgumentsPrintMode { get; set; }
         public bool EachDirectiveLocationOnNewLine { get; set; }
         public bool EachUnionMemberOnNewLine { get; set; }
         public int IndentSize { get; set; }

src/GraphQLParser.Benchmarks/GraphQLParser.Benchmarks.csproj

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
-    <TargetFramework>net7</TargetFramework>
+    <TargetFramework>net8</TargetFramework>
     <OutputType>Exe</OutputType>
     <IsPackable>false</IsPackable>
     <NoWarn>$(NoWarn);1591;CA1822</NoWarn>
@@ -15,7 +15,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\GraphQLParser\GraphQLParser.csproj" />
-    <PackageReference Include="BenchmarkDotNet" Version="0.13.6" />
+    <PackageReference Include="BenchmarkDotNet" Version="0.13.11" />
   </ItemGroup>
 
 </Project>

src/GraphQLParser.Tests/GraphQLParser.Tests.csproj

@@ -4,7 +4,7 @@
   <PropertyGroup>
     <SingleTestPlatform Condition="'$(SingleTestPlatform)' == ''">false</SingleTestPlatform>
     <Nullable>disable</Nullable>
-    <NoWarn>$(NoWarn);1591;CA2012;IDE0008;IDE0022;IDE0058;IDE1006</NoWarn>
+    <NoWarn>$(NoWarn);1591;CA2012;CA1861;IDE0008;IDE0022;IDE0058;IDE1006</NoWarn>
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
   </PropertyGroup>
 
@@ -13,7 +13,8 @@
   </PropertyGroup>
 
   <PropertyGroup Condition="'$(SingleTestPlatform)' != 'true'">
-    <TargetFrameworks>netcoreapp3.1;net5;net6;net7</TargetFrameworks>
+    <TargetFrameworks>net6;net7;net8</TargetFrameworks>
+    <TargetFrameworks Condition="'$(OS)' == 'Windows_NT'">$(TargetFrameworks);net462</TargetFrameworks>
   </PropertyGroup>
 
   <ItemGroup>
@@ -25,10 +26,10 @@
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
     </PackageReference>
-    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.7.1" />
+    <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0" />
     <PackageReference Include="Shouldly" Version="4.2.1" />
-    <PackageReference Include="xunit" Version="2.5.0" />
-    <PackageReference Include="xunit.runner.visualstudio" Version="2.4.5" />
+    <PackageReference Include="xunit" Version="2.6.3" />
+    <PackageReference Include="xunit.runner.visualstudio" Version="2.5.5" />
   </ItemGroup>
 
   <ItemGroup>