StyleCopSettingsExtensions Class

Summary

Extensions that enable a fluent interface onto the StyleCopSettings type.
Assembly
Cake.StyleCop.dll
Namespace
Cake.Stylecop
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["StyleCopSettingsExtensions"] class Type type-node

Syntax

public static class StyleCopSettingsExtensions

Methods

Name Value Summary
AddResultFiles(StyleCopReportSettings, FilePathCollection) StyleCopReportSettings
Allows multiple results files to be aggregated into a single report output.
static
LoadFromDefaultPath(StyleCopSettings, bool) StyleCopSettings
Indicates if Stylecop should load addins from the same directory as stylecop.dll.
static
ToHtmlReport(StyleCopReportSettings, FilePath, FilePath) StyleCopReportSettings
Indicates the results should be outputted as an HTML report.
static
ToHtmlReport(StyleCopSettings, FilePath, FilePath) StyleCopSettings
Indicates the results should be outputted as an HTML report.
static
ToResultFile(StyleCopSettings, FilePath) StyleCopSettings
Indicates the filepath to output the stylecop results to.
static
UsingResultCache(StyleCopSettings, bool, bool) StyleCopSettings
Use the stylecop result cache to speed up analysis.
static
WithAddins(StyleCopSettings, DirectoryPath[]) StyleCopSettings
Specifies which directories to load Stylecop addins from. If none are specified and LoadFromDefaultPath is true all .dll files next to the stylecop.dll file will be added as potential addins.
static
WithSettings(StyleCopSettings, FilePath) StyleCopSettings
Specifies the Stylecop.settings file path.
static
WithSolution(StyleCopSettings, FilePath) StyleCopSettings
Specifies the .net solution to analyse.
static

Extension Methods

Name Value Summary
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin