This package generates a static `ThisAssembly.Constants` class with public constants for each Constant MSBuild item in the project. For example: <ItemGroup> <Constant Include="Foo.Bar" Value="Baz" /> </ItemGroup> Results in a corresponding `ThisAssembly.Constants.Foo.Bar` constant with the value `Baz`: Generated code: C#: partial class ThisAssembly { public static partial class Constants { public static partial class Foo { public const string Bar = "Baz"; } } } > 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.
Get Started
$ dotnet add package Changer.ThisAssembly.ConstantsReadme
<!-- include https://github.com/devlooped/.github/raw/main/sponsorlinkr.md -->
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.
<!-- https://github.com/devlooped/.github/raw/main/sponsorlinkr.md --> <!-- #constants -->This package generates a static ThisAssembly.Constants class with public
constants for @(Constant) MSBuild items in the project.
<ItemGroup>
<Constant Include="Foo.Bar" Value="Baz" Comment="Yay!" />
<Constant Include="Foo.Hello" Value="World" Comment="Comments make everything better 😍" />
</ItemGroup>
These constants can use values from MSBuild properties, making compile-time values configurable via environment variables or command line arguments. For example:
<PropertyGroup>
<HttpDefaultTimeoutSeconds>10</HttpDefaultTimeoutSeconds>
</PropertyGroup>
<ItemGroup>
<Constant Include="Http.TimeoutSeconds"
Value="$(HttpDefaultTimeoutSeconds)"
Type="int"
Comment="Default timeout in seconds for HTTP requests" />
</ItemGroup>
The C# code could consume this constant as follows:
public HttpClient CreateHttpClient(string name, int? timeout = default)
{
HttpClient client = httpClientFactory.CreateClient(name);
client.Timeout = TimeSpan.FromSeconds(timeout ?? ThisAssembly.Constants.Http.TimeoutSeconds);
return client;
}
Note how the constant is typed to int as specified in the Type attribute in MSBuild.
The generated code uses the specified Type as-is, as well as the attribute in that
case, so it's up to the user to ensure they match and result in valid C# code. For example,
you can emit a boolean, long, double, etc.. If no type is provided, is assumed. Values
can also be multi-line and will use
if supported by the target language version (11+).
