nixpkgs/lib
Silvan Mosberger 03431f1244 lib: Add README
Co-authored-by: Alexander Groleau <alex@proof.construction>
Co-authored-by: Valentin Gagarin <valentin.gagarin@tweag.io>
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2023-07-18 17:22:42 +02:00
..
path lib.path.subpath.join: init 2023-02-13 14:01:17 +01:00
systems lib.systems.doubles: add big-endian MIPS linux doubles 2023-06-01 10:42:27 +00:00
tests Merge pull request #234070 from tweag/pathType-tests 2023-06-01 20:00:36 +02:00
ascii-table.nix strings: add escapeQuery for url encoding 2023-03-03 20:48:55 +01:00
asserts.nix doc: auto-generate asserts and attrset library docs 2022-12-08 22:58:22 +01:00
attrsets.nix lib.concatMapAttrs: Simplify stack trace 2023-05-31 14:57:37 +02:00
cli.nix
customisation.nix lib/customisation: callPackageWith should abort with errors 2023-03-24 14:22:11 -07:00
debug.nix lib: remove deprecated functions 2023-03-08 03:57:38 +01:00
default.nix lib.sources.pathType and co.: Move to lib.filesystem 2023-04-05 17:18:10 +02:00
deprecated.nix lib.closePropagation: Remove the quadratic behavior in lib.closePropagation 2022-10-07 18:03:42 +02:00
derivations.nix lib: fix typos 2022-12-17 18:59:29 -05:00
fetchers.nix
filesystem.nix lib/filesystem.nix: Update top comment 2023-05-22 14:17:42 +02:00
fixed-points.nix lib: make extender available on self-references 2023-01-15 11:34:05 -08:00
flake.nix Fix import path. 2021-08-14 14:46:00 -05:00
generators.nix lib: fix typos 2023-05-19 22:09:24 -04:00
kernel.nix lib.kernel.unset: init 2023-05-01 10:23:42 +00:00
licenses.nix Merge pull request #233050 from NixOS/bsl-is-redistributable 2023-05-22 14:34:36 +02:00
lists.nix Merge pull request #206611 from h7x4/lib-lists-add-repeat 2023-02-07 06:16:09 +01:00
meta.nix Update lib/meta.nix 2023-01-27 11:16:29 +00:00
minver.nix boostrap fetchurl: Add SRI support 2022-08-24 09:55:45 +02:00
modules.nix lib.modules: configurationClass -> class 2023-05-06 18:32:59 +02:00
options.nix lib/options: nullable mkPackageOption 2023-05-19 12:22:21 +02:00
README.md lib: Add README 2023-07-18 17:22:42 +02:00
source-types.nix lib.sourceTypes: simplify implementation 2022-05-30 16:27:34 +08:00
sources.nix lib.sources.pathType and co.: Move to lib.filesystem 2023-04-05 17:18:10 +02:00
strings-with-deps.nix lib: Use Nix's static scope checking, fix error message, optimize 2020-10-22 13:46:47 +02:00
strings.nix Merge pull request #221204 from tweag/deprecate-paths-to-strings 2023-04-04 18:35:06 +02:00
trivial.nix 23.11 is Tapir 2023-05-22 21:16:04 +02:00
types.nix lib.types.submoduleWith: Interoperate with older version of submoduleWith 2023-05-17 12:51:09 +02:00
versions.nix lib/versions: add pad 2022-12-21 12:58:21 +01:00
zip-int-bits.nix lib/zip-int-bits: fix typo: bitXOR -> bitXor 2022-06-09 20:04:37 +03:00

Nixpkgs lib

This directory contains the implementation, documentation and tests for the Nixpkgs lib library.

Overview

The evaluation entry point for lib is default.nix. This file evaluates to an attribute set containing two separate kinds of attributes:

  • Sub-libraries: Attribute sets grouping together similar functionality. Each sub-library is defined in a separate file usually matching its attribute name.

    Example: lib.lists is a sub-library containing list-related functionality such as lib.lists.take and lib.lists.imap0. These are defined in the file lists.nix.

  • Aliases: Attributes that point to an attribute of the same name in some sub-library.

    Example: lib.take is an alias for lib.lists.take.

Most files in this directory are definitions of sub-libraries, but there are a few others:

  • minver.nix: A string of the minimum version of Nix that is required to evaluate Nixpkgs.
  • tests: Tests, see Running tests
    • release.nix: A derivation aggregating all tests
    • misc.nix: Evaluation unit tests for most sub-libraries
    • *.sh: Bash scripts that run tests for specific sub-libraries
    • All other files in this directory exist to support the tests
  • systems: The lib.systems sub-library, structured into a directory instead of a file due to its complexity
  • path: The lib.path sub-library, which includes tests as well as a document describing the design goals of lib.path
  • All other files in this directory are sub-libraries

Module system

The module system spans multiple sub-libraries:

  • modules.nix: lib.modules for the core functions and anything not relating to option definitions
  • options.nix: lib.options for anything relating to option definitions
  • types.nix: lib.types for module system types

Reference documentation

Reference documentation for library functions is written above each function as a multi-line comment. These comments are processed using nixdoc and rendered in the Nixpkgs manual. The nixdoc README describes the comment format.

See the chapter on contributing to the Nixpkgs manual for how to build the manual.

Running tests

All library tests can be run by building the derivation in tests/release.nix:

nix-build tests/release.nix

Some commands for quicker iteration over parts of the test suite are also available:

# Run all evaluation unit tests in tests/misc.nix
# if the resulting list is empty, all tests passed
nix-instantiate --eval --strict tests/misc.nix

# Run the module system tests
tests/modules.sh

# Run the lib.sources tests
tests/sources.sh

# Run the lib.filesystem tests
tests/filesystem.sh

# Run the lib.path property tests
path/tests/prop.sh