Updated Tool CLI Options

canhorn · canhorn · commit 6a797452c468 · 2021-04-10T14:26:43.000-05:00
Can now generate for Blazor Server or Wasm hosting models.
diff --git a/Sample/EventHorizon.BabylonJS.Interop.Generator.ConsoleApp/Program.cs b/Sample/EventHorizon.BabylonJS.Interop.Generator.ConsoleApp/Program.cs
@@ -7,7 +7,7 @@ namespace EventHorizon.Blazor.TypeScript.Interop.Generator.ConsoleApp
     using EventHorizon.Blazor.TypeScript.Interop.Generator.Logging;
 
     using ServerGenerator = Blazor.Interop.Generator.GenerateInteropSource;
-    using ServerProjectWriter = Blazor.Interop.Generator.Writers.Project.ProjectWriter;
+    using ServerProjectWriter = Blazor.Interop.Generator.Writers.Project.ServerProjectWriter;
     using WasmGenerator = GenerateSource;
     using WasmProjectWriter = Writers.Project.ProjectWriter;
 
diff --git a/Source/Server/EventHorizon.Blazor.Interop.Generator.Writers.Project/ServerProjectWriter.cs b/Source/Server/EventHorizon.Blazor.Interop.Generator.Writers.Project/ServerProjectWriter.cs
@@ -1,7 +1,6 @@
 namespace EventHorizon.Blazor.Interop.Generator.Writers.Project
 {
     using System;
-    using System.Collections;
     using System.Collections.Generic;
     using System.IO;
     using System.Linq;
@@ -11,13 +10,13 @@ namespace EventHorizon.Blazor.Interop.Generator.Writers.Project
     using EventHorizon.Blazor.TypeScript.Interop.Generator.Writers;
     using Microsoft.CodeAnalysis;
 
-    public class ProjectWriter : IWriter
+    public class ServerProjectWriter : IWriter
     {
         private readonly string _projectPath;
         private readonly string _projectName;
         private readonly string _projectDirectory;
 
-        public ProjectWriter(
+        public ServerProjectWriter(
             string path,
             string name
         )
@@ -156,7 +155,7 @@ public static string ReadAllText(
             string templatePath
         )
         {
-            var assembly = typeof(ProjectWriter).Assembly;
+            var assembly = typeof(ServerProjectWriter).Assembly;
             var resourceStream = assembly.GetManifestResourceStream(
                 templatePath
             );
diff --git a/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/EventHorizon.Blazor.TypeScript.Interop.Tool.csproj b/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/EventHorizon.Blazor.TypeScript.Interop.Tool.csproj
@@ -26,6 +26,8 @@
     <ItemGroup>
         <ProjectReference Include="..\..\Source\EventHorizon.Blazor.TypeScript.Interop.Generator.Writers.Project\EventHorizon.Blazor.TypeScript.Interop.Generator.Writers.Project.csproj" />
         <ProjectReference Include="..\..\Source\EventHorizon.Blazor.TypeScript.Interop.Generator\EventHorizon.Blazor.TypeScript.Interop.Generator.csproj" />
+        <ProjectReference Include="..\..\Source\Server\EventHorizon.Blazor.Interop.Generator.Writers.Project\EventHorizon.Blazor.Interop.Generator.Writers.Project.csproj" />
+        <ProjectReference Include="..\..\Source\Server\EventHorizon.Blazor.Interop.Generator\EventHorizon.Blazor.Interop.Generator.csproj" />
     </ItemGroup>
 
 </Project>
diff --git a/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/Program.cs b/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/Program.cs
@@ -7,6 +7,8 @@ namespace EventHorizon.Blazor.TypeScript.Interop.Tool
     using System.Diagnostics;
     using System.IO;
     using System.Net;
+    using EventHorizon.Blazor.Interop.Generator;
+    using EventHorizon.Blazor.Interop.Generator.Writers.Project;
     using EventHorizon.Blazor.TypeScript.Interop.Generator;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.AstParser.Model;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.Formatter;
@@ -39,7 +41,7 @@ static int Main(string[] args)
                 },
                 new Option<string>(
                     new string[] { "--project-assembly", "-a" },
-                    getDefaultValue: () => "Generated.WASM",
+                    getDefaultValue: () => "Generated.Code",
                     description: "The project name of the Assembly that will be generated"
                 ),
                 new Option<string>(
@@ -57,12 +59,17 @@ static int Main(string[] args)
                     getDefaultValue: () => "dotnet",
                     description: "The type of TypeScript parser to use, 'dotnet' will use the embedded .NET parser. 'nodejs' will use the TypeScript compiler through NodeJS (requires NodeJS installed)."
                 ),
+                new Option<string>(
+                    new string[] { "--host-type", "-h" },
+                    getDefaultValue: () => "wasm",
+                    description: "The host type the source should be generator for. Is 'wasm' by default, will only work for Wasm hosted Blazor projects. Supports 'server' to generate a async first interop layer that works in both Blazor Server and Wasm hosted models."
+                ),
             };
 
-            rootCommand.Description = "Generate a Blazor Wasm project from a TypeScript definition file.";
+            rootCommand.Description = "Generate a Blazor Wasm or Server project from TypeScript definition files.";
 
             // Note that the parameters of the handler method are matched according to the names of the options
-            rootCommand.Handler = CommandHandler.Create<IList<string>, IList<string>, string, string, bool, string>(
+            rootCommand.Handler = CommandHandler.Create<IList<string>, IList<string>, string, string, bool, string, string>(
                 GenerateSources
             );
 
@@ -73,10 +80,11 @@ static int Main(string[] args)
         private static int GenerateSources(
             IList<string> source,
             IList<string> classToGenerate,
-            string projectAssembly = "Generated.Wasm",
+            string projectAssembly = "Generated.Code",
             string projectGenerationLocation = "_generated",
             bool force = false,
-            string parser = "dotnet"
+            string parser = "dotnet",
+            string hostType = "wasm"
         )
         {
             try
@@ -87,7 +95,8 @@ private static int GenerateSources(
                     classToGenerate,
                     projectAssembly,
                     projectGenerationLocation,
-                    parser
+                    parser,
+                    hostType
                 );
                 GlobalLogger.Info($"projectAssembly: {projectAssembly}");
                 GlobalLogger.Info($"projectGenerationLocation: {projectGenerationLocation}");
@@ -149,23 +158,46 @@ private static int GenerateSources(
                 }
 
                 var textFormatter = new NoFormattingTextFormatter();
-                var writer = new ProjectWriter(
-                    projectGenerationLocation,
-                    projectAssembly
-                );
 
-                new GenerateSource().Run(
-                    projectAssembly,
-                    sourceDirectory,
-                    sourceFiles,
-                    generationList,
-                    writer,
-                    textFormatter,
-                    new Dictionary<string, string>
-                    {
-                    },
-                    GetParserType(parser)
-                );
+                if (hostType == "server")
+                {
+                    var writer = new ServerProjectWriter(
+                        projectGenerationLocation,
+                        projectAssembly
+                    );
+                    new GenerateInteropSource().Run(
+                        projectAssembly,
+                        sourceDirectory,
+                        sourceFiles,
+                        generationList,
+                        writer,
+                        textFormatter,
+                        new Dictionary<string, string>
+                        {
+                        },
+                        GetParserType(parser)
+                    );
+                }
+                else if (hostType == "wasm")
+                {
+                    var writer = new ProjectWriter(
+                        projectGenerationLocation,
+                        projectAssembly
+                    );
+                    new GenerateSource().Run(
+                        projectAssembly,
+                        sourceDirectory,
+                        sourceFiles,
+                        generationList,
+                        writer,
+                        textFormatter,
+                        new Dictionary<string, string>
+                        {
+                        },
+                        GetParserType(parser)
+                    );
+                }
+
                 stopwatch.Stop();
                 GlobalLogger.Success($"Took {stopwatch.ElapsedMilliseconds}ms to Generate Source Project.");
 
@@ -192,7 +224,8 @@ private static void ValidateArguments(
             IList<string> classToGenerate,
             string projectAssembly,
             string projectGenerationLocation,
-            string parser
+            string parser,
+            string hostType
         )
         {
             if (sources == null || sources.Count == 0)
@@ -236,6 +269,15 @@ string parser
                     "Invalid parser found. Valid Parsers: [dotnet, nodejs]"
                 );
             }
+            if (string.IsNullOrWhiteSpace(
+                hostType
+            ) || (hostType.ToLower() != "server" && hostType.ToLower() != "wasm"))
+            {
+                throw new ToolArgumentException(
+                    "--host-type",
+                    "Invalid host type found. Valid Host Types: [wasm, server]"
+                );
+            }
         }
 
         /// <summary>
diff --git a/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/README.md b/Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/README.md
@@ -20,6 +20,7 @@ Identifier | Details | Required/Default
 -l, --project-generation-location &lt;project-generation-location&gt; | The directory where the Generated Project assembly will be saved | Default: "_generated"
 -f, --force | This will force generation, by deleting --project-generation-location | Default: (False)
 -p, --parser | The type of TypeScript parser to use, Supported values: ("dotnet","nodejs")  | Default: ("dotnet")
+-h, --host-type | The host type the source should be generator for, Supported values: ("wasm","server"). | Default: ("wasm") 
 
 ## Parsers 
 
@@ -32,6 +33,17 @@ Type | Details
 dotnet | Has no external dependencies, and on average 3x faster than the nodejs parser. A con is that it does not support modern TypeScript syntax, but should coverage 90% of use-cases.
 nodejs | Requires NodeJS to function, supports modern TypeScript syntax. A con is that it is very slow relative to the dotnet parser.
 
+## Host Types
+
+This tool supports two types of Hosting models, the standard Blazor Server and Wasm hosting models. The main reason for this is the Wasm generated source will create an interop layer that has a speed benefit but does not work outside of the Wasm hosting model.
+
+Below is a table listing the pro/con of each hosting type.
+
+Type | Details
+--- | ---
+wasm | Uses the unmarshaller to move data between the .NET and JavaScript layers. The con is that it only works in a Blazor WebAssembly hosted model, and will not function when used from Blazor Server.
+server | Uses the IJSRuntime for moving data between the .NET and JavaScript layers. A pro is that it allows it to work in both Blazor Server and WebAssembly, but with a con that it has to go through the async layer adding a performance overhead to each request.
+
 ## Usage
 
 ~~~ bash
@@ -54,4 +66,10 @@ ehz-generate -c Vector3 -c Mesh -c Engine -c Scene -s https://raw.githubusercont
 ~~~ bash
 # Generated BabylonJS project interop with multiple sources.
 ehz-generate -c Button -s https://raw.githubusercontent.com/BabylonJS/Babylon.js/master/dist/babylon.d.ts -s https://raw.githubusercontent.com/BabylonJS/Babylon.js/master/dist/gui/babylon.gui.d.ts
-~~~
+~~~
+
+~~~ bash
+# Generate a BabylonJS project that work in both Blazor Server and Wasm projects
+ehz-generate --host-type server -a Blazor.BabylonJS -c Vector3 -s https://raw.githubusercontent.com/BabylonJS/Babylon.js/master/dist/babylon.d.ts
+
+~~~

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,6 @@`
`1`	`1`	`namespace EventHorizon.Blazor.Interop.Generator.Writers.Project`
`2`	`2`	`{`
`3`	`3`	`using System;`
`4`		`- using System.Collections;`
`5`	`4`	`using System.Collections.Generic;`
`6`	`5`	`using System.IO;`
`7`	`6`	`using System.Linq;`
`@@ -11,13 +10,13 @@ namespace EventHorizon.Blazor.Interop.Generator.Writers.Project`
`11`	`10`	`using EventHorizon.Blazor.TypeScript.Interop.Generator.Writers;`
`12`	`11`	`using Microsoft.CodeAnalysis;`
`13`	`12`
`14`		`- public class ProjectWriter : IWriter`
	`13`	`+ public class ServerProjectWriter : IWriter`
`15`	`14`	`{`
`16`	`15`	`private readonly string _projectPath;`
`17`	`16`	`private readonly string _projectName;`
`18`	`17`	`private readonly string _projectDirectory;`
`19`	`18`
`20`		`- public ProjectWriter(`
	`19`	`+ public ServerProjectWriter(`
`21`	`20`	`string path,`
`22`	`21`	`string name`
`23`	`22`	`)`
`@@ -156,7 +155,7 @@ public static string ReadAllText(`
`156`	`155`	`string templatePath`
`157`	`156`	`)`
`158`	`157`	`{`
`159`		`- var assembly = typeof(ProjectWriter).Assembly;`
	`158`	`+ var assembly = typeof(ServerProjectWriter).Assembly;`
`160`	`159`	`var resourceStream = assembly.GetManifestResourceStream(`
`161`	`160`	`templatePath`
`162`	`161`	`);`