dotnet-inspect

Inspect .NET libraries for types, members, and version differences.

18|3|Updated Jul 3, 2020

Search Tags:#api #libraries #dotnet #nuget #inspection #version-diff

Ready to run

npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill dotnet-inspect-jguadagno

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: dotnet-inspect
Source: https://github.com/jguadagno/jjgnet-broadcast/tree/main/.agents/skills/dotnet-inspect
Command: npx skills add https://github.com/jguadagno/jjgnet-broadcast --skill dotnet-inspect-jguadagno

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill enables developers and technical users to quickly query and inspect .NET libraries, NuGet packages, and local DLLs to understand their types, methods, and API surfaces, thereby streamlining library exploration and debugging.

Core Features & Use Cases

Type Discovery: Find and list types within NuGet packages or local assemblies.
API Inspection: Retrieve detailed information about members, constructors, and overloads.
Version Comparison: Detect breaking and additive changes between different .NET package versions.
Use Case: When upgrading a NuGet package, use this Skill to examine differences in API surfaces and identify breaking changes before updating your project.

Quick Start

Query the types in the Newtonsoft.Json package to see available classes and methods.

Frequently Asked Questions about dotnet-inspect

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I inspect types and methods in a .NET NuGet package?▼

You can inspect .NET NuGet packages by querying the library to list available types, members, and constructors. This allows developers to explore the API surface of external libraries directly without manually browsing source code.

Can I compare API surface differences between two versions of a .NET library?▼

Yes, you can compare API surfaces across different .NET package versions to detect breaking and additive changes. This helps identify potential issues before upgrading a NuGet dependency in your project.

What is the best way to find breaking changes when upgrading a .NET NuGet dependency?▼

The best way to find breaking changes is to perform a version comparison of the .NET library. This process highlights removed types or modified members, streamlining debugging and refactoring before you update your project.

Does API inspection work with local DLLs and specific .NET libraries like System.Text.Json?▼

Yes, API inspection works with local assemblies and NuGet packages. It requires the dotnet-inspect tool and supports dependencies like System.Text.Json or Microsoft.AspNetCore.* to analyze library contents effectively.

How do I list available classes and methods in the Newtonsoft.Json package?▼

You query the specific NuGet package to retrieve detailed information about its types, constructors, and overloads. This type discovery process reveals all available classes and methods within the specified .NET library.

What are the limitations of inspecting local .NET assemblies for API surfaces?▼

Inspecting local .NET assemblies requires the dotnet-inspect tool and specific dependencies like System.Text.Json to function. Without these required components, the API surface exploration and version diffing capabilities cannot operate.