juliansangillo
commented
1 year ago Update:
I have been poking around the code in the master branch and have been doing some debugging locally. I found the cause of the issue with loading the Api library. I put the plugin in its own nuget package, which means its dependencies have to be resolved by nuget, which doesn't happen when dynamically loading the plugin so the Api library can't be found. The only way to make this work is to copy the Api library to the output directory when packing the plugin, which doesn't happen by default. To fix this, I made the following changes to the plugin project:
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<DevelopmentDependency>true</DevelopmentDependency>
<SuppressDependenciesWhenPacking>true</SuppressDependenciesWhenPacking>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="DefaultDocumentation.Api" Version="0.8.2" PrivateAssets="all" GeneratePathProperty="true" />
</ItemGroup>
<ItemGroup>
<None Include="DefaultDocumentation.PluginExample.targets" Pack="true" PackagePath="build\" />
<None Include="$(PkgDefaultDocumentation_Api)\lib\netstandard2.0\DefaultDocumentation.Api.dll" Pack="true" PackagePath="lib\netstandard2.0\" />
</ItemGroup>
</Project>I will add this to a PR later to help others who run into this issue when trying to adopt the PluginExample.
Once I fixed the issue with the Api library, I ran right into the other issue where it can't find the FolderFileNameFactory. I haven't figured that out yet. It looks like issue #109 addresses something similar, but this is still happening to me.
LarsDammannCoherent
Doraku
adlerzei
a10r
Hello. Thank you for this library. This is definitely the best library I found for generating markdown docs.
I am trying to create a plugin that can be installed from NuGet and the plugin will have my own implementation of a FolderFileNameFactory like the one in your plugin example. Unfortunately I am running into some errors when building the target project. First I tried with version 0.8.2 and received an error that DefaultDocumentation.Api could not be found even though it is referenced in the NuGet plugin.
Then I tried to downgrade to 0.8.1 and I ran into a different error that it couldn't find the FileNameFactory with name 'Folder' even though it does exist.
I get the same 'Folder' not found error in version 0.8.0 as well. I don't think I can downgrade further than that since plugins were only introduced in 0.8.0.
I looked a bit into the code myself and it seems reflection is used to get the available types in the Generator class and is past into GeneralContext and its parent, Context. It seems Context is what throws that error when it can't find the FileNameFactory, so it is likely that reflection isn't finding my FolderFileNameFactory and isn't adding it to the available types like it should be. Since it is an MSBuild Task I can't debug it so I can't test this though.