Merge pull request #39 from canhorn/feature/update_readmes

Updated Readme Files

Author: canhorn

README.md

@@ -28,6 +28,15 @@ The interop project can be found in the [canhorn/EventHorizon.Blazor.Interop](ht
 * [TypeScript](https://www.typescriptlang.org/)
 * [NodeJS](https://nodejs.org/)
 
+## TypeScript Parser
+
+The generation relies heavily on the TypeScript Abstract Syntax Tree and so the code includes ways to parse the source files into a AST representation for easier generation. 
+
+The code has two supported parser types, .NET and NodeJS, to do realtime parsing of code. Using a .NET library it's able to do very quick parsing, but since it has not been maintained it can not handle complex or modern TypeScript syntax.
+But with the NodeJS TypeScript parser it can handle modern more complex TypeScript syntax, but with the trade off of in speed. 
+
+> Having NodeJS installed is required to use the NodeJS TypeScript parser. (This is required when using the parser with the Tool)
+
 ## Supported API's Generated
 
 Below is a list of API that will be generated.

Tests/EventHorizon.Blazor.TypeScript.Interop.Generator.Tests/Identifiers/InterfaceResponseTypeIdentifierTests.cs

@@ -2,11 +2,15 @@ namespace EventHorizon.Blazor.TypeScript.Interop.Generator.Tests.Identifiers
 {
     using System.Collections.Generic;
     using System.IO;
+    using System.Threading.Tasks;
+    using EventHorizon.Blazor.TypeScript.Interop.Generator.AstParser.Api;
+    using EventHorizon.Blazor.TypeScript.Interop.Generator.AstParser.Model.Types;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.AstParser.NodeImpl;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.AstParser.SdcdImpl;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.Identifiers;
     using EventHorizon.Blazor.TypeScript.Interop.Generator.Model.Statements;
     using FluentAssertions;
+    using Moq;
     using Xunit;
 
     public class InterfaceResponseTypeIdentifierTests
@@ -365,5 +369,66 @@ bool expected
             actual.Should()
                 .Be(expected);
         }
+
+        [Theory]
+        [Trait("Category", "EdgeCase")]
+        [InlineData(SyntaxKind.ClassDeclaration, false)]
+        [InlineData(SyntaxKind.InterfaceDeclaration, true)]
+        public void ShouldValidateAgainstCacheWhenDeclarationTypeIsUsed(
+            string declarationType,
+            bool found
+        )
+        {
+            // Given
+            var expected = 1;
+            var identifierString = "identifier-string";
+            var mockNode = new NodeMock
+            {
+                IdentifierStr = identifierString,
+            };
+
+            var astMock = new Mock<AbstractSyntaxTree>();
+            var rootNodeMock = new Mock<Node>();
+
+            astMock.Setup(
+                mock => mock.RootNode
+            ).Returns(
+                rootNodeMock.Object
+            );
+
+            rootNodeMock.Setup(
+                mock => mock.OfKind(
+                    declarationType
+                )
+            ).Returns(
+                new List<Node>
+                {
+                    mockNode
+                }
+            );
+
+            // When
+            var alias = new InterfaceResponseTypeIdentifierCached();
+            var actual = alias.Identify(
+                identifierString,
+                astMock.Object
+            );
+            actual.Should().Be(found);
+
+            actual = alias.Identify(
+                identifierString,
+                astMock.Object
+            );
+
+            // Then
+            actual.Should().Be(found);
+
+            rootNodeMock.Verify(
+                mock => mock.OfKind(
+                    declarationType
+                ),
+                Times.Exactly(expected)
+            );
+        }
     }
 }

Tool/EventHorizon.Blazor.TypeScript.Interop.Tool/README.md

@@ -19,6 +19,18 @@ Identifier | Details | Required/Default
 -a, --project-assembly <project-assembly> | The project name of the Assembly that will be generated | Default: "Generated.WASM"
 -l, --project-generation-location <project-generation-location> | 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")
+
+## Parsers 
+
+The tool supports two types of parsers, one using the embedded .NET parser and one using NodeJS the TypeScript Complier. 
+
+These both have trade offs:
+
+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.
 
 ## Usage