RemindMeAnalyzer 0.1.1

.NET Standard 2.0

dotnet add package RemindMeAnalyzer --version 0.1.1

NuGet\Install-Package RemindMeAnalyzer -Version 0.1.1

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="RemindMeAnalyzer" Version="0.1.1" />

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

<PackageVersion Include="RemindMeAnalyzer" Version="0.1.1" />
                    

                            Directory.Packages.props

<PackageReference Include="RemindMeAnalyzer" />
                    

                            Project file

For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.

paket add RemindMeAnalyzer --version 0.1.1

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

#r "nuget: RemindMeAnalyzer, 0.1.1"

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

#:package RemindMeAnalyzer@0.1.1

#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.

#addin nuget:?package=RemindMeAnalyzer&version=0.1.1
                    

                            Install as a Cake Addin

#tool nuget:?package=RemindMeAnalyzer&version=0.1.1
                    

                            Install as a Cake Tool

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

RemindMeAnalyzer

This project has a .NET Roslyn analyzer that allows you to get a reminder on namespace change.

Package	NuGet
RemindMeAnalyzer

Features

The only feature is to remind you via a diagnostic error about namespace change with a custom message.

Usage:

Let's condsider the next use case. You've implemented versioning of stored models or public API contracts to avoid breaking changes. Sometimes you need to do some drastic changes and you issue a new version. But sometimes you want to do a small naming change. It doesn't make sense to issue a new version just for that. You can just write a comment but you can miss it if you have a lot of files. This library allows you to mark such properties:

namespace MyContracts.V1;

public record Person(
    [property: ErrorOnNamespaceChange("Rename to FullName", "MyContracts.V1")]
    string Name);

This won't produce any diagnostics, since namespace in the attribute is the same as the namespace of the class. When you introduce a new version by copying old one and changing namespaces you'll get the next code:

namespace MyContracts.V2;

public record Person(
    [property: ErrorOnNamespaceChange("Rename to FullName", "MyContracts.V1")]
    string Name);

This one will produce an error:

Warning RM1000 : Message "Rename to FullName" is shown because namespace was changed from MyContracts.V1

To add a package reference to the analyzer:

        <PackageReference Include="RemindMeAnalyzer" Version="0.1.1" PrivateAssets="all" ExcludeAssets="runtime" />

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. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.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.

.NETStandard 2.0
- No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.