Skip to content

huanwu/dotnet-apiport

 
 

Repository files navigation

.NET API Portability

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.

Usage

To use this tool, please refer to the documentation. For a quick introduction, check out this video on Channel 9:

A Brief Look at the .NET Portability Analyzer

Projects

Today, the repository contains the following components:

Tools

Project Description
ApiPort Console tool to access portability webservice

A Note About Expected Errors

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 - Errors

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.

Libraries

Project Description
Microsoft.Fx.Portability version Provides common types for API Port
Microsoft.Fx.Portability.MetadataReader version Implements a dependency finder based off of System.Reflection.Metadata. The library will generate DocIds that conform to these specifications.
Microsoft.Fx.Portability.Offline version Provides access to data in an offline setting so network calls are not needed
Microsoft.Fx.Portability.Reporting.Html version Provides an HTML report for ApiPort (used in offline mode)
Microsoft.Fx.Portability.Reporting.Json version Provides a JSON reporter for ApiPort (used in offline mode)

More projects are coming soon. Stay tuned!

Using this Repository

How to Engage, Contribute and Provide Feedback

Here are some ways to contribute:

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!

Related Projects

For an overview of all the .NET related projects, have a look at the .NET home repository.

License

This project is licensed under the MIT license.

About

This repo contains APIPort client tools and libraries

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • C# 98.9%
  • Other 1.1%