This repository contains the source code for .NET Portability Analyzer tools and dependencies. This is a work in progress, and does not currently contain all of the components that we plan on open sourcing. Make sure to watch this repository in order to be notified as we make changes to and expand it.
To use this tool, please refer to the documentation.
Today, the repository contains the following components:
| Project | Description |
|---|---|
| ApiPort | Console tool to access portability webservice |
The ApiPort project contains two csproj files - one for building against the desktop .NET Framework 4.5, the other for building against .NET Core. Building a .NET Core executable is still not a well-supported scenario and, as a result, building the project in Visual Studio with NuGet package restore enabled (as it is, by default) will result in errors like the following -
These errors are currently expected and do not keep the project from building successfully. Notice in the picture that the build succeeded despite the errors.
In order to suppress these false errors, disable Visual Studio's built-in package restore functionality (as described here). The packages can be restored by building or explicitly restoring packages from the command line (.tools\nuget.exe src\ApiPort\ApiPort.Core.project.json).
Restoring or building from the command line is expected to succeed without any errors.
| Project | Description |
|---|---|
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) |
More projects are coming soon. Stay tuned!
- Required Install Visual Studio 2015
- Required Windows 10 Tools 1.1 (install via the Visual Studio 2015 installer). The new style PCL format will not work without this. v3.2 of NuGet is required.
Some of the best ways to contribute are to try things out, file bugs, and 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.