/lib

System-agnostic library functions used by auxolotl repositories

Primary LanguageNixMIT LicenseMIT

auxolotl/lib

This repo contains system-agnostic library functions used by auxolotl repositories.

There are two main parts:

  • stdlib - mostly copied from Nixpkg's standard library. Meant to be forwards-compatible.
  • auxlib - library bits specifically for aux / auxpkgs. Not necessarily forwards-compatible.

Testing

Tests are stored in tests/<part>. You can run them all with nix-build tests/default.nix, which will run them with the minimum and maximum supported nix versions.

Alternatively, if using flakes you can run nix flake check. This will also check formatting using nixfmt.

Documentation

Reference documentation for library functions is written above each function as a multi-line comment. These comments are processed using nixdoc, although currently we aren't doing much with the output. The nixdoc README describes the comment format.