Skip to content

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]

version 6.0 changes

The dominant theme in version 6.0 is about adopting .NET 6.0. The GitHub project for this release has the most documented details. Many version 6.0 changes are breaking changes.

Notable changes:

  • Issue #131 was about removing direct support for WPF and any members marked obsolete in previous releases.
  • Issue #135 was about separating Newtonsoft JSON routines from the Core.
  • Issue #137 was about recognizing the new nullability features of .NET.
  • Issue #140 was about finally adding coverlet code coverage.

core reusable, opinionated concerns

Songhay.Diagnostics

This Core is exclusively concerned with tracing. 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`]

@BryanWilhite

Releases

No releases published

Packages

No packages published

Languages