slackbot

README

slackbot

Basic slackbot implementation

Authors

• Christophe Lambin

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Documentation

Overview

Package slackbot provides a basic slackbot implementation. Using this package typically involves creating a bot as follows:

bot := slackbot.New("some-token", slackbot.WithCommands(...)
go bot.Run(context.Background())

Once running, the bot will listen for any commands specified and execute them. Slackbot itself implements two commands: "version" (which responds with the bot's name; see WithName option) and "help" (which shows all supported commands).

Applications can send messages as follows:

bot.Send(channel, []slack.Attachment{{Text: "Hello world"}})

Example

package main

import (
	"context"
	"github.com/clambin/go-common/slackbot"
	"github.com/slack-go/slack"
)

func main() {
	b := slackbot.New("my-slack-token", slackbot.WithCommands(map[string]slackbot.CommandFunc{
		"hello": func(_ context.Context, _ ...string) []slack.Attachment {
			return []slack.Attachment{{
				Color: "good",
				Text:  "General Kenobi!",
			}}
		},
	}))

	b.Run(context.Background())
}

Index

• type CommandFunc
• type Option
  • func WithCommands(commands map[string]CommandFunc) Option
  • func WithLogger(logger *slog.Logger) Option
  • func WithName(name string) Option
• type SlackBot
  • func New(slackToken string, options ...Option) *SlackBot
  • func (b *SlackBot) Register(name string, command CommandFunc)
  • func (b *SlackBot) Run(ctx context.Context) error
  • func (b *SlackBot) Send(channel string, attachments []slack.Attachment) error

Examples

• Package

Types

type CommandFunc

type CommandFunc func(ctx context.Context, args ...string) []slack.Attachment

CommandFunc signature for command callback functions

type Option

type Option func(*SlackBot)

func WithCommands

func WithCommands(commands map[string]CommandFunc) Option

func WithLogger

func WithLogger(logger *slog.Logger) Option

func WithName

func WithName(name string) Option

type SlackBot

type SlackBot struct {
	// contains filtered or unexported fields
}

SlackBot connects to Slack through Slack's Bot integration.

func New

func New(slackToken string, options ...Option) *SlackBot

New creates a new slackbot

func (*SlackBot) Register

func (b *SlackBot) Register(name string, command CommandFunc)

Register adds a new command

func (*SlackBot) Run

func (b *SlackBot) Run(ctx context.Context) error

Run the slackbot

func (*SlackBot) Send

func (b *SlackBot) Send(channel string, attachments []slack.Attachment) error