watermint / essentials

Essential library for Go

Essential libraries for Go

Objectives

Goals

• All native Go library.
• Minimize use of external libraries (allowed packages: golang.org/x, github.com/golang).
• Separate interface from implementation.
• Safer code.
• Ease of development.

Core usecase

This library is intended to use a desktop or command-line applications, not on a server or IoT/mobile. The library may be optimized for that. For example, a target memory footprint may not exceed 1-2 GiB for a single instance.

Non-goals

• Performance (this is often trade-off to ease-of-development)
• Minimal footprints
• Compatibility (because this project is experimental)

Target platform

• Windows 10 or above (x64)
• Darwin (macOS) (x64, arm64)
• Linux (x64)

Structure

Naming

• All submodules should start with the prefix e. For example, if a sub-module is for logging, the name should be elog.

essentials's Issues

File system interface and implementation

• os.FS is not enough to cover all file system including virtual file system or cloud file system.
• Go-lang's file handling or IO usually need to handle OS specific stuff even for fundamental operation such as file move (need to consider drive diff on Windows)

Image related framework & libraries

OS Native system calls

Port essential libraries from toolbox project

• Semantic versioning format
• UUID format

UUID / hex parser enhancements

Multi-producer, single-consumer library

The library that handle message queue like mpsc (https://doc.rust-lang.org/std/sync/mpsc/) in Rust.
The mpsc is easily implemented with channel. This mpsc need to handle consumer thread (that should be a single-thread).

Locale interface

Desktop open interface

Release procedure

Obvious error handling framework

Context:

• Golang's error handling sometimes cause readability issue.
• There is usually no clear guidance about a cause, such as an error for a file operation. That need to verify an error in various ways. e.g. compare with constant Err* value, use IsXxx func to ensure error, and so on.

String utilities

• Case converter
• Tokenizer