ThisAssembly.Resources 2.0.10

Prefix Reserved
dotnet add package ThisAssembly.Resources --version 2.0.10                
NuGet\Install-Package ThisAssembly.Resources -Version 2.0.10                
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="ThisAssembly.Resources" Version="2.0.10">
  <PrivateAssets>all</PrivateAssets>
  <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
</PackageReference>                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ThisAssembly.Resources --version 2.0.10                
#r "nuget: ThisAssembly.Resources, 2.0.10"                
#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.
// Install ThisAssembly.Resources as a Cake Addin
#addin nuget:?package=ThisAssembly.Resources&version=2.0.10

// Install ThisAssembly.Resources as a Cake Tool
#tool nuget:?package=ThisAssembly.Resources&version=2.0.10                

This project uses SponsorLink to attribute sponsor status (direct, indirect or implicit). For IDE usage, sponsor status is required. IDE-only warnings will be issued after a grace period otherwise.

This package generates a static ThisAssembly.Resources class with public properties exposing typed APIs to retrieve the contents of embedded resources.

  <ItemGroup>
    <EmbeddedResource Include="Content/Docs/License.md" />
  </ItemGroup>

alternate text is missing from this package README image

Since markdown files are text files, the API will expose a Text property property for it that will read its content once and cache it:

alternate text is missing from this package README image

The $(EmbeddedResourceStringExtensions) MSBuild property allows customizing which file extensions get treated as text files. By default, it's defined as:

  <PropertyGroup>
    <EmbeddedResourceStringExtensions>.txt|.cs|.sql|.json|.md</EmbeddedResourceStringExtensions>
  </PropertyGroup>

You can append additional file extensions to this list, or override it completely. The list must be pipe-separated.

You can always use the provided GetStream and GetBytes for more advanced scenarios (or for non-text resources).

Optionally, you can specify the Kind metadata for a specific EmbeddedResource you want treated as a text file:

<ItemGroup>
    <EmbeddedResource Include="query.kql" Kind="Text" />
</ItemGroup>

You can also add a Comment item metadata attribute, which will be used as the <summary> XML doc for the generated member.

Adding dynamic resources

You can also provide additional embedded resources dynamically, by running a target before PrepareEmbeddedResources:

  <Target Name="AddDynamicResources" BeforeTargets="PrepareEmbeddedResources">
    <ItemGroup>
      <EmbeddedResource Include="Content/Docs/$(Configuration).md" />
    </ItemGroup>
  </Target>

Customizing the generated code

The following MSBuild properties can be used to customize the generated code:

Property Description
ThisAssemblyNamespace Sets the namespace of the generated ThisAssembly root class. If not set, it will be in the global namespace.
ThisAssemblyVisibility Sets the visibility modifier of the generated ThisAssembly root class. If not set, it will be internal.

Sponsors

Clarius Org Kirill Osenkov MFB Technologies, Inc. Torutek DRIVE.NET, Inc. Keith Pickford Thomas Bolon Kori Francis Toni Wenzel Uno Platform Dan Siegel Reuben Swartz Jacob Foshee alternate text is missing from this package README image Eric Johnson Ix Technologies B.V. David JENNI Jonathan Charley Wu Jakob Tikjøb Andersen Tino Hager Mark Seemann Ken Bonny Simon Cropp agileworks-eu sorahex Zheyu Shen Vezel ChilliCream 4OTC Vincent Limo Jordan S. Jones domischell

Sponsor this project  

Learn more about GitHub Sponsors

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. 
.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.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on ThisAssembly.Resources:

Package Downloads
ThisAssembly

Meta-package that includes all ThisAssembly.* packages. > This project uses SponsorLink to attribute sponsor status (direct, indirect or implicit). For IDE usage, sponsor status is required. > IDE-only warnings will be emitted after a grace period otherwise. Learn more at https://github.com/devlooped#sponsorlink.

GitHub repositories (3)

Showing the top 3 popular GitHub repositories that depend on ThisAssembly.Resources:

Repository Stars
devlooped/ThisAssembly
Exposes project and assembly level information as constants in the ThisAssembly class using source generators powered by Roslyn.
atifaziz/LinqPadless
LINQPad Queries without LINQPad
viceroypenguin/SuperLinq
Extensions to LINQ to Objects
Version Downloads Last updated
2.0.10 1,695 11/26/2024
2.0.9 456 11/23/2024
2.0.8 1,518 11/8/2024
2.0.7 164 11/8/2024
2.0.6 438 11/1/2024
2.0.5 654 10/9/2024
2.0.4 144 10/8/2024
2.0.3 1,412 9/30/2024
2.0.2 117 9/30/2024
1.4.3 20,285 1/30/2024
1.4.2 125 1/30/2024
1.4.1 3,034 8/30/2023
1.4.0 696 8/11/2023
1.1.3 1,333 1/10/2023
1.1.1 744 1/6/2023