nbx

NBX

A collection of reusable packages and CLI tools for common development tasks like logging, database utilities, data conversion, transaction management, and enum generation.

Introduction

nbx is a personal Go toolbox containing a collection of reusable packages and command-line interface (CLI) tools. The goal is to provide convenient, well-tested components for common tasks encountered during Go development, fostering code reuse and efficiency.

NOTE: v1.x.x is not recommended for use, as it is not well-tested and may contain breaking changes. The current version is v2.x.x, which is more stable and has been tested in production environments.

Usage

To use the nbx toolbox, you can import the individual packages in your Go projects. For example, to use the logger package, you would do:

import "github.com/byte4cat/nbx/v2/pkg/logger"

You can also use the CLI tools provided in the cmd directory. For instance, to generate Go enum code from a YAML definition file using the enumgo tool, you would run:

nbx enumgo -f path/to/your/enum.yaml

Installation

To install the nbx toolbox, you can use the following command:

go get github.com/byte4cat/nbx@latest

This will fetch the latest version of the toolbox and make it available in your Go environment.

Features

The toolbox currently includes the following key packages and CLI tools:

• pkg/logger: A flexible logging library based on zap with different modes, adapters (e.g., gRPC interceptors), encoders, and configurable log levels.
• pkg/dbu: Database utilities including helpers for building update maps for relational databases (RDB, like GORM) and MongoDB, handling struct tags, default naming, and pointer values.
• pkg/pbconv: Protocol Buffer conversion helpers (details based on code, assumed to help convert between Go types and protobuf types).
• pkg/transaction: Helpers and a TransactionManager pattern for managing database transactions cleanly, especially with GORM, by passing the transaction via context.Context.
• cmd/enumgo: A CLI tool (nbx enumgo) to generate Go enum code directly from YAML definition files.

Getting Started

To get the nbx toolbox and its source code, you can clone the repository:

git clone [https://github.com/byte4cat/nbx.git](https://github.com/byte4cat/nbx.git)