Skip to content

core reusable, opinionated concerns for *all* 🧐 of my C# projects

License

Notifications You must be signed in to change notification settings

BryanWilhite/SonghayCore

Repository files navigation

SonghayCore

Build Status

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]

core reusable, opinionated concerns

Songhay.Hosting

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

Songhay.Diagnostics

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

Songhay.Extensions

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:

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

Songhay.Models

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:

Documentation πŸ“š: Songhay.Models

Songhay.Xml

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

satellite packages

SonghayCore.xUnit

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

SonghayCore.Newtonsoft

Core reusable, opinionated Newtonsoft concerns for my C# projects.

GitHub repo: https://github.com/BryanWilhite/SonghayCore.Newtonsoft

NuGet package πŸ“¦: SonghayCore.Newtonsoft

Studio packages dependent on SonghayCore

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`]
Loading

@BryanWilhite

Releases

No releases published

Packages

No packages published

Languages