bkoelman / resharpercodecontractnullabilityfxcop

Reports diagnostics, helping you to annotate your source tree with (Item)NotNull / (Item)CanBeNull attributes.

Resharper Code Contract Nullability FxCop Rules

This Visual Studio analyzer supports you in consequently annotating your codebase with Resharpers nullability attributes. Doing so improves the nullability analysis engine in Resharper, so NullReferenceExceptions at runtime will become something from the past.

Get started

• You need Visual Studio 2013 (or lower) and Resharper v8 or higher to use this analyzer. See here if you use Visual Studio 2015 or 2017.

• Activate the solution configuration in which you want to install (Debug/Release)

• From the NuGet package manager console:

  Install-Package ResharperCodeContractNullabilityFxCop

  Install-Package JetBrains.Annotations

• Rebuild your solution

Instead of adding the JetBrains package, you can put the annotation definitions directly in your source code. In that case, it's recommended to set both the conditional and internal options checked.

Building, Testing, and Debugging

To build, open ResharperCodeContractNullabilityFxCop.sln in Visual Studio 2013. Press Ctrl + R, A to run all unit tests. See How-to-debug.md for debugging instructions.

Trying out the latest build

After each commit, a new prerelease NuGet package is automatically published to AppVeyor at https://ci.appveyor.com/project/bkoelman/resharpercodecontractnullabilityfxcop/build/artifacts. To try it out, follow the next steps:

• In Visual Studio: Tools, Options, NuGet Package Manager, Package Sources
  • Click +
  • Name: AppVeyor ResharperCodeContractNullabilityFxCop, Source: https://ci.appveyor.com/nuget/ResharperCodeContractNullabilityFxCop
  • Click Update, Ok
• Open the NuGet package manager console (Tools, NuGet Package Manager, Package Manager Console)
  • Select AppVeyor ResharperCodeContractNullabilityFxCop as package source
  • Run command: Install-Package ResharperCodeContractNullabilityFxCop -pre

Running on your build server

This assumes your project uses ResharperCodeContractNullabilityFxCop, but Resharper is not installed on your build server. To make the analyzer run there, make sure to install External Annotations on the server as a pre-build step:

• nuget install JetBrains.ExternalAnnotations -Version 10.2.29
• xcopy JetBrains.ExternalAnnotations.10.2.29\*.xml "%LOCALAPPDATA%\JetBrains\Installations\ReSharperPlatformVs15\ExternalAnnotations" /s /i /r /y /q

resharpercodecontractnullabilityfxcop's Issues

Parameter name of indexer property is reported as Item; only one parameter is reported

Repro:

class C
{
    public int this[string a, string b, string c]
    {
        get { throw new NotImplementedException();}
        set { throw new NotImplementedException();}
    }
}

Expected:
Annotate 'a' with [NotNull] or [CanBeNull].
Annotate 'b' with [NotNull] or [CanBeNull].
Annotate 'c' with [NotNull] or [CanBeNull].

Actual:
Annotate 'Item' with [NotNull] or [CanBeNull].

Unexpected report on an array of value type

Repro:

class C
{
    byte[] f;
}

Reports:

Annotate 'f' with [ItemNotNull] or [ItemCanBeNull].

This is incorrect, because the underlying item type, byte in this case, cannot contain null.

Constructed array parameter from open generic interface with external annotation should not be reported

Example:

public class C : ICollection<string>
{
    // ...
    public void CopyTo(string[] array, int arrayIndex) { ... }
}

Reports:

Annotate 'array' with [NotNull] or [CanBeNull].

Which is incorrect, because an external annotation exists for ICollection.CopyTo:

<member name="M:System.Collections.Generic.ICollection`1.CopyTo(`0[],System.Int32)">
    <parameter name="array">
      <attribute ctor="M:JetBrains.Annotations.NotNullAttribute.#ctor" />
    </parameter>
  </member>

Because of this, Resharper grays out the annotation after manually adding it.

Wrong location in source is sometimes reported for constructor parameters

It appears that some source locations in PDB, which is used as input by FxCop to determine source locations, are wrong in VS2013 Community (observed in RTM and Update 5). As a result, reported symbols by this analyzer highlight the wrong source code line when double-clicked.

A connect bug has been submitted for this.

Backport latest fixes

Backport latest fixes from https://github.com/bkoelman/ResharperCodeContractNullability and setup MyGet feed