FAKE - F# Make - A DSL for build tasks and more FAKE
6.1.3

Lookig for older versions of the documentation, pre FAKE v6? See 

v5.fake.build

FxCop.Params Type

Parameter type for the FxCop tool

Record fields

Record Field Description

ApplyOutXsl

Full Usage: ApplyOutXsl

Field type: bool

Apply the XSL style sheet to the output. Default false.

Field type: bool

ConsoleXslFileName

Full Usage: ConsoleXslFileName

Field type: string

Apply specified XSL to console output. Default empty.

Field type: string

CustomDictionary

Full Usage: CustomDictionary

Field type: string

Custom dictionary used by spelling rules. Default empty.

Field type: string

CustomRuleset

Full Usage: CustomRuleset

Field type: string

Rule set to be used for the analysis. It can be a file path to the rule set file or the file name of a built-in rule set. + enables all rules in the rule set; - disables all rules in the rule set; = sets rules to match the rule set and disables all rules that are not enabled in the rule set. Default empty.

Field type: string

DependencyDirectories

Full Usage: DependencyDirectories

Field type: seq<string>

Locations to search for assembly dependencies. Default empty.

Field type: seq<string>

DirectOutputToConsole

Full Usage: DirectOutputToConsole

Field type: bool

Output messages to console, including file and line number information. Default true.

Field type: bool

FailOnError

Full Usage: FailOnError

Field type: ErrorLevel

The error level that will cause a build failure. Default ontFailBuild.

Field type: ErrorLevel

ForceOutput

Full Usage: ForceOutput

Field type: bool

Write output XML and project files even in the case where no violations occurred. Default false.

Field type: bool

IgnoreGeneratedCode

Full Usage: IgnoreGeneratedCode

Field type: bool

Suppress analysis results against generated code. Default false.

Field type: bool

ImportFiles

Full Usage: ImportFiles

Field type: seq<string>

Import XML report(s) or FxCop project file(s). Default empty.

Field type: seq<string>

IncludeSummaryReport

Full Usage: IncludeSummaryReport

Field type: bool

Display summary after analysis. Default true.

Field type: bool

OutputXslFileName

Full Usage: OutputXslFileName

Field type: string

Reference the specified XSL in the XML report file or none to generate an XML report with no XSL style sheet. Default empty.

Field type: string

PlatformDirectory

Full Usage: PlatformDirectory

Field type: string

Location of platform assemblies. Default empty.

Field type: string

ProjectFile

Full Usage: ProjectFile

Field type: string

Project file to load. Default empty.

Field type: string

ReportFileName

Full Usage: ReportFileName

Field type: string

FxCop project or XML report output file. Default FXCopResults.html in the current working directory

Field type: string

RuleLibraries

Full Usage: RuleLibraries

Field type: seq<string>

Directory containing rule assemblies or path to rule assembly. Enables all rules. Default empty.

Field type: seq<string>

Rules

Full Usage: Rules

Field type: seq<string>

Namespace and CheckId strings that identify a Rule. + enables the rule; - disables the rule. Default empty.

Field type: seq<string>

SaveResultsInProjectFile

Full Usage: SaveResultsInProjectFile

Field type: bool

Update the project file if there are any changes. Default false.

Field type: bool

ToolPath

Full Usage: ToolPath

Field type: string

Path to the FxCop executable. Default = %VSINSTALLDIR%/Team Tools/Static Analysis Tools/FxCop/FxCopCmd.exe where %VSINSTALLDIR% is a Visual Stdio 2017 installation location derived from the registry

Field type: string

Types

Full Usage: Types

Field type: seq<string>

Analyze only these types and members. Default empty

Field type: seq<string>

UseGAC

Full Usage: UseGAC

Field type: bool

Search Global Assembly Cache for missing references. Default false.

Field type: bool

Verbose

Full Usage: Verbose

Field type: bool

Give verbose output during analysis. Default true.

Field type: bool

WorkingDirectory

Full Usage: WorkingDirectory

Field type: string

Working directory for relative file paths. Default is the current working directory

Field type: string

Static members

Static member Description

Params.Create()

Full Usage: Params.Create()

Returns: Params

FxCop Default parameters, values as above

Returns: Params