Merge remote-tracking branch 'remotes/smoerijf/asyncapi#196-Publish-a…

…-global-dotnet-tool' into asyncapi#197-Produce-AsyncAPI-documents-at-build-time

# Conflicts:
#	src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs

src/AsyncAPI.Saunter.Generator.Cli/AsyncAPI.Saunter.Generator.Cli.csproj

@@ -11,7 +11,7 @@
     <Authors>AsyncAPI Initiative</Authors>
     <PackAsTool>true</PackAsTool>
     <PackageId>AsyncAPI.Saunter.Generator.Cli</PackageId>
-    <ToolCommandName>AsyncAPI.NET</ToolCommandName>
+    <ToolCommandName>dotnet-asyncapi</ToolCommandName>
     <PackageTags>asyncapi;aspnetcore;openapi;documentation;amqp;generator;cli;tool</PackageTags>
     <PackageReadmeFile>readme.md</PackageReadmeFile>
     <PackageIcon>logo.png</PackageIcon>
@@ -23,6 +23,7 @@
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <IncludeSymbols>true</IncludeSymbols>
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <Version>1.0.1</Version>
   </PropertyGroup>
 
   <ItemGroup Condition=" '$(TargetFramework)' != 'netstandard2.0' ">

src/AsyncAPI.Saunter.Generator.Cli/Commands/TofileInternal.cs

@@ -19,6 +19,7 @@
 using Saunter.AsyncApiSchema.v2;
 using static Program;
 using AsyncApiDocument = Saunter.AsyncApiSchema.v2.AsyncApiDocument;
+using System.IO;
 
 namespace AsyncApi.Saunter.Generator.Cli.Commands;
 

src/AsyncAPI.Saunter.Generator.Cli/Program.cs

@@ -5,14 +5,14 @@
 DependencyResolver.Init();
 
 // Helper to simplify command line parsing etc.
-var runner = new CommandRunner("dotnet asyncapi.net", "AsyncAPI Command Line Tools", Console.Out);
+var runner = new CommandRunner("dotnet asyncapi", "AsyncAPI Command Line Tools", Console.Out);
 
 // NOTE: The "dotnet asyncapi tofile" command does not serve the request directly. Instead, it invokes a corresponding
 // command (called _tofile) via "dotnet exec" so that the runtime configuration (*.runtimeconfig & *.deps.json) of the
 // provided startupassembly can be used instead of the tool's. This is neccessary to successfully load the
 // startupassembly and it's transitive dependencies. See https://github.com/dotnet/coreclr/issues/13277 for more.
 
-// > dotnet asyncapi.net tofile ...
+// > dotnet asyncapi tofile ...
 runner.SubCommand("tofile", "retrieves AsyncAPI from a startup assembly, and writes to file ", c =>
 {
     c.Argument(StartupAssemblyArgument, "relative path to the application's startup assembly");
@@ -24,7 +24,7 @@
     c.OnRun(Tofile.Run(args));
 });
 
