consolidate source generation (#140)

Author: elringus

.github/workflows/deploy.yml

@@ -16,6 +16,8 @@ jobs:
       name: github-pages
     steps:
       - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
       - uses: actions/setup-node@v3
       - name: build
         run: |

samples/minimal/index.html

@@ -5,18 +5,18 @@ <h1 id="msg">Loading...</h1>
 <script type="module">
 
 // Named exports are auto-generated on C# build.
-import bootsharp, { Global } from './cs/bin/bootsharp/bootsharp.mjs';
+import bootsharp, { Program } from './cs/bin/bootsharp/index.mjs';
 
 // Binding 'Program.GetFrontendName' endpoint invoked in C#.
-Global.getFrontendName = () => "Browser";
+Program.getFrontendName = () => "Browser";
 
 // Subscribing to 'Program.OnMainInvoked' C# event.
-Global.onMainInvoked.subscribe(console.log);
+Program.onMainInvoked.subscribe(console.log);
 
 // Initializing dotnet runtime and invoking entry point.
 await bootsharp.boot();
 
 // Invoking 'Program.GetBackendName' C# method.
-document.getElementById("msg").innerHTML = `Hello ${Global.getBackendName()}!`;
+document.getElementById("msg").innerHTML = `Hello ${Program.getBackendName()}!`;
 
 </script>

samples/minimal/main.mjs

@@ -1,18 +1,18 @@
 // Named exports are auto-generated on C# build.
-import bootsharp, { Global } from "./cs/bin/bootsharp/bootsharp.mjs";
+import bootsharp, { Program } from "./cs/bin/bootsharp/index.mjs";
 
 // Binding 'Program.GetFrontendName' endpoint invoked in C#.
-Global.getFrontendName = () =>
+Program.getFrontendName = () =>
     typeof Bun === "object" ? `Bun ${Bun.version}` :
     typeof Deno === "object" ? `Deno ${Deno.version.deno}` :
     typeof process === "object" ? `Node ${process.version}` :
     "Unknown JavaScript Runtime";
 
 // Subscribing to 'Program.OnMainInvoked' C# event.
-Global.onMainInvoked.subscribe(console.log);
+Program.onMainInvoked.subscribe(console.log);
 
 // Initializing dotnet runtime and invoking entry point.
 await bootsharp.boot();
 
 // Invoking 'Program.GetBackendName' C# method.
-console.log(`Hello ${Global.getBackendName()}!`);
+console.log(`Hello ${Program.getBackendName()}!`);

samples/react/backend/Backend.WASM/Backend.WASM.csproj

@@ -3,9 +3,10 @@
     <PropertyGroup>
         <TargetFramework>net8.0</TargetFramework>
         <RuntimeIdentifier>browser-wasm</RuntimeIdentifier>
+        <ImplicitUsings>enable</ImplicitUsings>
         <!-- Specify custom name for the generated JavaScript module. -->
         <BootsharpName>backend</BootsharpName>
-        <!-- Publish module's package.json file under solution folder for accessibility. -->
+        <!-- Publish module's package.json file under solution folder. -->
         <BootsharpPackageDirectory>$(SolutionDir)</BootsharpPackageDirectory>
         <!-- Don't embed the C# solution binaries to the JavaScript module. -->
         <BootsharpEmbedBinaries>false</BootsharpEmbedBinaries>

samples/react/backend/Backend.WASM/Program.cs

@@ -1,5 +1,3 @@
-using Backend;
-using Backend.Prime;
 using Bootsharp;
 using Bootsharp.Inject;
 using Microsoft.Extensions.DependencyInjection;
@@ -10,15 +8,15 @@
 // and can be shared with other build targets (console, MAUI, etc).
 
 // Generate C# -> JavaScript interop handlers for specified contracts.
-[assembly: JSExport(typeof(IComputer))]
+[assembly: JSExport(typeof(Backend.IComputer))]
 // Generate JavaScript -> C# interop handlers for specified contracts.
-[assembly: JSImport(typeof(IPrimeUI))]
-// Group all generated JavaScript artifacts under 'Computer' namespace.
-[assembly: JSNamespace("^.*$", "Computer")]
+[assembly: JSImport(typeof(Backend.Prime.IPrimeUI))]
+// Group all generated JavaScript APIs under "Computer" namespace.
+[assembly: JSPreferences(Space = [".+", "Computer"])]
 
 // Perform dependency injection.
 new ServiceCollection()
-    .AddSingleton<IComputer, Prime>() // use prime computer
+    .AddSingleton<Backend.IComputer, Backend.Prime.Prime>() // use prime computer
     .AddBootsharp() // inject generated interop handlers
     .BuildServiceProvider()
     .RunBootsharp(); // initialize interop services

samples/react/backend/package.json

@@ -1,5 +1,6 @@
 {
     "name": "backend",
-    "main": "Backend.WASM/bin/backend/backend.mjs",
-    "types": "Backend.WASM/bin/backend/types/backend.d.ts"
+    "type": "module",
+    "main": "Backend.WASM/bin/backend/index.mjs",
+    "types": "Backend.WASM/bin/backend/types/index.d.ts"
 }

samples/react/package.json

@@ -7,19 +7,19 @@
     },
     "devDependencies": {
         "typescript": "^5.3.3",
-        "@types/react": "^18.2.46",
+        "@types/react": "^18.2.48",
         "@types/react-dom": "^18.2.18",
-        "vite": "^5.0.10",
+        "vite": "^5.0.12",
         "@vitejs/plugin-react-swc": "^3.5.0",
-        "vitest": "^1.1.1",
-        "@vitest/coverage-v8": "^1.1.1",
-        "happy-dom": "^12.10.3",
+        "vitest": "^1.2.1",
+        "@vitest/coverage-v8": "^1.2.1",
+        "happy-dom": "^13.2.0",
         "@testing-library/react": "^14.1.2",
         "@testing-library/user-event": "^14.5.2",
         "eslint": "^8.56.0",
         "eslint-plugin-react": "^7.33.2",
         "eslint-plugin-react-hooks": "^4.6.0",
-        "@typescript-eslint/eslint-plugin": "^6.16.0",
+        "@typescript-eslint/eslint-plugin": "^6.19.0",
         "npm-check-updates": "^16.14.12"
     },
     "scripts": {

samples/trimming/main.mjs

@@ -1,4 +1,4 @@
-import bootsharp, { Global } from "./cs/bin/bootsharp/bootsharp.mjs";
+import bootsharp, { Program } from "./cs/bin/bootsharp/index.mjs";
 import zlib from "node:zlib";
 import util from "node:util";
 import fs from "node:fs/promises";
@@ -12,7 +12,7 @@ await Promise.all([
     ...resources.assemblies.map(fetchBro)
 ]);
 
-Global.log = console.log;
+Program.log = console.log;
 await bootsharp.boot({ root: "./bin", resources });
 
 async function measure(dir) {

samples/vscode/src/extension.js

@@ -1,8 +1,8 @@
 import * as vscode from "vscode";
-import bootsharp, { Global } from "../../Minimal/cs/bin/bootsharp/bootsharp.mjs";
+import bootsharp, { Program } from "../../Minimal/cs/bin/bootsharp/index.mjs";
 
 export async function activate(context) {
-    Global.getFrontendName = () => "VS Code";
+    Program.getFrontendName = () => "VS Code";
     try { await bootsharp.boot(); }
     catch (e) { vscode.window.showErrorMessage(e.message); }
     const command = vscode.commands.registerCommand("bootsharp.hello", greet);
@@ -14,6 +14,6 @@ export function deactivate() {
 }
 
 function greet() {
-    const message = `Welcome, ${Global.getBackendName()}! Enjoy your VS Code extension space.`;
+    const message = `Welcome, ${Program.getBackendName()}! Enjoy your VS Code extension space.`;
     vscode.window.showInformationMessage(message);
 }

src/cs/Bootsharp.Common.Test/BindingTest.cs

@@ -12,7 +12,7 @@
 
     <ItemGroup>
         <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.8.0"/>
-        <PackageReference Include="xunit" Version="2.6.4"/>
+        <PackageReference Include="xunit" Version="2.6.6"/>
         <PackageReference Include="xunit.runner.visualstudio" Version="2.5.6">
             <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
             <PrivateAssets>all</PrivateAssets>
@@ -29,9 +29,6 @@
 
     <ItemGroup>
         <ProjectReference Include="../Bootsharp.Common/Bootsharp.Common.csproj"/>
-        <ProjectReference Include="../Bootsharp.Generate/Bootsharp.Generate.csproj"
-                          PrivateAssets="all" ReferenceOutputAssembly="false"
-                          OutputItemType="Analyzer" SetTargetFramework="TargetFramework=netstandard2.0"/>
     </ItemGroup>
 
 </Project>

src/cs/Bootsharp.Common.Test/Bootsharp.Common.Test.csproj

@@ -0,0 +1,28 @@
+namespace Bootsharp.Common.Test;
+
+public class InterfacesTest
+{
+    [Fact]
+    public void Records ()
+    {
+        // TODO: Remove once coverlet properly handles record coverage.
+        _ = new ExportInterface(default, default) with { Interface = typeof(int) };
+        _ = new ImportInterface(default) with { Instance = "" };
+    }
+
+    [Fact]
+    public void RegistersExports ()
+    {
+        var export = new ExportInterface(typeof(IBackend), default);
+        Interfaces.Register(typeof(Backend), export);
+        Assert.Equal(typeof(IBackend), Interfaces.Exports[typeof(Backend)].Interface);
+    }
+
+    [Fact]
+    public void RegistersImports ()
+    {
+        var import = new ImportInterface(new Frontend());
+        Interfaces.Register(typeof(IFrontend), import);
+        Assert.IsType<Frontend>(Interfaces.Imports[typeof(IFrontend)].Instance);
+    }
+}

src/cs/Bootsharp.Common.Test/InterfacesTest.cs

@@ -1,21 +1,21 @@
-using static Bootsharp.Function;
+using static Bootsharp.Proxies;
 
 namespace Bootsharp.Common.Test;
 
-public class FunctionTest
+public class ProxiesTest
 {
     [Fact]
     public void WhenEndpointNotFoundErrorIsThrown ()
     {
-        Assert.Contains("Endpoint 'foo' is not found.",
+        Assert.Contains("Proxy 'foo' is not found.",
             Assert.Throws<Error>(() => Get<Action>("foo")).Message);
     }
 
     [Fact]
     public void WhenFunctionTypeIsWrongErrorIsThrown ()
     {
         Set("bar", null);
-        Assert.Contains("Endpoint 'bar' is not 'System.Action'.",
+        Assert.Contains("Proxy 'bar' is not 'System.Action'.",
             Assert.Throws<Error>(() => Get<Action>("bar")).Message);
     }
 

src/cs/Bootsharp.Common.Test/NamespaceTest.cs

@@ -2,23 +2,8 @@
 using Bootsharp;
 using Bootsharp.Common.Test;
 
-[assembly: JSExport(
-    typeof(IBackend),
-    NamePattern = "ExportNamePattern",
-    NameReplacement = "ExportNameReplacement",
-    InvokePattern = "ExportInvokePattern",
-    InvokeReplacement = "ExportInvokeReplacement"
-)]
-
-[assembly: JSImport(
-    typeof(IFrontend),
-    NamePattern = "ImportNamePattern",
-    NameReplacement = "ImportNameReplacement",
-    InvokePattern = "ImportInvokePattern",
-    InvokeReplacement = "ImportInvokeReplacement",
-    EventPattern = "ImportEventPattern",
-    EventReplacement = "ImportEventReplacement"
-)]
+[assembly: JSExport(typeof(IBackend))]
+[assembly: JSImport(typeof(IFrontend))]
 
 namespace Bootsharp.Common.Test;
 
@@ -31,11 +16,6 @@ public class TypesTest
     public void Records ()
     {
         // TODO: Remove when coverlet bug is resolved: https://github.com/coverlet-coverage/coverlet/issues/1561
-        _ = new SolutionMeta { Assemblies = [], Methods = [], Types = [] } with { Assemblies = default };
-        _ = new AssemblyMeta { Name = "", Bytes = [] } with { Name = "foo" };
-        _ = new MethodMeta { Name = "", JSName = "", Arguments = default, Assembly = "", Type = default, Space = "", JSSpace = "", ReturnValue = default } with { Assembly = "foo" };
-        _ = new ArgumentMeta { Name = "", JSName = "", Value = default } with { Name = "foo" };
-        _ = new ValueMeta { Type = default, Nullable = true, TypeSyntax = "", Void = true, Serialized = true, Async = true, JSTypeSyntax = "" } with { TypeSyntax = "foo" };
         _ = new MockItem("") with { Id = "foo" };
         _ = new MockItemWithEnum(default) with { Enum = MockEnum.Bar };
         _ = new MockRecord(default) with { Items = new[] { new MockItem("") } };
@@ -46,52 +26,23 @@ public void TypesAreAssigned ()
     {
         Assert.Equal([typeof(IBackend)], new JSExportAttribute(typeof(IBackend)).Types);
         Assert.Equal([typeof(IFrontend)], new JSImportAttribute(typeof(IFrontend)).Types);
-    }
-
-    [Fact]
-    public void NameAndInvokeParametersAreNullByDefault ()
-    {
-        var attribute = new JSExportAttribute(typeof(IBackend));
-        Assert.Null(attribute.NamePattern);
-        Assert.Null(attribute.NameReplacement);
-        Assert.Null(attribute.InvokePattern);
-        Assert.Null(attribute.InvokeReplacement);
-    }
-
-    [Fact]
-    public void EventParametersAreNullByDefault () // (defaults are in generator)
-    {
-        var attribute = new JSImportAttribute(typeof(IBackend));
-        Assert.Null(attribute.EventPattern);
-        Assert.Null(attribute.EventReplacement);
+        Assert.Equal("Space", (new JSPreferencesAttribute { Space = ["Space"] }).Space[0]);
     }
 
     [Fact]
     public void ExportParametersEqualArguments ()
     {
         Assert.Equal([typeof(IBackend)],
             (export.ConstructorArguments[0].Value as IReadOnlyCollection<CustomAttributeTypedArgument>).Select(a => a.Value));
-        Assert.Equal("ExportNamePattern", GetNamedValue(export.NamedArguments, nameof(JSTypeAttribute.NamePattern)));
-        Assert.Equal("ExportNameReplacement", GetNamedValue(export.NamedArguments, nameof(JSTypeAttribute.NameReplacement)));
-        Assert.Equal("ExportInvokePattern", GetNamedValue(export.NamedArguments, nameof(JSTypeAttribute.InvokePattern)));
-        Assert.Equal("ExportInvokeReplacement", GetNamedValue(export.NamedArguments, nameof(JSTypeAttribute.InvokeReplacement)));
     }
 
     [Fact]
     public void ImportParametersEqualArguments ()
     {
         Assert.Equal([typeof(IFrontend)],
             (import.ConstructorArguments[0].Value as IReadOnlyCollection<CustomAttributeTypedArgument>).Select(a => a.Value));
-        Assert.Equal("ImportNamePattern", GetNamedValue(import.NamedArguments, nameof(JSTypeAttribute.NamePattern)));
-        Assert.Equal("ImportNameReplacement", GetNamedValue(import.NamedArguments, nameof(JSTypeAttribute.NameReplacement)));
-        Assert.Equal("ImportInvokePattern", GetNamedValue(import.NamedArguments, nameof(JSTypeAttribute.InvokePattern)));
-        Assert.Equal("ImportInvokeReplacement", GetNamedValue(import.NamedArguments, nameof(JSTypeAttribute.InvokeReplacement)));
-        Assert.Equal("ImportEventPattern", GetNamedValue(import.NamedArguments, nameof(JSImportAttribute.EventPattern)));
-        Assert.Equal("ImportEventReplacement", GetNamedValue(import.NamedArguments, nameof(JSImportAttribute.EventReplacement)));
     }
 
-    private static object GetNamedValue (IList<CustomAttributeNamedArgument> args, string key) =>
-        args.First(a => a.MemberName == key).TypedValue.Value;
     private static CustomAttributeData GetMockExportAttribute () =>
         typeof(TypesTest).Assembly.CustomAttributes
             .First(a => a.AttributeType == typeof(JSExportAttribute));

src/cs/Bootsharp.Common.Test/FunctionTest.cs renamed to src/cs/Bootsharp.Common.Test/ProxiesTest.cs

@@ -7,7 +7,7 @@
 /// <example>
 /// <code>
 /// [JSEvent]
-/// public static partial string OnSomethingHappened (string payload);
+/// public static partial void OnSomethingHappened (string payload);
 /// Namespace.onSomethingHappened.subscribe(payload => ...);
 /// </code>
 /// </example>