formatting

Documentation

Index

• Constants
• Variables
• func Bold(s string) string
• func Escape(s string) string
• func Escapef(format string, a ...any) string
• func FormatCommandHelp(cmd commandtypes.Desc) string
• func FormatCommandShortHelp(cmd commandtypes.Desc) string
• func FormatCommandUsage(cmd commandtypes.Desc) string
• func FormatHelp(cmds []commandtypes.Desc) string
• func FormatMessageCreated(id string) string
• func FormatMessages(header string, msgs []*standup.Message) string
• func FormatStart() string
• func Mono(s string) string
• func MustRenderTemplate(tmpl string, data any) string
• func ParseTime(s string, now time.Time) (time.Time, error)
• func RenderTemplate(tmpl string, data any) (string, error)
• type Printable
• type SyntaxError
  • func NewCommandSyntaxErrorf(cmd commandtypes.Desc, format string, a ...any) SyntaxError
  • func NewSyntaxErrorf(format string, a ...any) SyntaxError
  • func (e SyntaxError) Error() string
  • func (e SyntaxError) Printable() string

Constants

const ParseMode = tgbotapi.ModeMarkdownV2

Variables

var (
	InternalError    = Escape("Internal error occured.")
	PermissionDenied = Escape("Permission denied.")
	UsageRestricted  = Escape("Bot usage is currently restricted.")
)

var ErrInvalidTimeFormat = errors.New("invalid time format")

Functions

func Bold

func Bold(s string) string

func Escape

func Escape(s string) string

Escape makes arbitrary text valid when parsed with ParseMode.

func Escapef

func Escapef(format string, a ...any) string

Escapef is a formatted version of Escape, but it does not escape a. This means that these values must be valid when parsed via ParseMode.

func FormatCommandHelp

func FormatCommandHelp(cmd commandtypes.Desc) string

func FormatCommandShortHelp

func FormatCommandShortHelp(cmd commandtypes.Desc) string

func FormatCommandUsage

func FormatCommandUsage(cmd commandtypes.Desc) string

func FormatHelp

func FormatHelp(cmds []commandtypes.Desc) string

func FormatMessageCreated

func FormatMessageCreated(id string) string

func FormatMessages

func FormatMessages(header string, msgs []*standup.Message) string

FormatMessages formats a list of messages for the report. If present, header must be valid when parsed with ParseMode (see Escape).

func FormatStart

func FormatStart() string

func Mono

func Mono(s string) string

func MustRenderTemplate

func MustRenderTemplate(tmpl string, data any) string

MustRenderTemplate acts like RenderTemplate, but panics on errors.

func ParseTime

func ParseTime(s string, now time.Time) (time.Time, error)

func RenderTemplate

func RenderTemplate(tmpl string, data any) (string, error)

RenderTemplate renders text/template.Template tmpl. All plaint text nodes of the template are escaped via Escape. The following functions are also availible in template context:

- "bold" -> Bold

- "mono" -> Mono

- "esc" -> Escape

Types

type Printable

type Printable interface {
	Printable() string
}

type SyntaxError

type SyntaxError struct {
	Msg string
	Cmd *commandtypes.Desc
}

func NewCommandSyntaxErrorf

func NewCommandSyntaxErrorf(cmd commandtypes.Desc, format string, a ...any) SyntaxError

func NewSyntaxErrorf

func NewSyntaxErrorf(format string, a ...any) SyntaxError

func (SyntaxError) Error

func (e SyntaxError) Error() string

func (SyntaxError) Printable

func (e SyntaxError) Printable() string