Arcasharp.Embed.SourceGenerator 1.0.0-alpha.4

This is a prerelease version of Arcasharp.Embed.SourceGenerator.

dotnet add package Arcasharp.Embed.SourceGenerator --version 1.0.0-alpha.4

NuGet\Install-Package Arcasharp.Embed.SourceGenerator -Version 1.0.0-alpha.4

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Arcasharp.Embed.SourceGenerator" Version="1.0.0-alpha.4" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

<PackageVersion Include="Arcasharp.Embed.SourceGenerator" Version="1.0.0-alpha.4" />
                    

                            Directory.Packages.props

<PackageReference Include="Arcasharp.Embed.SourceGenerator" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add Arcasharp.Embed.SourceGenerator --version 1.0.0-alpha.4

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Arcasharp.Embed.SourceGenerator, 1.0.0-alpha.4"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

#:package Arcasharp.Embed.SourceGenerator@1.0.0-alpha.4

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=Arcasharp.Embed.SourceGenerator&version=1.0.0-alpha.4&prerelease
                    

                            Install as a Cake Addin

#tool nuget:?package=Arcasharp.Embed.SourceGenerator&version=1.0.0-alpha.4&prerelease
                    

                            Install as a Cake Tool

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Arcasharp.Embed.SourceGenerator

Arcasharp.Embed.SourceGenerator is a C# source generator that allows you to embed files directly into your C# code. This can be useful for including static resources such as configuration files, images, or other assets directly within your assemblies.

Getting Started

To get started with Arcasharp.Embed.SourceGenerator, follow these steps:

Installation

Add the Arcasharp.Embed.SourceGenerator package to your project. You can do this via the NuGet Package Manager or by adding the following line to your .csproj file:
```
<PackageReference Include="Arcasharp.Embed.SourceGenerator" Version="1.0.0-alpha.2" />
```
Restore the NuGet packages:
```
dotnet restore
```

Usage

To embed a file into your project, use the [EmbedFile] attribute on a partial static method that returns a byte[]. The source generator will automatically generate the necessary code to include the file as a byte array.

Example 1: Embedding a file

using Arcasharp.Embed;

namespace MyNamespace
{
    public static partial class EmbeddedFiles
    {
        [EmbedFile("path/to/your/file.txt")]
        public static partial byte[] GetFile();
    }
}

Caveats

To make sure the file are up to date, the source generator will run any time a change in the syntax tree is detected: that means basically when any character is typed into the editor. If you only need to update the embedded file's content, you will need to do a small change to the code to trigger the source generator.

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed.
.NET Core	netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.0 is compatible. netstandard2.1 was computed.
.NET Framework	net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen40 was computed. tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last Updated
1.0.0-alpha.4	138	2/13/2025
1.0.0-alpha.3	72	1/29/2025
1.0.0-alpha.2	94	1/11/2025
1.0.0-alpha.1	98	12/2/2024