BlackFox.Fake.BuildTask
0.1.3
.NET Standard 2.0
This package targets .NET Standard 2.0. The package is compatible with this framework or higher.
.NET Framework 4.6
This package targets .NET Framework 4.6. The package is compatible with this framework or higher.
dotnet add package BlackFox.Fake.BuildTask --version 0.1.3
NuGet\Install-Package BlackFox.Fake.BuildTask -Version 0.1.3
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="BlackFox.Fake.BuildTask" Version="0.1.3" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add BlackFox.Fake.BuildTask --version 0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BlackFox.Fake.BuildTask, 0.1.3"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install BlackFox.Fake.BuildTask as a Cake Addin #addin nuget:?package=BlackFox.Fake.BuildTask&version=0.1.3 // Install BlackFox.Fake.BuildTask as a Cake Tool #tool nuget:?package=BlackFox.Fake.BuildTask&version=0.1.3
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
open BlackFox.Fake
// A task with no dependencies
let paketRestore = BuildTask.create "PaketRestore" [] {
// ...
}
// A task that need the restore to be done and should run after Clean
// if it is in the build chain
let build = BuildTask.create "Build" [clean.IfNeeded; paketRestore] {
// ...
}
// A task without any action, only dependencies here specifying what should
// run in CI
let _ci = BuildTask.createEmpty "CI" [clean; build]
RunTaskOrDefault build
API
module BlackFox.Fake.BuildTask
/// What FAKE name a target
type TaskMetadata = {
Name: string
Dependencies: TaskInfo list
}
/// Dependency (Soft or Hard) to a target (That can be a null object)
type TaskInfo = {
Metadata: TaskMetadata option
IsSoft: bool
}
with
static member NoTask
member this.Always with get()
member this.IfNeeded with get()
member this.If(condition: bool)
/// Define a Task with it's dependencies
let createFn (name: string) (dependencies: TaskInfo list) (body: TargetParameter -> unit): TaskInfo
/// Define a Task with it's dependencies
let create (name: string) (dependencies: TaskInfo list): TaskBuilder
/// Define a Task without any body, only dependencies
let createEmpty (name: string) (dependencies: TaskInfo list): TaskInfo
/// Run the task specified on the command line if there was one or the
/// default one otherwise.
let runOrDefault (defaultTask: TaskInfo): unit
/// Run the task specified on the command line if there was one or the
/// default one otherwise.
let runOrDefaultWithArguments (defaultTask: TaskInfo): unit
/// Runs the task given by the target parameter or lists the available targets
let runOrList (): unit
/// List all tasks available.
let listAvailable (): unit
/// Writes a dependency graph.
let printDependencyGraph (verbose: bool) (taskInfo: TaskInfo): unit
/// Setup the FAKE context from a program argument
///
/// Arguments are the same as the ones comming after "run" when running via FAKE.
/// The only difference is that "--target" is apended if the first argument doesn't start with "-".
///
/// Examples:
///
/// * `foo` -> `run --target foo`
/// * `--target bar --baz` -> `run --target bar --baz`
let setupContextFromArgv (argv: string []): unit
/// Run the task specified on the command line if there was one or the
/// default one otherwise. Return 0 on success and 1 on error, printing
/// the exception on the console.
let runOrDefaultApp (defaultTask: TaskInfo): int
/// Runs the task given by the target parameter or lists the available targets.
/// Return 0 on success and 1 on error, printing the exception on the console.
let runOrListApp (): int
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 was computed. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net46 is compatible. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETFramework 4.6
- Fake.Core.Target (>= 5.1.0)
- FSharp.Core (>= 4.3.4)
-
.NETStandard 2.0
- Fake.Core.Target (>= 5.1.0)
- FSharp.Core (>= 4.3.4)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Add `runOrDefaultApp` and `runOrListApp` to use FAKE directly with `dotnet run` and still print the exception nicely
colored and return a stable error code.
Add an icon (orange version of FAKE one)