Accessing Assembly Metadata via C# Project File Properties

Display project Attribute (C#)

Karen Payne introduces a method for extracting project properties directly from C# project files rather than external configuration files. By utilizing the PropertyGroup in a .csproj file, developers can ensure metadata remains immutable once pushed to production.

Why This Matters

Storing metadata within the .csproj file creates a single source of truth that is compiled directly into the assembly, preventing unauthorized tampering post-deployment. This technical approach shifts static project information away from runtime files like appsettings.json, ensuring that legal and product-specific attributes are intrinsically linked to the build artifact itself.

Key Insights

• MSBuild supports dynamic property values, such as using $([System.DateTime]::Now.Year) to automatically update copyright dates during the build process.
• ASP.NET Core applications can access these properties through a centralized Info class and bind them to PageModel properties for display in Razor views.
• The Spectre.Console library provides a robust way to visualize project attributes in CLI environments using rounded borders and color-coded tables.
• Moving project attributes out of code files and into the project file reduces technical debt by eliminating hardcoded strings across multiple layers of the application.

Working Examples

Configuring the .csproj file with custom project properties.

<PropertyGroup> <Product>Code sample</Product> <Description>A sample project demonstrating assembly metadata retrieval.</Description> <Company>Payne services</Company> <Copyright>2019-$([System.DateTime]::Now.Year)</Copyright> </PropertyGroup>

Binding project metadata to an ASP.NET Core PageModel.

public class IndexModel(ILogger<IndexModel> logger) : PageModel { [BindProperty] public required Details Details { get; set; } private readonly ILogger<IndexModel> _logger = logger; public void OnGet() { Details = GetAllInfo(); } Details GetAllInfo() => new() { Company = Info.GetCompany(), Copyright = Info.GetCopyright(), Product = Info.GetProduct(), Description = Info.GetDescription(), Version = Info.GetVersion().ToString() }; }

Practical Applications

• Use Case: ASP.NET Core applications displaying versioning and company info in Bootstrap-styled tables via PageModel binding.
• Pitfall: Hardcoding metadata in source files leads to maintenance overhead when attributes like company name or copyright year change.
• Use Case: Console CLI tools utilizing Spectre.Console to provide formatted system details and version info to end-users.
• Pitfall: Relying on appsettings.json for static metadata allows production environments to display incorrect info if the configuration is modified post-deployment.

References:

• https://dev.to/karenpayneoregon/display-project-attribute-c-319d