• Removed CommandConfiguration struct (#124)

Commands struct gained the use(_:as:) method previously on CommandConfiguration.

• Allow checking to see if an Optional is present in command call (#125)
• Enabled test discovery on Linux (#127))

• CommandError is now an enum. (#122)
• ConsoleLogger now stores the logging bootstrap's label during creation. (#123)

Notes: This change allows ConsoleLogger to print the label used for its creation when at .trace log level.

Maybe You Meant 'Beta'?

No, this isn't supposed to be a beta release; but we do have suggestions! Command suggestions at that! If pass in a command that doesn't exist, ConsoleKit will automatically check to see if there are any commands with a similar name and suggest that maybe you meant one of them instead.

A big thanks to @tkrajacic for implementing this feature!

• Added projectedValue to @Argument, @Option, and @Flag property wrappers. (#118)

Notes: This allows for the property wrapper backing for these signature arguments to be accessed from the command. To access, prefix the argument name with $.

• Command signatures are now declared using property wrappers (#116, #115)

Here's an example command signature using the new API:

struct Cowsay: Command {
    struct Signature: CommandSignature {
        @Argument(name: "message", help: "What the cow should say") 
        var message: String

        @Option(name: "eyes", short: "e", help: "Change the cow's eyes")
        var eyes: String?

        @Option(name: "tongue", short: "t", help: "Change the cow's tongue")
        var tongue: String?

        @Flag(name: "borg", help: "uses == for cow's eyes")
        var borg: Bool

        init() { }
    }

    let help = "Prints an ASCII cow with a message"

    func run(context: CommandContext, signature: Signature) throws {
        print(signature.message) // String
        print(signature.eyes) // String?
        print(signature.tongue) // String?
        print(signature.borg) // Bool
    }
}

• New type-erased protocols for Command and Group allow for dynamic commands to be implemented (#115, #113)

struct DynamicCommand: AnyCommand {
    var help: String = ""

    func run(using context: inout CommandContext) throws {
        XCTAssertEqual(context.input.arguments, ["true", "--count", "42"])
    }
}

More information on Vapor 4 alpha releases:

https://medium.com/@codevapor/vapor-4-alpha-1-releases-begin-94a4bc79dd9a

API Docs:

https://api.vapor.codes/console-kit/master/ConsoleKit/index.html

Fixed

• Only extract a short flag if the raw flag string is -<short> (https://github.com/vapor/console/pull/94)

New:

• Created CustomActivity activity indicator type. this lets you easily create custom activity indicators with a series of characters that are looped over for the animation.
• Added a customActivity method to the Console protocol, which initializes a new CustomActivity instance.

let indicator = context.console.customActivity(frames: ["⠋","⠙","⠹","⠸","⠼","⠴","⠦","⠧","⠇","⠏"])
_ = try indicator.start(on: context.container)
// Do something that takes a long time.
indicator.succeed()

Only logs command help when there are errors in command usage, no longer logs errors in the command execution.

Fixed:

• Fixes an issue where ephemeral messages would not clear correctly. (#80)

Fixed:

• Eliminate Swift 4.1 deprecation warnings.

New:

• -e short flag now supported for setting environment.

Fixed:

• Console.output(...) now correctly defaults to printing a newline (#70).

💻 Console 3.0 (APIs for creating interactive CLI tools) is here!

Getting Started: https://docs.vapor.codes/3.0/console/getting-started/ https://docs.vapor.codes/3.0/command/getting-started/ https://docs.vapor.codes/3.0/logging/getting-started/

API Docs: https://api.vapor.codes/console/latest/Console https://api.vapor.codes/console/latest/Command https://api.vapor.codes/console/latest/Logging

Changes since final pre-release.

New:

• Added ConsoleText type for creating collections of differently styled strings. This makes it possible to output text with interpolated styles in one call to console.output(_:)
• Cleaned up the loading and progress bars, now using an ActivityIndicator protocol.
• Added lots of missing docblocks, made some APIs internal where possible to reduce API surface.

Milestone: 3.0.0

New:

• Adds deprecated support for --option=value flag style.
• Adds CommandConfig and ConfiguredCommands structs

Fixed:

• Makes console.confirm non-throwing

API Docs: https://api.vapor.codes/console/3.0.0-rc.2.2/Command/

Milestone: 3.0.0-rc.2.2

New:

• Adds support for -y, --yes and -n, --no flags for auto-answering console confirmations.

New:

• Adds a commandLine settable computed property to Environment for parsing the environment's CLI arguments.

API Docs: https://api.vapor.codes/console/3.0.0-rc.2.1/Console/ https://api.vapor.codes/console/3.0.0-rc.2.1/Command/

Milestone: 3.0.0-rc.2.1

Fixed:

• Synchronizes printed log output to avoid garbled messages.

New:

• Vapor is now running on Swift NIO!

Fixed:

• Fixed an issue parsing short flags.

Milestone

Fixed:

• Update to latest core package.
• Update error structs.

Fixed:

• Remove Swift warnings.

Milestone

New:

• Adds "short" options using a single hyphen. Add short: to the option's init.

Fixed:

• Fixed Swift 4 warnings.
• Fixed an issue with group arguments.
• Fixed a typo.

Milestone

New:

• Preliminary Swift 4 support.

Milestone

New:

• --help layout has been redone.
• Push and pop ephemeral state to track and clear text printed to the console.

Fixed:

• Loading bar messages are now truncated if the text is too long.

Milestone

🎉

Console 2.0 refines some of the original ideas of console, adds a few new conveniences, and some handy bits of functionality like secure entry.

Check out the full diff here

New:

• Groups can have a fallback

#34

New:

• secure entry