This .NET source generator produces a sync method from an async one.
Decorate your async method with CreateSyncVersionAttribute
in your partial
class, struct or record
[Zomp.SyncMethodGenerator.CreateSyncVersion]
static async Task WriteAsync(ReadOnlyMemory<byte> buffer, Stream stream,
CancellationToken ct)
=> await stream.WriteAsync(buffer, ct).ConfigureAwait(true);
And it will generate a sync version of the method:
static void Write(ReadOnlySpan<byte> buffer, Stream stream)
=> stream.Write(buffer);
A list of changes applied to the new synchronized method:
foreach
statementChange types
ConfigureAwait
from Tasks and Asynchronous EnumerationsAsync
suffix to call synchronous version (e.g. MoveNextAsync() becomes MoveNext())Async
suffixawait
Task\value
) to value
await
Task.Delay(value
) to Thread.Sleep(value
)CreateSyncVersionAttribute
This source generator detects language version during the compilation. By default it will generate #nullable enable
directive if and only if the language version is 8 or above. Since it is impossible to reliably determine whether nullable context is turned on or not, OmitNullableDirective
property is available to omit that directive from generating.
[Zomp.SyncMethodGenerator.CreateSyncVersion(OmitNullableDirective = true)]
public async Task MethodAsync()
{
string f = null;
}
In case there is logic which should only be executed in the synchronized version of the method, wrap it in SYNC_ONLY
#if directive.
SYNC_ONLY
must not be defined anywhere. The source generator will scan #if directives for this symbol.
Code inside SYNC_ONLY
block will be copied as is. Unless global namespaces are used in the project, this code should contain fully qualified namespaces.
The following syntax:
[Zomp.SyncMethodGenerator.CreateSyncVersion]
public async Task WithSyncOnlyDirectiveAsync(CancellationToken ct)
{
#if SYNC_ONLY
System.Console.Write("Sync");
#endif
await Task.CompletedTask;
}
will output:
public void WithSyncOnlyDirective()
{
System.Console.Write("Sync");
}
If you only want to execute in the original async version, flip the flag like this: #if !SYNC_ONLY
.
Note: SYNC_ONLY
cannot be mixed with other symbols in a conditional expression and cannot have #elif
directive.
To add the library use:
dotnet add package Zomp.SyncMethodGenerator
This project is fully compatible with act.
Other than required packages to run act
itself, GitHub Actions script installs anything else that might be missing, such as node, yarn and dotnet. On Windows platform, software installation is performed on the host itself due to lack of container support.
To build the project using act follow these instructions:
Install chocolatey if missing.
Install the following packages if missing:
choco install git -y
choco install act-cli -y
refreshenv
In the project directory run:
act -P windows-latest=-self-hosted --artifact-server-path /tmp/artifacts
Install act by following these instructions.
In the project directory run:
act --artifact-server-path /tmp/artifacts