This repository contains the source code for .NET Portability Analyzer tools and dependencies.
For a quick introduction, check out this video on Channel 9:
- Install Visual Studio 2017 with .NET Core Workload
- Building:
- Visual Studio:
PortabilityTools.sln - Powershell:
build.ps1 -Configuration Debug -Platform AnyCPU
- Visual Studio:
- Install .NET Core SDK
- Execute:
build.sh - Go to:
bin/Debug/ApiPort/netcoreapp1.0 - Run ApiPort by executing:
dotnet ApiPort.dll
- Example:
dotnet ApiPort.dll listTargets - Example:
dotnet ApiPort.dll analyze -f Foo.dll -r HTML
- Introduction
- Platform Portability
- Breaking Changes
- .NET Portability Analyzer (Console application)
- .NET Portability Analyzer (Visual Studio extension)
| Project | Description |
|---|---|
| ApiPort | Console tool to access portability webservice |
| ApiPort.Core | Cross-platform .NET Core application |
| ApiPort.Vsix | Visual Studio Extension |
| Microsoft.Fx.Portability | Provides common types for API Port |
| Microsoft.Fx.Portability.MetadataReader | Implements a dependency finder based off of System.Reflection.Metadata. The library will generate DocIds that conform to these specifications. |
| Microsoft.Fx.Portability.Offline | Provides access to data in an offline setting so network calls are not needed |
| Microsoft.Fx.Portability.Reporting.Html | Provides an HTML report for ApiPort (used in offline mode) |
| Microsoft.Fx.Portability.Reporting.Json | Provides a JSON reporter for ApiPort (used in offline mode) |
The libraries are continuously published to dotnet-apiport MyGet gallery. The Visual Studio extension is published to Open VSIX Gallery. The latest version number of each library can be seen in that gallery.
Here are some ways to contribute:
- Update/Add recommended changes
- Try things out!
- File issues
- Join in design conversations
Want to get more familiar with what's going on in the code?
Looking for something to work on? The list of up-for-grabs issues is a great place to start.
We're re-using the same contributing approach as .NET Core. You can check out the .NET Core contributing guide at the corefx repo wiki for more details.
You are also encouraged to start a discussion on the .NET Foundation forums!
For an overview of all the .NET related projects, have a look at the .NET home repository.
This project is licensed under the MIT license.