https://github.com/tunnelvisionlabs/ReferenceAssemblyAnnotator

IL weaver to add nullability annotations to .NET reference assemblies
https://github.com/tunnelvisionlabs/ReferenceAssemblyAnnotator

Last synced: 5 days ago
JSON representation

IL weaver to add nullability annotations to .NET reference assemblies

• Host: GitHub
• URL: https://github.com/tunnelvisionlabs/ReferenceAssemblyAnnotator
• Owner: tunnelvisionlabs
• License: mit
• Created: 2019-08-22T03:59:33.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-11-21T23:08:03.000Z (almost 3 years ago)
• Last Synced: 2024-08-02T16:53:33.466Z (3 months ago)
• Language: C#
• Size: 159 KB
• Stars: 71
• Watchers: 6
• Forks: 8
• Open Issues: 16
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Reference Assembly Annotator

IL weaver for adding nullability annotations to .NET Framework, .NET Standard, and .NET Core reference assemblies.

[![Build status](https://ci.appveyor.com/api/projects/status/pikrerggo7mi7dy5/branch/master?svg=true)](https://ci.appveyor.com/project/sharwell/referenceassemblyannotator/branch/master)

[![codecov](https://codecov.io/gh/tunnelvisionlabs/ReferenceAssemblyAnnotator/branch/master/graph/badge.svg)](https://codecov.io/gh/tunnelvisionlabs/ReferenceAssemblyAnnotator)

[![Join the chat at https://gitter.im/tunnelvisionlabs/ReferenceAssemblyAnnotator](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tunnelvisionlabs/ReferenceAssemblyAnnotator?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Requirements

* Build: C# compiler version 3.2 Beta 2 or newer (ships with Visual Studio 2019 version 16.3 Preview 2 and newer). Older

  versions of the compiler interpret nullable metadata differently, which can lead to incorrect build warnings.

* Editing experience: Visual Studio 2019 version 16.3 Preview 2 or newer.

## Usage

### Assemblies included by default

* .NET Framework targets

    * mscorlib

    * System

    * System.Core

    * System.Data

    * System.Drawing

    * System.IO.Compression.FileSystem

    * System.Numerics

    * System.Runtime.Serialization

    * System.Xml

    * System.Xml.Linq

* .NET Standard targets

    * All assemblies which are defined by the .NET Standard

* .NET Core targets

    * All reference assemblies defined by .NET Core

### Example configuration

```xml

  

  

  

  

  

  

```

Minimal:

```xml

  

  

```

### Configuration reference

* MSBuild properties

    * ``: Specifies the version of Microsoft.NETCore.App.Ref to obtain nullability information from. This is required if there are multiple PackageDownload versions of Microsoft.NETCore.App.Ref.

    * ``: Set to `True` to include definitions of nullability attributes in the build; otherwise, `False` to exclude the definitions. The default value is `True`.

* MSBuild items

    * ``: Specifies reference assemblies to annotate. This is only required for assemblies that are not automatically annotated by this package.

## Releases

[![NuGet](https://img.shields.io/nuget/v/TunnelVisionLabs.ReferenceAssemblyAnnotator.svg)](https://www.nuget.org/packages/TunnelVisionLabs.ReferenceAssemblyAnnotator) [![NuGet Beta](https://img.shields.io/nuget/vpre/TunnelVisionLabs.ReferenceAssemblyAnnotator.svg)](https://www.nuget.org/packages/TunnelVisionLabs.ReferenceAssemblyAnnotator/absoluteLatest)

* [Binaries (NuGet)](https://www.nuget.org/packages/TunnelVisionLabs.ReferenceAssemblyAnnotator)

* [Release Notes](https://github.com/tunnelvisionlabs/ReferenceAssemblyAnnotator/releases)

* [License](https://github.com/tunnelvisionlabs/ReferenceAssemblyAnnotator/blob/master/LICENSE)