NativeAOT to improve performance for formatting a single file

[belav]

NativeAOT may be a solution to the problem of csharpier being slow to format a single file.
It will be in .net7
dotnet/runtime#61231
It is currently experimental, and I believe can be tested now to see if it would solve the problem
https://github.com/dotnet/runtimelab/tree/feature/NativeAOT#readme

[belav]

Followed the instructions at https://github.com/dotnet/runtimelab/blob/feature/NativeAOT/docs/using-nativeaot/compiling.md

[OneCyrus]

now that .NET 7 is out, are there some technical blockers from moving to native aot? just wondering about the current state

[belav]

I don't believe it is possible to publish a dotnet tool with NativeAOT.
ReadyToRun is another possibility to improve startup time that I just saw. There is an open issue around support for dotnet tools and ReadyToRun dotnet/sdk#10801, but I haven't seen one for NativeAOT.

[belav]

ChatGPT seems to think that it would be possible to publish to nuget with platform specific runtimes that use nativeAOT, I should dig into that more

Publishing a .NET tool that uses **NativeAOT** involves additional considerations, as tools are typically installed globally and need to support multiple platforms seamlessly. Here’s how you can approach it:

---

### Steps to Publish a .NET Tool with NativeAOT

#### 1. **Set Up NativeAOT Compilation**
   - Ensure your project is configured for NativeAOT in the `.csproj` file:
     ```xml
     <PropertyGroup>
       <PublishAot>true</PublishAot>
       <SelfContained>true</SelfContained>
       <RuntimeIdentifier>win-x64</RuntimeIdentifier> <!-- Or other RIDs -->
     </PropertyGroup>
     ```
   - Replace `RuntimeIdentifier` with the platform(s) you intend to target, e.g., `linux-x64`, `osx-arm64`, etc.

---

#### 2. **Multi-Runtime Support**
   - Tools compiled with NativeAOT are platform-specific. If your tool needs to support multiple platforms, you must build separate binaries for each platform and package them together.
   - Use the `runtimes` folder structure in your package:
     ```
     /runtimes
       /win-x64
         /native
           tool.exe
       /linux-x64
         /native
           tool
       /osx-arm64
         /native
           tool
     ```

---


#### 4. **Create a Multi-Platform NuGet Package**
   - Include binaries for all target platforms in the NuGet package.
   - Configure the `.nuspec` file or `.csproj` to include platform-specific binaries:
     ```xml
     <ItemGroup>
       <None Include="runtimes\win-x64\native\*" Pack="true" PackagePath="runtimes/win-x64/native/" />
       <None Include="runtimes\linux-x64\native\*" Pack="true" PackagePath="runtimes/linux-x64/native/" />
       <None Include="runtimes\osx-arm64\native\*" Pack="true" PackagePath="runtimes/osx-arm64/native/" />
     </ItemGroup>
     ```

---

[belav]

ChatGpt was hallucinating, here is an issue for adding AOT support in dotnet tools - dotnet/sdk#40931

[belav]

This will now be possible with net10

https://github.com/baronfel/multi-rid-tool

[belav]

A good article about publishing net10 tools - https://andrewlock.net/exploring-dotnet-10-preview-features-7-packaging-self-contained-and-native-aot-dotnet-tools-for-nuget/