Home

Getting Started

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

Packages

Tests Project <PackageReference Include="MemberPeekerGenerator" Version="1.0.2" />

Live Project: <PackageReference Include="MemberPeekerCommon" Version="1.0.3" />

Add Attribute to the class to peek

MemberPeekerCommon.CanPeekAttribute.

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:

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:

Generate the code

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

Breakdown:

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

Example:

Result

Original:

Generated (Indentation to be fixed in future release):