OSK.Hexagonal.MetaData 1.0.0

.NET Standard 2.1

dotnet add package OSK.Hexagonal.MetaData --version 1.0.0

NuGet\Install-Package OSK.Hexagonal.MetaData -Version 1.0.0

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="OSK.Hexagonal.MetaData" Version="1.0.0" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add OSK.Hexagonal.MetaData --version 1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: OSK.Hexagonal.MetaData, 1.0.0"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install OSK.Hexagonal.MetaData as a Cake Addin
#addin nuget:?package=OSK.Hexagonal.MetaData&version=1.0.0

// Install OSK.Hexagonal.MetaData as a Cake Tool
#tool nuget:?package=OSK.Hexagonal.MetaData&version=1.0.0

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

OSK.Hexagonal.MetaData

This project is meant to provide a way to mark, directly in code, the expectation of a given abstraction for a hexagonally implemented library. By using this kind of metadata, a codebase may hopefully be more clearly documented to its intentions and usage. There is also a set of assembly extensions that can be used to retrieve specific types of abstractions based on their hexagonal integration type metadata.

Usage

Codebase abstractions, i.e. interfaces, can be marked using the HexagonalIntegrationAttribute and can be marked in a variety of ways to help provide code readers an idea to the intentions of the port at a glance. The attribute can be defined with one or more hexagonal integration types. These types help to define expectations for integrations, consumers, and direct implementations of the library.

Note: There is some additional logic in place to restrict some combinations of integration types. For example, an abstraction can not be both marked as required and optional. This is to help reduce potential confusion for a codebase when using this library. The attribute integration types are validated at runtime and will throw a HexagonalMetaDataException if they are found to be invalid.

Contributions and Issues

Any and all contributions are appreciated! Please be sure to follow the branch naming convention OSK-{issue number}-{deliminated}-{branch}-{name} as current workflows rely on it for automatic issue closure. Please submit issues for discussion and tracking using the github issue tracker.111

Product	Compatible and additional computed target framework versions.
.NET	net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.
.NET Core	netcoreapp3.0 was computed. netcoreapp3.1 was computed.
.NET Standard	netstandard2.1 is compatible.
MonoAndroid	monoandroid was computed.
MonoMac	monomac was computed.
MonoTouch	monotouch was computed.
Tizen	tizen60 was computed.
Xamarin.iOS	xamarinios was computed.
Xamarin.Mac	xamarinmac was computed.
Xamarin.TVOS	xamarintvos was computed.
Xamarin.WatchOS	xamarinwatchos was computed.

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

.NETStandard 2.1
- No dependencies.

NuGet packages (6)

Showing the top 5 NuGet packages that depend on OSK.Hexagonal.MetaData:

Package	Downloads
OSK.Functions.Outputs.Abstractions Provides an abstraction for a .NET mechanism that returns outputs or error information to callers in a simple to use and consolidated way.	4.9K
OSK.Extensions.Object.DeepEquals DeepEquals is a fast, flexible, and simple way of comparing objects deeply in .NET	2.1K
OSK.Security.Cryptography.Abstractions Abstractions for easily handling numerous cryptography algorithms and keys within a DI container in .NET	2.0K
OSK.Parsing.FileTokens Provides a .NET mechanism for parsing a variety of language files based on a configuration file for expected tokens to parse.	807
OSK.MessageBus.Abstractions An abstraction layer for communicating across a variety of different message buses seamlessly and easily. Meant to allow easy integration between different message buses without causing drastic changes to the consumers.	445

GitHub repositories

This package is not used by any popular GitHub repositories.