CleanupCodeSettings Class

Summary

Used within CleanupCodeTasks.
Assembly
Rocket.Surgery.Nuke.dll
Namespace
Temp.CleanupCode
Base Types
  • ToolSettings
graph BT Type-->Base0["ToolSettings"] Type["CleanupCodeSettings"] class Type type-node

Syntax

public class CleanupCodeSettings : ToolSettings

Attributes

Type Description
PublicAPIAttribute
ExcludeFromCodeCoverageAttribute

Constructors

Name Summary
CleanupCodeSettings()

Properties

Name Value Summary
CachesHome string
Lets you specify a custom location for the data that CleanupCode caches. By default, the %LOCALAPPDATA% directory is used, unless there are settings files, in which case the one specified there is used. This parameter can be helpful if you want to use a fast SSD disk for the cache or if you want to store all your build processing data in a single place.
CustomLogger Action<OutputType, string>
DisableSettingsLayers IReadOnlyList<CleanupCodeSettingsLayers>
Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
DotNetPath string
.NET Core path. Empty to ignore .NET Core. Not specified for autodetect. Example: --dotnetcore=/usr/local/share/dotnet/dotnet.
Exclude IReadOnlyList<string>
relative path(s) that define the files to exclude during the cleanup.
Extensions IReadOnlyList<string>
Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
Include IReadOnlyList<string>
relative path(s) that define the files to include during the cleanup.
MonoPath string
Mono path. Empty to ignore Mono. Not specified for autodetect. Example: --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono.
NoBuiltinSettings Nullable<bool>
Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
Profile string
Specifies an additional .DotSettings file used for inspection settings.
Project string
Allows analyzing particular project(s) instead of the whole solution. After this parameter, you can type a project name or a wildcard that matches several projects within your solution. For example, --project=*Billing
Properties IReadOnlyDictionary<string, string>
Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
TargetPath string
Target path.
ToolPath string
Path to the CleanupCode executable.
Toolset CleanupCodeMSBuildToolset
Explicitly specified MsBuild Toolset version (12.0, 14.0, 15.0). For example, --toolset=12.0.

Methods

Name Value Summary
ConfigureArguments(Arguments) Arguments

Extension Methods

Name Value Summary
AddDisableSettingsLayers(CleanupCodeSettingsLayers[]) CleanupCodeSettings

Adds values to

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
AddDisableSettingsLayers(IEnumerable<CleanupCodeSettingsLayers>) CleanupCodeSettings

Adds values to

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
AddExclude(IEnumerable<string>) CleanupCodeSettings

Adds values to

relative path(s) that define the files to exclude during the cleanup.
AddExclude(string[]) CleanupCodeSettings

Adds values to

relative path(s) that define the files to exclude during the cleanup.
AddExtensions(IEnumerable<string>) CleanupCodeSettings

Adds values to

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
AddExtensions(string[]) CleanupCodeSettings

Adds values to

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
AddInclude(IEnumerable<string>) CleanupCodeSettings

Adds values to

relative path(s) that define the files to include during the cleanup.
AddInclude(string[]) CleanupCodeSettings

Adds values to

relative path(s) that define the files to include during the cleanup.
AddProperty(string, string) CleanupCodeSettings

Adds a new key-value-pair

Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
ClearDisableSettingsLayers() CleanupCodeSettings

Clears

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
ClearExclude() CleanupCodeSettings

Clears

relative path(s) that define the files to exclude during the cleanup.
ClearExtensions() CleanupCodeSettings

Clears

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
ClearInclude() CleanupCodeSettings

Clears

relative path(s) that define the files to include during the cleanup.
ClearProperties() CleanupCodeSettings

Clears

Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
DisableNoBuiltinSettings() CleanupCodeSettings

Disables

Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
EnableNoBuiltinSettings() CleanupCodeSettings

Enables

Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
RemoveDisableSettingsLayers(CleanupCodeSettingsLayers[]) CleanupCodeSettings

Removes values from

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
RemoveDisableSettingsLayers(IEnumerable<CleanupCodeSettingsLayers>) CleanupCodeSettings

Removes values from

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
RemoveExclude(IEnumerable<string>) CleanupCodeSettings

Removes values from

relative path(s) that define the files to exclude during the cleanup.
RemoveExclude(string[]) CleanupCodeSettings

Removes values from

relative path(s) that define the files to exclude during the cleanup.
RemoveExtensions(IEnumerable<string>) CleanupCodeSettings

Removes values from

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
RemoveExtensions(string[]) CleanupCodeSettings

Removes values from

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
RemoveInclude(IEnumerable<string>) CleanupCodeSettings

Removes values from

relative path(s) that define the files to include during the cleanup.
RemoveInclude(string[]) CleanupCodeSettings

Removes values from

relative path(s) that define the files to include during the cleanup.
RemoveProperty(string) CleanupCodeSettings

Removes a key-value-pair from

Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
ResetCachesHome() CleanupCodeSettings

Resets

Lets you specify a custom location for the data that CleanupCode caches. By default, the %LOCALAPPDATA% directory is used, unless there are settings files, in which case the one specified there is used. This parameter can be helpful if you want to use a fast SSD disk for the cache or if you want to store all your build processing data in a single place.
ResetDotNetPath() CleanupCodeSettings

Resets

.NET Core path. Empty to ignore .NET Core. Not specified for autodetect. Example: --dotnetcore=/usr/local/share/dotnet/dotnet.
ResetMonoPath() CleanupCodeSettings

Resets

Mono path. Empty to ignore Mono. Not specified for autodetect. Example: --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono.
ResetNoBuiltinSettings() CleanupCodeSettings

Resets

Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
ResetProfile() CleanupCodeSettings

Resets

Specifies an additional .DotSettings file used for inspection settings.
ResetProject() CleanupCodeSettings

Resets

Allows analyzing particular project(s) instead of the whole solution. After this parameter, you can type a project name or a wildcard that matches several projects within your solution. For example, --project=*Billing
ResetTargetPath() CleanupCodeSettings

Resets

Target path.
ResetToolset() CleanupCodeSettings

Resets

Explicitly specified MsBuild Toolset version (12.0, 14.0, 15.0). For example, --toolset=12.0.
SetBackingValue<CleanupCodeSettings, TV>(Expression<Func<CleanupCodeSettings, TV>>, TV) T
Sets the backing value.
SetCachesHome(string) CleanupCodeSettings

Sets

Lets you specify a custom location for the data that CleanupCode caches. By default, the %LOCALAPPDATA% directory is used, unless there are settings files, in which case the one specified there is used. This parameter can be helpful if you want to use a fast SSD disk for the cache or if you want to store all your build processing data in a single place.
SetDisableSettingsLayers(CleanupCodeSettingsLayers[]) CleanupCodeSettings

Sets to a new list

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
SetDisableSettingsLayers(IEnumerable<CleanupCodeSettingsLayers>) CleanupCodeSettings

Sets to a new list

Disables specified settings layers. Accepted values: GlobalAll, GlobalPerProduct, SolutionShared, SolutionPersonal.
SetDotNetPath(string) CleanupCodeSettings

Sets

.NET Core path. Empty to ignore .NET Core. Not specified for autodetect. Example: --dotnetcore=/usr/local/share/dotnet/dotnet.
SetExclude(IEnumerable<string>) CleanupCodeSettings

Sets to a new list

relative path(s) that define the files to exclude during the cleanup.
SetExclude(string[]) CleanupCodeSettings

Sets to a new list

relative path(s) that define the files to exclude during the cleanup.
SetExtensions(IEnumerable<string>) CleanupCodeSettings

Sets to a new list

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
SetExtensions(string[]) CleanupCodeSettings

Sets to a new list

Allows using ReSharper extensions that affect code analysis. To use an extension, specify its ID, which you can find by opening the extension package page in the ReSharper Gallery, and then the Package Statistics page. Multiple values are separated with the semicolon.
SetInclude(IEnumerable<string>) CleanupCodeSettings

Sets to a new list

relative path(s) that define the files to include during the cleanup.
SetInclude(string[]) CleanupCodeSettings

Sets to a new list

relative path(s) that define the files to include during the cleanup.
SetMonoPath(string) CleanupCodeSettings

Sets

Mono path. Empty to ignore Mono. Not specified for autodetect. Example: --mono=/Library/Frameworks/Mono.framework/Versions/Current/bin/mono.
SetNoBuiltinSettings(Nullable<bool>) CleanupCodeSettings

Sets

Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
SetProfile(string) CleanupCodeSettings

Sets

Specifies an additional .DotSettings file used for inspection settings.
SetProject(string) CleanupCodeSettings

Sets

Allows analyzing particular project(s) instead of the whole solution. After this parameter, you can type a project name or a wildcard that matches several projects within your solution. For example, --project=*Billing
SetProperties(IDictionary<string, string>) CleanupCodeSettings

Sets to a new dictionary

Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
SetProperty(string, string) CleanupCodeSettings

Sets a key-value-pair in

Lets you override MSBuild properties. The specified properties are applied to all analyzed projects. Currently, there is no direct way to set a property to a specific project only. The workaround is to create a custom property in this project and assign it to the desired property, then use the custom property in dupFinder parameters.
SetTargetPath(string) CleanupCodeSettings

Sets

Target path.
SetToolset(CleanupCodeMSBuildToolset) CleanupCodeSettings

Sets

Explicitly specified MsBuild Toolset version (12.0, 14.0, 15.0). For example, --toolset=12.0.
ToggleNoBuiltinSettings() CleanupCodeSettings

Toggles

Suppresses global, solution and project settings profile usage. Equivalent to using --disable-settings-layers: GlobalAll; GlobalPerProduct; SolutionShared; SolutionPersonal; ProjectShared; ProjectPersonal
With<CleanupCodeSettings, TKey, TField>(Dictionary<TKey, TField>, IDictionary<TKey, TField>) TBuilder
Adds the specified dictionary to the provided dictionary.