MemberPeekerGenerator 1.0.2

dotnet add package MemberPeekerGenerator --version 1.0.2

NuGet\Install-Package MemberPeekerGenerator -Version 1.0.2

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="MemberPeekerGenerator" Version="1.0.2" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add MemberPeekerGenerator --version 1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: MemberPeekerGenerator, 1.0.2"

#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.

// Install MemberPeekerGenerator as a Cake Addin
#addin nuget:?package=MemberPeekerGenerator&version=1.0.2

// Install MemberPeekerGenerator as a Cake Tool
#tool nuget:?package=MemberPeekerGenerator&version=1.0.2

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Getting Started

THIS VERSION IS IN BETA AND IS SUBJECT TO FREQUENT CHANGES/IMPROVEMENTS

Add Attribute to the class to peek

MemberPeekerCommon.CanPeekAttribute.

Attribute

Add initialization Method

In order for the generator to add the files to peek to the compilation, it needs to generate the required MSBuild code. Add the following code to your project:

Initialization

Where:

[assembly: Xunit.TestFramework("YOUR PROJECT NAME + NAME OF THIS CLASS(.initialize in this case)", "ASSEMBLY NAME")]

Pass the assemblies of the code you want to peek in the AddToCompilation(params Assembly[] assemblies method.

Example of the generated Directory.Build.Props:

GeneratedMsBuild

Generate the code

To generate the code for ExampleClass, you will need to type: MemberPeeker.ExampleClass_Exposed<ExampleClass>(...Constructor Parameters of ExampleClass)

Breakdown:

MemberPeeker is the namespace required by this generator to access the generated code.
"CLASS NAME"_Exposed the _Exposed part is required.
<YOUR CLASS> the type parameter is used by the generator to identify the type

Example: TestExample