util

A zero dependency golang utility library that aims to add useful features to the std lib.

Supported Go Versions and OS's

Supported Go versions: 1.21, 1.22, and 1.23

The latest versions of windows, linux, and macos (as defined by github actions) are supported.

Documentation

This package contains many sub-packages that each deserve more space than can be given in one combined README. Please refer to each packages README for information about each sub-package:

1. Iterator framework
2. Containers (a.k.a. data structures)
3. CLI argument parser
4. Widgets
5. Generators

Code Generator Installation

If your project would benefit from using the code generators defined in this utility library then you can install them using the command shown below. The generator executables will be placed in the $GOPATH/bin directory.

go install github.com/barbell-math/util/generators/...

Note: It is recommended to have the $GOPATH/bin directory in your path environment variable to make the newly installed generators easier to run.

To install a single generator rather than all of them use the command shown below.

go install github.com/barbell-math/util/generators/<generator name>

Package Install

If your project would benefit from using the this package directly as a library then you can use the command shown below to add the library to your project.

go get github.com/barbell-math/util

Helpful Commands

Building and Running Generators

go build -o ./bin/ ./generators/...
go generate ./src/...

Running Unit Tests

go build -o ./bin/ ./generators/...     # unnecessary if no generated code changed
go generate ./src/...                   # unnecessary if no generated code changed
go test ./src/...