Interface IFormat

Provides targets and configuration for verifying and applying code style preferences.

Inherited Members
INukeBuild.ExecutionPlan
INukeBuild.InvokedTargets
INukeBuild.SkippedTargets
INukeBuild.ScheduledTargets
INukeBuild.RunningTargets
INukeBuild.AbortedTargets
INukeBuild.FailedTargets
INukeBuild.SucceededTargets
INukeBuild.FinishedTargets
INukeBuild.IsSucceeding
INukeBuild.IsFailing
INukeBuild.IsFinished
INukeBuild.ExitCode
INukeBuild.RootDirectory
INukeBuild.TemporaryDirectory
INukeBuild.BuildAssemblyFile
INukeBuild.BuildAssemblyDirectory
INukeBuild.BuildProjectDirectory
INukeBuild.BuildProjectFile
INukeBuild.Verbosity
INukeBuild.Host
INukeBuild.Plan
INukeBuild.Help
INukeBuild.NoLogo
INukeBuild.IsLocalBuild
INukeBuild.IsServerBuild
INukeBuild.Continue
INukeBuild.Partition
Namespace: Hexagrams.Nuke.Components
Assembly: Hexagrams.Nuke.Components.dll
Syntax
public interface IFormat : IHasSolution, INukeBuild

Properties

| Edit this page View Source

ExcludedFormatPaths

Paths to exclude from formatting and formatting verification. Paths must be relative to the build's root directory (Nuke.Common.NukeBuild.RootDirectory)

Declaration
IEnumerable<AbsolutePath> ExcludedFormatPaths { get; }
Property Value
Type Description
IEnumerable<AbsolutePath>
| Edit this page View Source

Format

Apply code style preferences using dotnet format.

Declaration
Target Format { get; }
Property Value
Type Description
Target
| Edit this page View Source

RunFormatAnalyzers

Whether to run third-party analyzers as part of formatting verification.

Declaration
bool RunFormatAnalyzers { get; }
Property Value
Type Description
bool
| Edit this page View Source

VerifyFormat

Verify code style preferences using dotnet format.

Declaration
Target VerifyFormat { get; }
Property Value
Type Description
Target

Extension Methods