go-stdlib

module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2025 License: MIT

README

Netic go standard library

GitHub Tag CI Go Reference Go Report Card License

The Netic go standard library is an extension to the go standard library. It comes in the form of a collection of packages.

Dependencies

The packages are dependency free meaning. Packages added to this module must not use any external dependencies unless listed below.

Exceptions:

  • golang.org/x/* - maintained by go and dependency free
  • github.com/stretchr/testify - used for testing

CI checks the imports against regular expressions found in the .allowed-imports file. To allow new imports, add them to the .allowed-imports file in a separate PR.

Do NOT add exceptions to this list without peer review.

Package names

  • Prefix names for packages that mirror a go standard library package with x.
  • Prefix names for packages that are likely to mirror future go standard library Packages with x.
  • Use singular names for package (except in the previously mentioned cases).

Testing

  • Unit testing is mandatory.
  • Go for > 95% coverage, preferably 100%.

Documentation

  • Document all exported (public) identifiers
  • Maintain a doc.go in each package with introduction, installation instructions and usage examples.
  • Use make gen to generate README.md files
doc.go minimum
// Package mypkg does ...
package mypkg

//go:generate go tool github.com/princjef/gomarkdoc/cmd/gomarkdoc -o README.md

Packages

  • file - file operations
  • set - set data structure
  • unit - unit formatting and conversion package
  • version - version functions
  • xjson - JSON functions
  • xslices - slice data type functions
  • xstrings - string data type functions
  • xstructs - struct data type functions

Installation

Install using go get:

go get github.com/neticdk/go-stdlib

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

Link to license or copyright notice

Copyright 2025 Netic A/S. All rights reserved.

Directories

Path Synopsis
Package unit provides utilities for handling units including human-readable unit formatting, parsing, and registration of custom units and formatting systems.
Package unit provides utilities for handling units including human-readable unit formatting, parsing, and registration of custom units and formatting systems.
transliterate
Package transliterate provides functionality to convert Unicode text into plain ASCII equivalents.
Package transliterate provides functionality to convert Unicode text into plain ASCII equivalents.
transliterate/internal/table
Package table contains the generated transliteration data for the transliterate package.
Package table contains the generated transliteration data for the transliterate package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL