The Core code to install as a NuGet package for all of my studio Solutions. Anyone who may be reading this π is free to do the same. This package is based on a project file that supports multi-targeting, declaring support for net6.0
.
NuGet package π¦: SonghayCore
documentation π: SonghayCore
API
coverlet test coverage π¬β: [report]
One of the most important additions to .NET came in .NET 6.0 (circa 2021): the .NET Generic Host [π docs]. This host concept from Microsoft allows developers to not have to reinvent:
- Dependency injection (DI)
- Logging
- Configuration
- App shutdown
IHostedService
implementations (for long-running background tasks [π docs ])
All ASP.NET developers expect to get these things βfor freeβ and, finally, Microsoft is basically letting all .NET developers get these things for free. This Core recognizes the .NET Generic Host, stating with the DefaultHostedService
class (see Songhay.Extensions
below for more details).
This Core is concerned with tracing as well as logging. Logging concerns should be logically above this Core. TraceSources
and TraceSourceExtensions
define how tracing should be implemented with a bias toward using all source levels. When tracing is not configured for this Core then it will be ignored without throwing exceptions.
For a review of the organizational difference between tracing and logging, see βTracing vs Logging vs Monitoring: Whatβs the Difference?β by Chrissy Kidd.
Documentation π: Songhay.Diagnostics
The Songhay System uses imperative C# code with a view to make it more functional in an effort to control complexity and enhance maintainability.
The preference for extension methods encourages stateless, reusable routines (many of them are βpureβ functions).
Notable extensions:
-
IConfigurationExtensions
β defines shared routines based on conventions around the .NET Generic Host [π docs]. -
IConfigurationBuilderExtensions
β defines shared routines for application configuration building under .NET Standard. -
ILoggerExtensions
β defines shared routines based on conventions around the .NET Generic Host [π docs]. -
HttpRequestMessageExtensions
β defines shared routines for HTTP access under .NET Standard with a lazy-loadedHttpClient
. Routines for Azure Blob Storage are included here. -
HttpWebRequestExtensions
β defines shared routines for HTTP access for the legacy .NET Framework.
There is support for URI templates (to be used with RestApiMetadata
) in the form of extension methods, running on top of Tavis.UriTemplates
.
Documentation π: Songhay.Extensions
The Core models of the Songhay System define types for MIME, XHTML, OPML, REST, the Repository, the Display Item (for WPF and other MVVM solutions), etc.
The Core models are βanemicβ by design (there are very few abstract classes)βany logic would be found first in an Extension Method.
Notable models:
-
DisplayItemModel
β defines the conventional way to display data. -
MenuDisplayItemModel
β defines the conventional way to display nested/grouped data. -
RestApiMetadata
β defines conventional REST API metadata.
Documentation π: Songhay.Models
The βcoreβ of the Core is concern for XML. The Songhay System started out as utilities around XPathDocument
and grew into LINQ for XMLβover XDocument
.
Documentation π: Songhay.Xml
Defines reusable class definitions for xUnit. Featured is the ProjectFileDataAttribute
, allowing test data files to be loaded from a relative path.
NuGet package π¦: SonghayCore.xUnit
Documentation π: Songhay.Tests
Core reusable, opinionated Newtonsoft concerns for my C# projects.
GitHub repo: https://github.com/BryanWilhite/SonghayCore.Newtonsoft
NuGet package π¦: SonghayCore.Newtonsoft
graph BT
netstandard2[.NET Standard 2.0]
net6[.NET 6.0]
1[`SonghayCore`]
2[`SonghayCore.Newtonsoft`]
net6-->1
netstandard2-->2
2-..->|optional addition|1
1-->3[`SonghayCore.xUnit`]
1-->4[`Songhay.DataAccess`]
1-->5[`Songhay.Feeds`]
1-->6[`Songhay.Publications`]
1-->7[`Songhay.Social`]