Skip to content

chore: Add AnalyzerLoadFailed event handler logics to report warning #10617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 9, 2025
+22 −1
Merged

chore: Add AnalyzerLoadFailed event handler logics to report warning #10617

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/Docfx.Common/Loggers/WarningCodes.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,12 @@ public static class Build
public const string InvalidTocInclude = "InvalidTocInclude";
}

public static class Metadata
{
public const string FailedToResolveAnalyzer = "FailedToResolveAnalyzer";
public const string FailedToLoadAnalyzer = "FailedToLoadAnalyzer";
}

public static class Markdown
{
public const string InvalidInclude = "InvalidInclude";
Expand Down
17 changes: 16 additions & 1 deletion src/Docfx.Dotnet/DotnetApiCatalog.Compile.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,22 @@ await LoadCompilationFromProject(project.AbsolutePath) is { } compilation)
{
Logger.LogWarning($"There is .NET Analyzer that can't be resolved. "
+ $"If this analyzer is .NET Source Generator project. "
+ $"Try build with `dotnet build -c Release` command before running docfx. Path: {unresolvedAnalyzer.FullPath}");
+ $"Try build with `dotnet build -c Release` command before running docfx. Path: {unresolvedAnalyzer.FullPath}",
code: WarningCodes.Metadata.FailedToResolveAnalyzer);
}

foreach (var analyzer in project.AnalyzerReferences.OfType<AnalyzerFileReference>())
{
analyzer.AnalyzerLoadFailed += (sender, e) =>
{
var analyzerName = analyzer.Display;
var errorCode = e.ErrorCode;
var referencedCompilerVersion = e.ReferencedCompilerVersion;

Logger.LogWarning($"Failed to load .NET Analyzer. AnalyzerName: {analyzerName}, ErrorCode: {errorCode}, ReferencedCompilerVersion: {referencedCompilerVersion}",
code: WarningCodes.Metadata.FailedToLoadAnalyzer);
};

}
}

Expand Down