ArchRoslyn.Abstractions 0.3.0

.NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package ArchRoslyn.Abstractions --version 0.3.0                

                    
                

            
NuGet\Install-Package ArchRoslyn.Abstractions -Version 0.3.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="ArchRoslyn.Abstractions" Version="0.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add ArchRoslyn.Abstractions --version 0.3.0                

                    
                

            
#r "nuget: ArchRoslyn.Abstractions, 0.3.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 ArchRoslyn.Abstractions as a Cake Addin
#addin nuget:?package=ArchRoslyn.Abstractions&version=0.3.0

// Install ArchRoslyn.Abstractions as a Cake Tool
#tool nuget:?package=ArchRoslyn.Abstractions&version=0.3.0

Nuget codecov

Roslyn Architecture Analyzer

The ultimate goal of this project is to augment Roslyn C# compiler with additional architecture-related rules. Unlike the more common unit-test based approach, I envision this analyzers to be a part of the main compilation process, with near-instant feedback for developer. These rules should be:

  • Fast
  • Portable
  • Configurable by the end-user

Right now project consists of only one simple analyzer, inspired by an InternalsVisibleTo attribute. If you need more advanced capabilities, you should check out ArchUnitNET or NetArchTest.

CannotBeReferencedBy attribute

This is an assembly attribute that takes one string argument with a name of assembly and forbids direct and transitive references from the specified assembly to the assembly marked with this attribute. Basically, this attribute is an antipode of InternalsVisibleTo attribute.

Usage instructions

Install ArchRoslyn.Analyzer into all your projects to enable validation of rules imposed by an attribute.

Analyzer package contains both analyzer and an attribute and it's required to install analyzer in all of your projects because of Roslyn analyzer API limitations. Diagnostic analyzers only work on a single compilation at a time, and they can't access other compilations directly. That is why we have to workaround and share state between analyzer runs for different compilation. Also this design implies that it is possible for shared state to become incoherent in case of aggressive caching of compilation in IDE. Nevertheless, for a fresh run of a dotnet build this should work fine.

List of ideas

  • Explore unit-testing lib APIs for inspiration and possible adoption as an interface for Roslyn-based rules.
  • How to expand CannotBeReferencedBy attributes to allow more generic configuration? - e.g. layers, folders, wildcards, etc.
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 netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  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.

This package has no dependencies.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ArchRoslyn.Abstractions:

Package Downloads
ArchRoslyn.Analyzers

Roslyn analyzers for architecture validation
ArchRoslyn.Analyzer

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.0 758 6/28/2022
0.3.0 419 6/23/2022
0.2.0 393 6/19/2022
0.1.1 409 6/14/2022
0.1.0 515 6/13/2022