Web.Slack.ProgressBar

This is a simple library for creating and updating Slack messages that contain progressbars. It can be used to display the progress of a long-running task in a Slack channel, for example as part of CI tooling.

main :: IO ()
main = do
  let mySlackConfig = SlackConfig { slackApiToken = "my-slack-api-token" }

  let progressBarInfo = def { progressBarInfoTopMessage = Just "Top message"
                            , progressBarInfoSize = Just 0 }

  result <- runExceptT $ do
    progressBar <- ExceptT $ createProgressBar mySlackConfig "test-channel" progressBarInfo

    forM_ [10, 20, 30, 40, 50, 60, 70, 80, 90, 100] $ \size -> do
      threadDelay 1000000
      ExceptT $ updateProgressBar mySlackConfig progressBar (progressBarInfo { progressBarInfoSize = Just size })

  putStrLn [i|Result: '#{result}'|]

Documentation

createProgressBar :: SlackConfig -> ChannelName -> ProgressBarInfo -> IO (Either Text ProgressBar)

Create a progress bar message on the given channel. Returns a ProgressBar which can be used to update the message by calling updateProgressBar.

updateProgressBar :: SlackConfig -> ProgressBar -> ProgressBarInfo -> IO (Either Text ())

Update an existing progress bar.

data ProgressBarInfo

The state of a progress bar message.

Constructors

ProgressBarInfo

Fields

• progressBarInfoTopMessage :: Maybe Text

  Message to show above the progress bar

• progressBarInfoBottomMessage :: Maybe Text

  Message to show below the progress bar

• progressBarInfoSize :: Maybe Double

  Size of the progress bar, a Double from 0 to 100

• progressBarInfoAttachments :: Maybe [ProgressBarAttachment]

  Slack attachments for the message

data ProgressBarAttachment

A Slack attachment.

Constructors

ProgressBarAttachment

Fields

• progressBarAttachmentText :: Text

  Attachment text

• progressBarAttachmentColor :: Text

  Attachment color

Instances

ToJSON ProgressBarAttachment

Defined in Web.Slack.ProgressBar

Methods

toJSON :: ProgressBarAttachment -> Value

toEncoding :: ProgressBarAttachment -> Encoding

toJSONList :: [ProgressBarAttachment] -> Value

toEncodingList :: [ProgressBarAttachment] -> Encoding

data ProgressBar

An opaque type representing an existing Slack message.

type ChannelName = Text

Re-exports

newtype SlackConfig

Configuration options needed to connect to the Slack API

Constructors

SlackConfig

Fields

• slackApiToken :: String

  Slack API token

Instances

Show SlackConfig

Defined in Web.Slack.ProgressBar

Methods

showsPrec :: Int -> SlackConfig -> ShowS

show :: SlackConfig -> String

showList :: [SlackConfig] -> ShowS