[release] [minor] feat: add Async suffix to generated methods by default (#354)

Author: SockworkOrange

.github/workflows/legacy-tests.yml

@@ -20,6 +20,11 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+
+      - name: Set up .NET from global.json
+        uses: actions/setup-dotnet@v4
+        with:
+          global-json-file: global.json
 
       - name: Load .env file
         uses: xom9ikk/[email protected]

Drivers/Generators/CopyFromDeclareGen.cs

@@ -9,7 +9,7 @@ public class CopyFromDeclareGen(DbDriver dbDriver)
     public MemberDeclarationSyntax Generate(string queryTextConstant, string argInterface, Query query)
     {
         return ParseMemberDeclaration($$"""
-            public async Task {{query.Name}}(List<{{argInterface}}> args)
+            public async Task {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}(List<{{argInterface}}> args)
             {
                 {{((ICopyFrom)dbDriver).GetCopyFromImpl(query, queryTextConstant)}}
             }

Drivers/Generators/ExecDeclareGen.cs

@@ -13,7 +13,7 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
     {
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         return ParseMemberDeclaration($$"""
-            public async Task {{query.Name}}({{parametersStr}})
+            public async Task {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}({{parametersStr}})
             {
                 {{GetMethodBody(queryTextConstant, query)}}
             }

Drivers/Generators/ExecLastIdDeclareGen.cs

@@ -13,7 +13,7 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
     {
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         return ParseMemberDeclaration($$"""
-            public async Task<{{dbDriver.GetIdColumnType(query)}}> {{query.Name}}({{parametersStr}})
+            public async Task<{{dbDriver.GetIdColumnType(query)}}> {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}({{parametersStr}})
             {
                 {{GetMethodBody(queryTextConstant, query)}}
             }

Drivers/Generators/ExecRowsDeclareGen.cs

@@ -13,7 +13,7 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
     {
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         return ParseMemberDeclaration($$"""
-            public async Task<long> {{query.Name}}({{parametersStr}})
+            public async Task<long> {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}({{parametersStr}})
             {
                 {{GetMethodBody(queryTextConstant, query)}}
             }

Drivers/Generators/ManyDeclareGen.cs

@@ -15,7 +15,7 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         var returnType = $"Task<List<{returnInterface}>>";
         return ParseMemberDeclaration($$"""
-            public async {{returnType}} {{query.Name}}({{parametersStr}})
+            public async {{returnType}} {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}({{parametersStr}})
             {
                 {{GetMethodBody(queryTextConstant, returnInterface, query)}}
             }

Drivers/Generators/OneDeclareGen.cs

@@ -15,7 +15,7 @@ public MemberDeclarationSyntax Generate(string queryTextConstant, string argInte
         var returnType = $"Task<{dbDriver.AddNullableSuffixIfNeeded(returnInterface, false)}>";
         var parametersStr = CommonGen.GetMethodParameterList(argInterface, query.Params);
         return ParseMemberDeclaration($$"""
-            public async {{returnType}} {{query.Name}}({{parametersStr}})
+            public async {{returnType}} {{query.Name.ToMethodName(dbDriver.Options.WithAsyncSuffix)}}({{parametersStr}})
             {
                 {{GetMethodBody(queryTextConstant, returnInterface, query)}}
             }

Extensions/StringExtensions.cs

@@ -51,6 +51,12 @@ public static string ToModelName(this string value, string schema, string defaul
         return $"{schemaName}_{value.TrimEnd('s')}".ToPascalCase(); // TODO implement better way to turn words to singular
     }
 
+    public static string ToMethodName(this string value, bool withAsyncSuffix)
+    {
+        var methodName = value.ToPascalCase();
+        return withAsyncSuffix ? $"{methodName}Async" : methodName;
+    }
+
     public static string AppendSemicolonUnlessEmpty(this string input)
     {
         return input == string.Empty ? "" : $"{input};";

PluginOptions/Options.cs

@@ -25,6 +25,7 @@ public Options(GenerateRequest generateRequest)
         NamespaceName = rawOptions.NamespaceName;
         DotnetFramework = DotnetFrameworkExtensions.ParseName(rawOptions.TargetFramework);
         Overrides = rawOptions.Overrides ?? [];
+        WithAsyncSuffix = rawOptions.WithAsyncSuffix;
 
         if (rawOptions.DebugRequest && generateRequest.Settings.Codegen.Wasm is not null)
             throw new ArgumentException("Debug request mode cannot be used with WASM plugin");
@@ -57,6 +58,8 @@ public Options(GenerateRequest generateRequest)
     /// </summary>
     public bool UseCentralPackageManagement { get; }
 
+    public bool WithAsyncSuffix { get; }
+
     private static readonly Dictionary<string, DriverName> EngineToDriverMapping = new()
     {
         { "mysql", DriverName.MySqlConnector },

PluginOptions/RawOptions.cs

@@ -9,7 +9,7 @@ public record RawOptions
     public string OverrideDriverVersion { get; init; } = string.Empty;
 
     [JsonPropertyName("generateCsproj")]
-    public bool GenerateCsproj { get; init; } = true; // generating .csproj files by default
+    public bool GenerateCsproj { get; init; } = true;
 
     [JsonPropertyName("targetFramework")]
     public string TargetFramework { get; init; } = DotnetFramework.Dotnet80.ToName();
@@ -31,6 +31,9 @@ public record RawOptions
 
     [JsonPropertyName("useCentralPackageManagement")]
     public bool UseCentralPackageManagement { get; init; }
+
+    [JsonPropertyName("withAsyncSuffix")]
+    public bool WithAsyncSuffix { get; init; } = true;
 }
 
 public class OverrideOption