NetPrints.Catalog 0.2.0

dotnet add package NetPrints.Catalog --version 0.2.0
                    
NuGet\Install-Package NetPrints.Catalog -Version 0.2.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="NetPrints.Catalog" Version="0.2.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="NetPrints.Catalog" Version="0.2.0" />
                    
Directory.Packages.props
<PackageReference Include="NetPrints.Catalog" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add NetPrints.Catalog --version 0.2.0
                    
#r "nuget: NetPrints.Catalog, 0.2.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package NetPrints.Catalog@0.2.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=NetPrints.Catalog&version=0.2.0
                    
Install as a Cake Addin
#tool nuget:?package=NetPrints.Catalog&version=0.2.0
                    
Install as a Cake Tool

NetPrints.Catalog

Type catalog engine and reader for the NetPrints node editor.

This package provides APIs for building, reading and loading type catalogs (*.npcat.json files). A type catalog describes the public surface of one or more assemblies: the types, their constructors, methods, properties and fields, the parameters and return types, and XML documentation summaries. A catalog describes an assembly's surface without loading it, and the NetPrints editor uses it in place of live enumeration for the assemblies it covers. Code that uses a library is still compiled against the real assembly, so the project must reference it.

Command-line tool

The netprints catalog command (part of NetPrints.Cli) builds catalogs from assemblies, NuGet packages or project references:

netprints catalog --assembly libs/MyLib.dll --output catalogs/mylib.npcat.json
netprints catalog --package Newtonsoft.Json@13.0.3 --exclude "*.Internal.*"
netprints catalog --assembly libs/MyLib.dll --format csharp --class-name MyLibCatalog --namespace MyCompany --output MyLibCatalog.g.cs

See the CLI guide for full documentation.

Loading catalogs

Use CatalogLoader to read catalogs from files or from assemblies that embed them:

// Load from a file
var catalog = CatalogLoader.LoadFile("mylib.npcat.json");

// Load embedded catalogs from a referenced assembly
var embedded = CatalogLoader.LoadEmbedded(typeof(MyClass).Assembly);

// Load from JSON string
var fromJson = CatalogLoader.LoadJson(jsonString);

Profiles

A profile controls which types and members a catalog includes:

  • public-api — every public type and member (the default).
  • annotated — only types and members marked with [NetPrintsType] and [NetPrintsNode] from NetPrints.Annotations.

Custom profiles are JSON files (.npprofile.json) that define inclusion and exclusion rules.

See also

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.2.0 0 10/1/2026