ConsoleKit

Topics

Classes

• class ActivityIndicator
  An instance of a ActivityIndicatorType that can be started, failed, and succeeded.
• class Argument
  An argument for a console command
• class Flag
  A supported option for a command.
• class Option
  A supported option for a command.
• class Terminal
  Generic console that uses a mixture of Swift standard library and Foundation code to fulfill protocol requirements.

Protocols

• protocol ActivityBar
  An ActivityIndicatorType that renders an activity bar on a single line.
• protocol ActivityIndicatorType
  ActivityIndicatorTypes are responsible for drawing / rendering the current ActivityIndicatorState to the Console.
• protocol AnyAsyncCommand
  A type-erased Command.
• protocol AnyCommand
  A type-erased Command.
• protocol AsyncCommand
  A command that can be run through a Console.
• protocol AsyncCommandGroup
  A group of named commands that can be run through a Console.
• protocol Command
  A command that can be run through a Console.
• protocol CommandGroup
  A group of named commands that can be run through a Console.
• protocol CommandSignature
  The structure of the inputs that a command can take
• protocol Console
  Protocol for powering styled Console I/O.
• protocol LoggerFragment
  A fragment of a log message.
• protocol TimestampSource
  A protocol to allow mocking the timestamp for tests

Structures

• struct AndFragment
  Combine the current fragment with another, which will be written after the current fragment finishes.
• struct AnySendableHashable
  A Sendable version of the standard library’s AnyHashable type.
• struct AsyncCommands
  Represents a top-level group of configured commands. This is usually created by calling resolve(for:) on AsyncCommands.
• struct CommandContext
  A type-erased CommandContext
• struct CommandInput
  Raw input for commands. Use this to parse options and arguments for the command context.
• struct Commands
  Represents a top-level group of configured commands. This is usually created by calling resolve(for:) on Commands.
• struct CompletionAction
  An action to be used in the shell completion script(s) to provide special shell completion behaviors for an Option’s argument or a positional Argument.
• struct ConsoleError
• struct ConsoleFragmentLogger
  Outputs logs to a Console via a LoggerFragment pipeline.
• struct ConsoleStyle
  Representation of a style for outputting to a Console in different colors with differing attributes. A few suggested default styles are provided.
• struct ConsoleText
  A collection of ConsoleTextFragments. Represents stylized text that can be outputted to a Console.
• struct ConsoleTextFragment
  A single piece of ConsoleText. Contains a raw String and the desired ConsoleStyle.
• struct CustomActivity
  An activity indicator with customizable frames and success and failure messages.
• struct FragmentOutput
  The output of a LoggerFragment, including some intermediary state used for things like deduplicating separators.
• struct IfMaxLevelFragment
  Make the current fragment conditional, only calling its output method if the record’s loggerLevel is maxLevel or lower
• struct LabelFragment
  Writes the label of the logger, and requests a separator for the next fragment.
• struct LevelFragment
  Writes the level of the logged message, and requests a separator for the next fragment.
• struct LiteralFragment
  Writes the given text to the output. This type does not request a separator for the next fragment
• struct LoadingBar
  Loading-style implementation of ActivityBar.
• struct LogRecord
  Information about a specific log message, including information from the logger the message was logged to.
• struct LoggerSourceFragment
  Writes the source of the logged message. By default the source is the name of the module the message was logged in.
• struct MergedAsyncCommandGroup
• struct MessageFragment
  Writes the logged message to the output, and requests a separator for the next fragment.
• struct MetadataFragment
  Writes the combined metadata to the output, and requests a separator for the next fragment only if the metadata was not empty.
• struct ProgressBar
  Progress-style implementation of ActivityBar.
• struct SeparatorFragment
• struct SourceLocationFragment
  Writes the file location of the logged message, including the line. This fragment requests a separator for the next fragment.
• struct SystemTimestampSource
  The default TimestampSource, which gets the time from the system.
• struct TimestampFragment
  Writes a formatted timestamp based on the time obtained from the TimestampSource.

Functions

• func defaultLoggerFragment() -> DefaultLoggerFragmentType
  A LoggerFragment which implements the default logger message format.
• func timestampDefaultLoggerFragment(timestampSource: some TimestampSource) -> some LoggerFragment
  A LoggerFragment which implements the default logger message format with a timestamp at the front.

Operators

• func + (ConsoleText, ConsoleText) -> ConsoleText
  Appends a ConsoleText to another ConsoleText.
• func += (inout ConsoleText, ConsoleText)
  Appends a ConsoleText to another ConsoleText in-place.

Type Aliases

• typealias ConsoleLogger
  Outputs logs to a Console using the defaultLoggerFragment().
• typealias DefaultLoggerFragmentType
  The complete explicit type of the defaultLoggerFragment(). Unfortunately, we have to spell it out instead of just letting it be some LoggerFragment in order to define the ConsoleLogger alias properly.

Enumerations

• enum ActivityIndicatorState
  Possible states to draw / render and ActivityIndicatorType.
• enum CommandError
  Errors working with the ConsoleKitCommands module.
• enum ConsoleClear
  Supported methods for clearing the Console.
• enum ConsoleColor
  Supported colors for creating a ConsoleStyle for ConsoleText.
• enum Shell
  Shell completion implementations.

Extended Modules

• Logging
• Swift