SonarBeginSettings Class

Summary

Required prior to Sonar 6.1: - Name - Version Required from Sonar 6.1 - Key
Assembly
Cake.Sonar.dll
Namespace
Cake.Sonar
Base Types
graph BT Type-->Base0["SonarSettings"] click Base0 "/api/Cake.Sonar/SonarSettings" Base0-->Base1["ToolSettings"] Type["SonarBeginSettings"] class Type type-node

Syntax

public class SonarBeginSettings : SonarSettings

Constructors

Name Summary
SonarBeginSettings()

Properties

Name Value Summary
AnalysisMode string
Branch string
The name of the current branch. Specifying a branch will cause Sonar to analyse different branches as different Sonar projects. This allows one to use sonar to compare branches on a pull review.
CoverageExclusions string
Comma-delimited list of file path patterns to be excluded from coverage calculations
DotCoverIntegrationReportsPath string
DotCoverReportsPath string
DuplicationExclusions string
Comma-delimited list of file path patterns to be excluded from duplication detection
Exclusions string
Use exclusion to analyze everything but the specified files
GitHubDeleteOldComments Nullable<bool>
GitHubEndpoint string
GitHubLogin string
GitHubOAuth string
GitHubPullRequest string
GitHubRepository string
Inclusions string
Comma-delimited list of file path patterns to be included in analysis. When set, only files matching the paths set here will be included in analysis.
IssuesReportConsoleEnable Nullable<bool>
IssuesReportHtmlEnable Nullable<bool>
JavascriptCoverageReportsPath string
comma-separated list of paths to LCOV coverage report files
Key string
Key of the project. Required for Sonar 6.1 and up.
Language string
Login string
Login to use for connecting to sonar.
Inherited from SonarSettings
Name string
Name of the project. Required prior to Sonar 6.1
NCover3IntegrationReportsPath string
NCover3ReportsPath string
NDependProjectPath string
NUnitReportsPath string
NUnitReportsPathVbNet string
OpenCoverIntegrationReportsPath string
OpenCoverReportsPath string
OpenCoverReportsPathVbNet string
Organization string
Organization name for sonar cloud versions.
Password string
Password to use for connecting to sonar.
Inherited from SonarSettings
PullRequestBase string
Gets or sets the base branch in which the pull request will be merged in case of a pull request validation See https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestBranch string
Gets or sets the branch name in case of a pull request validation See https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestGithubEndpoint string
Gets or sets the github endpoint url. See: https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestGithubRepository string
Gets or sets the github repository for which the pull request should be validated. Typical github format CompanyOrUser/RepositoryName See: https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestKey Nullable<int>
Gets or sets the pullrequest key in case of a pull request validation See https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestProvider string
Gets or sets the pull request provider used by sonarcloud. github or vsts. See: https://docs.sonarqube.org/display/SONAR/Pull+Request+Analysis
PullRequestVstsEndpoint string
Gets or sets the VSTS/Azure DevOps endpoint url.
PullRequestVstsProject string
Gets or sets the VSTS/Azure DevOps project.
PullRequestVstsRepository string
Gets or sets the VSTS/Azure DevOps repository.
ResharperProjectPath string
ResharperSolutionFile string
SettingsFile string
Path to alternative SonarQube.Analysis.xml
Silent bool
Suppress standard output from the sonar runner.
Inherited from SonarSettings
TestExclusions string
Comma-delimited list of test file path patterns to be excluded from analysis.
TestInclusions string
Comma-delimited list of test file path patterns to be included in analysis. When set, only test files matching the paths set here will be included in analysis.
TestReportPaths string
TSLintReportPaths string
This property accepts one or more JSON TSLint reports, paths to report files should be absolute or relative to the project base directory.
TypescriptCoverageReportsPath string
comma-separated list of paths to LCOV coverage report files
Url string
The url of the used sonar instance. When omitted, http://localhost:9000 is used.
UseCoreClr bool
Use .NET Core version of the SonarQube scanner in case of a .NET Core build.
Inherited from SonarSettings
UseWsCache Nullable<bool>
Verbose bool
Print verbose output during the analysis.
Version string
A version indicator, e.g. a semantic version or git revision hash. Required prior to Sonar 6.1
VersionResult VersionResult
VsCoverageIntegrationReportsPath string
VsCoverageReportsPath string
VsTestReportsPath string
XUnitReportsPath string

Methods

Extension Methods

Name Value Summary
Dump<SonarBeginSettings>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<SonarBeginSettings>(SonarBeginSettings[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<SonarBeginSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<SonarBeginSettings>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<SonarBeginSettings>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<SonarBeginSettings>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin