CakeLicenseHeaderUpdaterSettings Class

Summary

Configuration for updating the license headers in various projects.
Assembly
Cake.LicenseHeaderUpdater.dll
Namespace
Cake.LicenseHeaderUpdater
Base Types
  • Object
graph BT Type-->Base0["Object"] Type["CakeLicenseHeaderUpdaterSettings"] class Type type-node

Syntax

public class CakeLicenseHeaderUpdaterSettings

Constructors

Name Summary
CakeLicenseHeaderUpdaterSettings()

Properties

Name Value Summary
DryRun bool
Set to true to perform a dry run. If set to true, this will simply print the files that will be processed, but nothing will happen otherwise. Regardless of what Verbosity is set to, this will print out what files are being processed even if Verbosity is set to Quiet.
FileFilter Func<FilePath, bool>
Override this to filter files to process. The function passes in a FilePath, and if we should add a header to the top of this file, have this function return true, otherwise have it return false. If this is set to null, it will process ALL files.
LicenseString string
The license string to add to the top of all the files. If this configuration is null or empty, then all matches in OldHeaderRegexPatterns will be purged, but nothing will be added to the top of the file.
OldHeaderRegexPatterns IList<string>
If there are any "old" licenses that should be removed, add them to this list. All matches in each file will be removed. If left empty, then it is possible for a file to contain an old license and a new license header, with the newer license at the top. Nulls or empty strings added to this list are purged before running.
Threads int
The number of threads to spawn to process files. If this is set to 0 or less, then the number of threads will be equal to System.Environment.ProcessorCount. Defaulted to 1.
Verbosity Verbosity
How verbose should the print-outs to stdout be? Defaulted to Normal. Quiet - Nothing. Minimal - When it starts to process a file. Normal - Everything lower and when it skips a file because FileFilter returned false. Verbose - Everything lower and when it finishes processing a file. Diagnostic - Everything lower and what changes it makes to the files.

Extension Methods

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