Roslyn 分析器规则不会使构建失败
Roslyn Analyzer Rule does not fail the build
根据 MS 的 this 教程,我为 Roslyn 创建了一个分析器。
根据页面,您可以将规则标记为 DiagnosticSeverity.Error
,这将导致构建中断:
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);
在我的代码中,我或多或少地创建了如下详述的规则:
private static readonly DiagnosticDescriptor Rule =
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category,
DiagnosticSeverity.Error, true, helpLinkUri: HelpUrl);
这条规则工作正常。它抛出红线,在错误列表中显示消息。但是,构建成功了,我能够成功 运行 应用程序。
注意: 我创建了此规则来捕获此示例的 Thread.Sleep
。
是否需要额外的设置来确保规则破坏构建?
这是来自 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
为了使规则的构建失败,您需要将分析器作为nuget包添加到项目中。这将确保失败将导致构建按预期失败。
根据 MS 的 this 教程,我为 Roslyn 创建了一个分析器。
根据页面,您可以将规则标记为 DiagnosticSeverity.Error
,这将导致构建中断:
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);
在我的代码中,我或多或少地创建了如下详述的规则:
private static readonly DiagnosticDescriptor Rule =
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, Category,
DiagnosticSeverity.Error, true, helpLinkUri: HelpUrl);
这条规则工作正常。它抛出红线,在错误列表中显示消息。但是,构建成功了,我能够成功 运行 应用程序。
注意: 我创建了此规则来捕获此示例的 Thread.Sleep
。
是否需要额外的设置来确保规则破坏构建?
这是来自 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
为了使规则的构建失败,您需要将分析器作为nuget包添加到项目中。这将确保失败将导致构建按预期失败。