-// > dotnet asyncapi.net _tofile ... (* should only be invoked via "dotnet exec")
+// > dotnet asyncapi _tofile ... (* should only be invoked via "dotnet exec")
 runner.SubCommand("_tofile", "", c =>
 {
     c.Argument(StartupAssemblyArgument, "");

src/AsyncAPI.Saunter.Generator.Cli/readme.md

@@ -1,15 +1,24 @@
 # AsyncApi Generator.Cli Tool
-A dotnet tool to generate AsyncAPI specification files based of dotnet DLL (The application itself).
+A dotnet tool to generate AsyncAPI specification files based of a dotnet DLL (The application itself).
 
 ## Tool usage
 ```
-dotnet asyncapi.net tofile --output [output-path] --format [json,yml,yaml] --doc [asyncapi-document-name] [startup-assembly]
+dotnet asyncapi tofile --output [output-path] --format [json,yml,yaml] --doc [asyncapi-document-name] [startup-assembly]
 ```
 startup-assembly: the file path to the entrypoint dotnet DLL that hosts AsyncAPI document(s).
 
 ## Tool options
---doc: The name of the AsyncAPI document as defined in the startup class by the ```.ConfigureNamedAsyncApi()```-method. If not specified, all documents will be exported.  
---output: relative path where the AsyncAPI will be output [defaults to stdout]  
---filename: the template for the outputted file names. Default: "{document}_asyncapi.{extension}"  
---format: the output formats to generate, can be a combination of json, yml and/or yaml. File extension is appended to the output path.  
---env: define environment variable(s) for the application  
+- _--doc_: The name of the AsyncAPI document as defined in the startup class by the ```.ConfigureNamedAsyncApi()```-method. If only ```.AddAsyncApiSchemaGeneration()``` is used, the document is unnamed and will always be exported. If not specified, all documents will be exported.  
+- _--output_: relative path where the AsyncAPI will be output [defaults to stdout]  
+- _--filename_: the template for the outputted file names. Default: "{document}_asyncapi.{extension}"  
+- _--format_: the output formats to generate, can be a combination of json, yml and/or yaml. File extension is appended to the output path.  
+- _--env_: define environment variable(s) for the application  
+
+## Install the Generator.Cli dotnet Tool
+```
+dotnet tool install --global AsyncAPI.Saunter.Generator.Cli
+```
+After installing the tool globally, it is available using commands: ```dotnet asyncapi``` or ```dotnet-asyncapi```
+
+Want to learn more about .NET tools? Or want to install it local using a manifest?
+[Check out this Microsoft page on how to manage .NET tools](https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools)

test/AsyncAPI.Saunter.Generator.Cli.Tests/AsyncAPI.Saunter.Generator.Cli.Tests.csproj

@@ -24,10 +24,4 @@
     <Using Include="Xunit" />
   </ItemGroup>
 
-  <ItemGroup>
-    <None Update="asyncapi.cmd">
-      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
-    </None>
-  </ItemGroup>
-
 </Project>

test/AsyncAPI.Saunter.Generator.Cli.Tests/DotnetCliToolTests.cs

@@ -35,7 +35,7 @@ public void DefaultCallPrintsCommandInfo()
         var stdOut = RunTool("", 1);
 
         stdOut.ShouldBe("""
-                        Usage: dotnet asyncapi.net tofile [options] [startupassembly]
+                        Usage: dotnet asyncapi tofile [options] [startupassembly]
 
                         startupassembly:
                           relative path to the application's startup assembly

test/AsyncAPI.Saunter.Generator.Cli.Tests/PackAndInstallLocalTests.cs

@@ -38,19 +38,19 @@ public void Pack_Install_Run_Uninstall_Test()
         stdOut.ShouldContain("Successfully created package");
 
         stdOut = this.Run("dotnet", "tool install --global --add-source ./bin/Release AsyncAPI.Saunter.Generator.Cli", "../../../../../src/AsyncAPI.Saunter.Generator.Cli");
-        stdOut.ShouldBeOneOf("You can invoke the tool using the following command: AsyncAPI.NET\r\nTool 'asyncapi.saunter.generator.cli' (version '1.0.0') was successfully installed.",
-                             "Tool 'asyncapi.saunter.generator.cli' was reinstalled with the stable version (version '1.0.0').");
+        stdOut.ShouldBeOneOf("You can invoke the tool using the following command: dotnet-asyncapi\r\nTool 'asyncapi.saunter.generator.cli' (version '1.0.1') was successfully installed.",
+                             "Tool 'asyncapi.saunter.generator.cli' was reinstalled with the stable version (version '1.0.1').");
 
         stdOut = this.Run("dotnet", "tool list -g asyncapi.saunter.generator.cli", "");
-        stdOut.ShouldContain("AsyncAPI.NET");
+        stdOut.ShouldContain("dotnet-asyncapi");
 
-        stdOut = this.Run("asyncapi.cmd", "", "", 1);
+        stdOut = this.Run("dotnet", "asyncapi", "", 1);
         stdOut.ShouldContain("tofile:  retrieves AsyncAPI from a startup assembly, and writes to file");
 
         stdOut = this.Run("dotnet", "tool uninstall -g asyncapi.saunter.generator.cli", "");
         stdOut.ShouldContain(" was successfully uninstalled.");
 
         stdOut = this.Run("dotnet", "tool list -g asyncapi.saunter.generator.cli", "", 1);
-        stdOut.ShouldNotContain("AsyncAPI.NET");
+        stdOut.ShouldNotContain("dotnet-asyncapi");
     }
 }