MEGA.FOD.UIComponents 10.2.1

NuGet Packages Documentation

This document provides an overview of all NuGet packages used in the Fod.UIComponents project.

Project Information

• Package Name: FOD.UIComponents
• Version: 1.0.0
• Target Framework: .NET 10.0
• Authors: AGE
• Description: Blazor component library for FOD design system
• Package ID: FOD.UIComponents

Production Dependencies

Fod.UIComponents (Main Library)

Microsoft.AspNetCore.Components.Authorization

• Version: 10.0.0
• Purpose: Provides authentication and authorization support for Blazor components
• Usage: Authentication state management and authorization attributes

Microsoft.AspNetCore.Components.Web

• Version: 10.0.0
• Purpose: Core Blazor web component framework and utilities
• Usage: Essential for building interactive web components

Microsoft.AspNetCore.Components.WebAssembly

• Version: 10.0.0
• Purpose: WebAssembly runtime support for client-side Blazor applications
• Usage: Required for running Blazor components in the browser

Microsoft.AspNetCore.Http

• Version: 2.3.0
• Purpose: HTTP request/response abstractions for ASP.NET Core
• Usage: HTTP-related utilities and middleware support

Microsoft.Extensions.Http

• Version: 10.0.0
• Purpose: HttpClient factory and DI integration for HTTP operations
• Usage: Dependency injection and management of HTTP client instances

Microsoft.Extensions.Localization

• Version: 10.0.0
• Purpose: Localization and internationalization support
• Usage: Multi-language support for component strings and resources

SonarAnalyzer.CSharp

• Version: 10.15.0.120848
• Purpose: Code quality analysis using SonarQube rules
• Usage: Build-time code analysis for code quality and security issues
• Type: Analyzer (build-only, not included in runtime)

Test Dependencies

Fod.UIComponents.Tests (Unit Tests)

bunit

• Version: 1.28.9
• Purpose: Unit testing library for Blazor components
• Usage: Component testing framework providing component test context and utilities

bunit.web

• Version: 1.28.9
• Purpose: Web-specific extensions for bunit
• Usage: Enhanced testing capabilities for web-based Blazor components

xunit

• Version: 2.6.2
• Purpose: Unit testing framework for .NET
• Usage: Test framework and assertions for writing unit tests

Microsoft.NET.Test.Sdk

• Version: 17.8.0
• Purpose: Visual Studio test runtime and discovery
• Usage: Integration with Visual Studio Test Explorer

xunit.runner.visualstudio

• Version: 2.5.4
• Purpose: Visual Studio test runner for xunit tests
• Usage: Enables running xunit tests from Visual Studio
• Type: Test-only (PrivateAssets)

Moq

• Version: 4.20.72
• Purpose: Mocking library for unit tests
• Usage: Creating mock objects for isolated unit testing

Microsoft.Extensions.Caching.Memory

• Version: 9.0.0
• Purpose: In-memory caching support
• Usage: Caching during tests and potentially in component logic

coverlet.collector

• Version: 6.0.0
• Purpose: Code coverage collection during test execution
• Usage: Measuring test coverage and generating coverage reports
• Type: Test-only (PrivateAssets)

Dependency Summary

Version Strategy

Production Dependencies

All production dependencies are pinned to specific versions to ensure stability and consistency across deployments.

Test Dependencies

Test dependencies are also pinned to ensure reproducible test runs and consistent code coverage.

.NET Target

The project targets .NET 10.0, which provides:

• Latest language features
• Enhanced performance
• Latest security updates
• Modern API patterns

Security Considerations

• All dependencies should be regularly updated for security patches
• Monitor each package for security advisories
• Use dotnet outdated to check for updates
• Review breaking changes before updating major versions

Key Packages for Security

• Microsoft.AspNetCore.Components.Authorization: Handles authentication security
• Microsoft.AspNetCore.Http: Manages HTTP security headers and protocols
• SonarAnalyzer.CSharp: Identifies security vulnerabilities in code

Development Guidelines

Adding New Dependencies

When adding new NuGet packages:

1. Ensure the package targets .NET 10.0 or compatible framework
2. Check for security vulnerabilities using dotnet list package --vulnerable
3. Update this documentation with the package details
4. Test thoroughly before committing
5. Document the purpose and usage of the package

Updating Dependencies

When updating existing packages:

1. Review release notes for breaking changes
2. Run all tests (dotnet test) to verify compatibility
3. Check for new security vulnerabilities
4. Update version numbers in both .csproj files if needed

Build and Runtime Behavior

Analyzer Packages

• SonarAnalyzer.CSharp is configured as a build-time analyzer
• It does NOT add runtime dependencies
• Only used during build for code quality checks

Private Assets

• Test-specific packages (xunit.runner.visualstudio, coverlet.collector) are marked as private
• They are not propagated to dependent projects

Troubleshooting

Missing Dependencies

If you encounter missing dependency issues:

dotnet restore

Outdated Packages

To check for outdated packages:

dotnet list package --outdated

Vulnerable Packages

To check for known vulnerabilities:

dotnet list package --vulnerable

References

• NuGet Package Search
• .NET 10.0 Documentation
• Blazor Security Documentation
• bunit Documentation
• xunit Documentation