README
¶
go-snk — the kitchen sink for clean Go projects
go-snk is the library you pull into any Go project to clean it up and keep it clean. The name is short for
kitchen sink — not because it does everything, but because it collects the small, type-safe helpers you keep reaching
for across projects. No repeated loops, no one-off helpers scattered through your codebase, just consistent patterns
for the things you do all the time.
Getting Started
Installation
go get github.com/SharkByteSoftware/go-snk@latest
Import only the packages you need:
package main
import "github.com/SharkByteSoftware/go-snk/slicex"
import "github.com/SharkByteSoftware/go-snk/mapx"
Documentation
| Package | Description | Docs |
|---|---|---|
slicex |
Helpers for filtering, mapping, searching, grouping, zipping, windowing, rotating, and numeric operations on slices | slicex.md |
slicex/parallel |
Parallel slice helpers for independent per-item work | slicex.md |
mapx |
Helpers for common map operations including partitioning, key mapping, counting by classifier, and merging maps | mapx.md |
httpx |
Lightweight helpers for HTTP requests with less boilerplate | httpx.md |
jsonx |
Helpers for encoding and decoding JSON to and from readers, byte slices, and strings | jsonx.md |
conditional |
Concise helpers for branching and value selection | conditional.md |
stringx |
Helpers for blank checks, fallback selection, truncation, wrapping, and padding strings | stringx.md |
errorx |
Helpers for intentional error suppression, initialization panics, multi-target error checks, and reducing multiple errors to one | errorx.md |
containers |
Reusable data structures including lists, sets, stacks, and queues | README.md |
helpers |
Generic utilities for pointer handling and zero value operations | helpers.md |
For a full overview of the library, see docs/overview.md.
License
MIT License, see LICENSE for details
Directories
¶
| Path | Synopsis |
|---|---|
|
Package conditional contains helper utilities such as a ternary operators and other functions for conditional types of operations.
|
Package conditional contains helper utilities such as a ternary operators and other functions for conditional types of operations. |
|
Package containers provides a variety of container types.
|
Package containers provides a variety of container types. |
|
lists
Package lists provides various linked lists implementations
|
Package lists provides various linked lists implementations |
|
queues
Package queues provides queue implementations.
|
Package queues provides queue implementations. |
|
sets
Package sets provides a set data structure.
|
Package sets provides a set data structure. |
|
stacks
Package stacks contains a stack implementation.
|
Package stacks contains a stack implementation. |
|
Package errorx provides small helpers for common error handling patterns.
|
Package errorx provides small helpers for common error handling patterns. |
|
Package helpers provides various helpers such as pointer helpers.
|
Package helpers provides various helpers such as pointer helpers. |
|
Package httpx provides a simple HTTP client for Go.
|
Package httpx provides a simple HTTP client for Go. |
|
internal
|
|
|
constraints
Package constraints provides useful type constraints.
|
Package constraints provides useful type constraints. |
|
Package jsonx provides helpers for decoding JSON from common sources.
|
Package jsonx provides helpers for decoding JSON from common sources. |
|
Package mapx provides helper functions for working with maps.
|
Package mapx provides helper functions for working with maps. |
|
Package slicex provides various slice utilities.
|
Package slicex provides various slice utilities. |
|
parallel
Package parallel provides versions of slicex functions that execute in parallel.
|
Package parallel provides versions of slicex functions that execute in parallel. |
|
Package stringx provides small helpers for common string operations.
|
Package stringx provides small helpers for common string operations. |
Click to show internal directories.
Click to hide internal directories.