Reguła Roslyn Analyzer nie zawiedzie kompilacji

Question

Po wykonaniu z this samouczka z MS, stworzyłem analizator dla Roslyn.

Według stronie można zaznaczyć regułę jako DiagnosticSeverity.Error, a to spowoduje, że build złamać:

In the line declaring the Rule field, you can also update the severity of the diagnostics you’ll be producing to be errors rather than warnings. If the regex string doesn’t parse, the Match method will definitely throw an exception at run time, and you should block the build as you would for a C# compiler error. Change the rule’s severity to DiagnosticSeverity.Error:

internal static DiagnosticDescriptor Rule = new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category, DiagnosticSeverity.Error, isEnabledByDefault: true, description: Description);

W moim kodu, mam utworzeniu reguły mniej lub bardziej jak opisano tutaj:

private static readonly DiagnosticDescriptor Rule = 
    new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category, 
    DiagnosticSeverity.Error, true, helpLinkUri: HelpUrl); 

Ta zasada działa poprawnie. Podnosi czerwone linie, wyświetla komunikat na liście błędów. Jednak kompilacja się udaje i mogę z powodzeniem uruchomić aplikację.

NB: Utworzona reguła służy do przechwytywania Thread.Sleep dla tego przykładu.

Czy istnieje dodatkowa konfiguracja wymagana do zapewnienia reguła łamie budować?

Answer 1

Jest to funkcja analizatorów działających z pliku VSIX.

If the IDE-installed rules ran as part of the in-IDE build, it would result in IDE builds and command line builds having potentially very different outputs. For example, a user with code-cracker installed as a VSIX could end up filing a bug report that an open source project does not build due to an analyzer error (or perhaps a warning when the project uses /warnaserror). They would be forced to either uninstall the analyzer extension or modify the rule set used by the project to disable some rule that only exists on one developer's machine.

In contrast, rules that are installed via NuGet become part of the project and part of the build. They run the same way across developer machines, and they run the same way in-IDE, on the command line, and in automated build environments.

Source: IDE rules don't fail builds

Aby kompilacja nie do reguł, trzeba dodać analizator jako pakiet Nuget do projektu. Zapewni to, że awarie spowodują awarię kompilacji zgodnie z oczekiwaniami.