BlackFox.Fake.BuildTask 0.1.3

Typed `Target` for FAKE 5

Install-Package BlackFox.Fake.BuildTask -Version 0.1.3
dotnet add package BlackFox.Fake.BuildTask --version 0.1.3
<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, C# scripting and .NET Interactive. 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
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

Release Notes

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)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
0.1.3 29,292 9/11/2018
0.1.2 456 9/2/2018
0.1.0 453 8/16/2018