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.
Due to limitations with flakes, both tests and documentation are stored in extra/.
This avoids the lib flake having to depend on other places for testing and documentation tools, which are basically dev dependencies.
This directory uses npins, as using flakes requires constantly running nix flake update to pick up local changes.
Tests are stored in extra/tests/<part>. You can run them all with nix-build -E '(import ./extra {}).checks.tests (or .stdlib, .auxlib).
You should also check your formatting with nix-build -E '(import ./extra {}).checks.formatting.
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.
You can build the documentation with nix-build -E '(import ./extra {}).packages.docs'.