README
¶
utils
Utilities for working within the openlane ecosystem
Directories
¶
| Path | Synopsis |
|---|---|
|
Package cache holds the library for interacting with redis
|
Package cache holds the library for interacting with redis |
|
cli
|
|
|
rows
Package rows makes CLI output pretty
|
Package rows makes CLI output pretty |
|
tables
Package tables is a collection of functions that generate tables for the CLI
|
Package tables is a collection of functions that generate tables for the CLI |
|
Package dumper is a utility package for dumping http request contents
|
Package dumper is a utility package for dumping http request contents |
|
Package emails contains all of the logic and templating for sending emails It is built to allow for other email providers other than SendGrid if required but is mostly specific to SendGrid as that's our email provider of choice
|
Package emails contains all of the logic and templating for sending emails It is built to allow for other email providers other than SendGrid if required but is mostly specific to SendGrid as that's our email provider of choice |
|
mock
Package mock provides intermediary data structures to assist in testing and debugging sending an email without actually sending the email - testing the creation and sending of email typically requires some kind of tracking of what was sent or not and metadata about the message which is what is setup here
|
Package mock provides intermediary data structures to assist in testing and debugging sending an email without actually sending the email - testing the creation and sending of email typically requires some kind of tracking of what was sent or not and metadata about the message which is what is setup here |
|
Package envparse provides a way to parse environment variables from a struct
|
Package envparse provides a way to parse environment variables from a struct |
|
Package gravatar generates random avatar images for users or organizations on sign up which they can override with their own avatars
|
Package gravatar generates random avatar images for users or organizations on sign up which they can override with their own avatars |
|
Package keygen provides functionality for generating API client IDs and secrets
|
Package keygen provides functionality for generating API client IDs and secrets |
|
Package marionette is a golang based task manager with scheduling, backoff, future scheduling built in.
|
Package marionette is a golang based task manager with scheduling, backoff, future scheduling built in. |
|
Package passwd provides fancy crypto shit for passwords
|
Package passwd provides fancy crypto shit for passwords |
|
Package rout is a semi-centralized method of handling and surfacing user facing errors
|
Package rout is a semi-centralized method of handling and surfacing user facing errors |
|
Package sendgrid is a utiliuty package for interfacing with Sendgrid, a third party transactional email provider
|
Package sendgrid is a utiliuty package for interfacing with Sendgrid, a third party transactional email provider |
|
Package slack holds slack integration clients and message definitions
|
Package slack holds slack integration clients and message definitions |
|
Package sliceutil contains utilities for working with slices in Go
|
Package sliceutil contains utilities for working with slices in Go |
|
Package sqlite implements a connect hook around the sqlite3 driver so that the underlying connection can be fetched from the driver for more advanced operations such as backups.
|
Package sqlite implements a connect hook around the sqlite3 driver so that the underlying connection can be fetched from the driver for more advanced operations such as backups. |
|
Package testutils provides utilities for use in tests
|
Package testutils provides utilities for use in tests |
|
Package ulids is a lightweight wrapper around the github.com/oklog/ulid package that provides some common functionality (like checking if a ULID is null or is zero) as well as a process-global, cryptographically random, monotonic, and thread-safe ulid generation mechanism that can be used from external packages
|
Package ulids is a lightweight wrapper around the github.com/oklog/ulid package that provides some common functionality (like checking if a ULID is null or is zero) as well as a process-global, cryptographically random, monotonic, and thread-safe ulid generation mechanism that can be used from external packages |
Click to show internal directories.
Click to hide internal directories.