nixpkgs/pkgs/by-name
2023-09-25 07:57:52 +02:00
..
_4/_4th _4th: fix cross compilation by setting AR in makeFlags 2023-09-22 16:28:35 -03:00
aa/aarch64-esr-decoder aarch64-esr-decoder: init at 0.2.1 2023-09-21 18:41:38 -07:00
ai/airscan airscan: init at 0.3 2023-09-10 12:54:15 +02:00
al algol68g: 3.3.22 -> 3.3.23 2023-09-24 01:12:55 -06:00
ar/arrpc arrpc: init at 3.2.0 2023-09-17 18:28:16 -04:00
as/asciiquarium-transparent asciiquarium-transparent: init at unstable-2023-02-19 (#253439) 2023-09-05 23:20:06 +02:00
ba Merge pull request #256438 from lf-/jade/backlight-auto 2023-09-24 02:28:37 +02:00
bi/binsort binsort: init at 0.4-1 2023-09-20 23:57:22 +02:00
bm/bmake bmake: more accurate metainfo about brokenness 2023-09-22 01:38:23 -03:00
bo boogie: 2.15.7 -> 3.0.4 2023-09-16 16:00:34 +02:00
ca/cargo-rdme cargo-rdme: init at 1.4.2 2023-09-12 12:47:05 +03:00
cd/cdwe cdwe: init at 0.3.0 2023-09-08 18:35:51 -04:00
ce/celluloid celluloid: refactor 2023-09-17 15:47:03 -03:00
cl/clzip clzip: init at 1.13 2023-09-22 20:00:39 +08:00
cn/cntb cntb: init at 1.4.6 2023-09-22 12:21:36 +00:00
de/debianutils debianutils: fix build on darwin 2023-09-22 08:01:22 -03:00
dj/djent djent: init at 1.0 2023-09-14 13:05:29 +02:00
dm/dmenu-bluetooth dmenu-bluetooth: init at unstable-2023-07-16 2023-09-21 18:05:46 +09:00
ec/ecmtools ecmtools: refactor 2023-09-15 14:12:15 +00:00
el/elvish elvish: refactor 2023-09-19 00:02:22 -03:00
en/engage engage: 0.1.3 -> 0.2.0 2023-09-19 20:52:12 -07:00
es/esbuild-config esbuild-config: init at 1.0.1 2023-09-10 20:12:51 -04:00
fl/fleng fleng: 16 -> 17 2023-09-16 21:15:31 +00:00
ga gash-utils: init at 0.2.0 2023-09-05 19:40:05 +02:00
gh/ghunt ghunt: init at 2.0.1 2023-09-10 17:56:56 +02:00
gi/gitmoji-cli gitmoji-cli: use fetchYarnDeps 2023-09-23 23:31:25 -07:00
he Merge pull request #255459 from bobvanderlinden/pr-hello-mainprogram 2023-09-16 14:12:22 +02:00
hy hyperlink: init at 0.1.31 2023-09-16 15:21:08 -04:00
i3/i3bar-river i3bar-river: init at 0.1.3 2023-09-22 16:45:57 -04:00
if/ifrextractor-rs ifrextractor-rs: init at 1.5.1 2023-09-08 16:39:00 +02:00
ir/ironbar ironbar: init at 0.13.0 2023-09-09 20:48:37 +02:00
ji/jinja2-cli jinja2-cli: init at 0.8.2 2023-09-08 21:10:04 -04:00
ka/katriawm katriawm: fix cross compilation and minor improvement 2023-09-22 16:28:05 -03:00
kt/ktfmt ktfmt: init at 0.46 2023-09-23 16:42:25 -03:00
la/labwc labwc: 0.6.4 -> 0.6.5 2023-09-23 19:44:14 -03:00
le lemminx: disable flaky DocumentLifecycleParticipantTest 2023-09-23 03:11:31 +02:00
li libisoburn: migrate to by-name 2023-09-20 22:51:30 -03:00
lu/luastatus luastatus: init at 0.6.0 2023-09-23 15:40:55 +10:00
ma matrix-commander-rs: init at 0.1.32 2023-09-21 18:12:17 +02:00
mf/mfoc-hardnested mfoc-hardnested: unstable-2021-08-14 -> unstable-2023-03-27 2023-09-13 23:24:14 +08:00
mk/mksh mksh: migrate to by-name 2023-09-19 00:02:22 -03:00
na/nawk nawk: update homepage 2023-09-20 09:21:59 -03:00
ne/netproc netproc: unstable-2022-02-11 -> 0.6.6 2023-09-23 00:13:24 +08:00
ni/nixos-anywhere nixos-anywhere: set mainProgram and use finalAttrs 2023-09-20 08:11:11 +02:00
or/orchard orchard: init at 0.12.0 2023-09-15 00:41:52 -04:00
ou/outputcheck outputcheck: init at 0.4.2 2023-09-19 22:23:55 +08:00
pa/passes passes: init at 0.8 2023-09-09 20:30:01 +02:00
pd/pdepend pdepend: Build from source 2023-09-17 18:09:25 +02:00
ph/phpdocumentor phpdocumentor: init at 3.4.1 2023-09-16 17:23:32 +02:00
pl/platformsh platformsh: 3.79.2 -> 4.10.0 2023-09-17 15:07:02 +02:00
pr/prettier-d-slim prettier-d-slim: use buildNpmPackage 2023-09-14 08:16:43 -07:00
qu/quicktype quicktype: use buildNpmPackage 2023-09-09 04:20:00 +00:00
rc/rc rc: migrate to by-name 2023-09-19 00:02:22 -03:00
re rectangle-pro: 3.0.9 -> 3.0.11 2023-09-25 10:27:49 +10:00
ri/ripsecrets ripsecrets: 0.1.6 -> 0.1.7 2023-09-11 16:16:33 -04:00
ro robo: init at 4.0.4 2023-09-16 17:24:30 +02:00
ru/rusti-cal rusti-cal: init at 1.1.0 2023-09-08 16:27:47 +02:00
sa/samrewritten samrewritten: init at unstable-2023-05-23 2023-09-24 11:27:26 +09:00
sc/screentest screentest: fix cross compilation, set strictDeps 2023-09-22 13:31:36 -04:00
sl/sleek-grub-theme sleek-grub-theme: init at unstable-2022-06-04 2023-09-12 16:28:44 +08:00
ss/sssnake sssnake: init at 0.3.2 (#253441) 2023-09-05 22:21:56 +02:00
st/static-server static-server: init at 1.2.1 2023-09-20 10:36:19 -04:00
su/sunpaper sunpaper: add meta.mainProgram, fix license, and other cleanup (#256437) 2023-09-21 22:38:24 +02:00
sy/symbolicator symbolicator: 23.9.0 -> 23.9.1 2023-09-20 23:21:09 -04:00
tc/tcsh tcsh: migrate to by-name 2023-09-10 01:35:11 +00:00
th thud: rename from go-thumbnailer, 0.1.0 -> 0.3.0 2023-09-22 08:32:16 -04:00
tm/tmuxifier tmuxifier: init at 0.13.0 2023-09-10 18:43:27 +03:00
tr/trealla trealla: 2.26.9 -> 2.27.15 2023-09-13 10:43:38 +00:00
uc/ucg ucg: cleanup 2023-09-13 15:31:38 +00:00
un/unimap unimap: init at 0.6.0 2023-09-11 11:10:46 -04:00
up/upiano upiano: init at 0.1.2 2023-09-08 22:12:29 -04:00
ux/uxn uxn: unstable-2023-08-30 -> unstable-2023-09-06 2023-09-17 18:58:49 -03:00
wa/wayland-logout wayland-logout: init at 1.4 2023-09-05 20:08:12 +02:00
wi/windowmaker windowmaker: 0.95.9 -> 0.96.0 2023-09-10 12:14:55 +00:00
wo/wonderdraft wonderdraft: init at 1.1.7.3 2023-09-09 21:15:07 +02:00
xo/xorriso xorriso: 1.5.6.pl02 -> 1.5.7 2023-09-20 22:51:30 -03:00
yt/ytui-music ytui-music: init at 2.0.0-rc1 2023-09-23 00:54:46 +10:00
zc/zcfan zcfan: init at 1.2.1 2023-09-08 19:43:02 +02:00
zp/zpaqfranz zpaqfranz: init at 58.9 2023-09-18 21:25:32 -03:00
zx/zxpy zxpy: init at 1.6.3 2023-09-08 23:27:41 -04:00
README.md pkgs/by-name: Add manual migration guidelines 2023-09-12 00:18:24 +02:00

Name-based package directories

The structure of this directory maps almost directly to top-level package attributes. This is the recommended way to add new top-level packages to Nixpkgs when possible.

Example

The top-level package pkgs.some-package may be declared by setting up this file structure:

pkgs
└── by-name
   ├── so
   ┊  ├── some-package
      ┊  └── package.nix

Where some-package is the package name and so is the lowercased 2-letter prefix of the package name.

The package.nix may look like this:

# A function taking an attribute set as an argument
{
  # Get access to top-level attributes for use as dependencies
  lib,
  stdenv,
  libbar,

  # Make this derivation configurable using `.override { enableBar = true }`
  enableBar ? false,
}:

# The return value must be a derivation
stdenv.mkDerivation {
  # ...
  buildInputs =
    lib.optional enableBar libbar;
}

You can also split up the package definition into more files in the same directory if necessary.

Once defined, the package can be built from the Nixpkgs root directory using:

nix-build -A some-package

See the general package conventions for more information on package definitions.

Changing implicit attribute defaults

The above expression is called using these arguments by default:

{
  lib = pkgs.lib;
  stdenv = pkgs.stdenv;
  libbar = pkgs.libbar;
}

But the package might need pkgs.libbar_2 instead. While the function could be changed to take libbar_2 directly as an argument, this would change the .override interface, breaking code like .override { libbar = ...; }. So instead it is preferable to use the same generic parameter name libbar and override its value in pkgs/top-level/all-packages.nix:

libfoo = callPackage ../by-name/so/some-package/package.nix {
  libbar = libbar_2;
};

Manual migration guidelines

Most packages are still defined in all-packages.nix and the category hierarchy. Please hold off migrating your maintained packages to this directory.

  1. An automated migration for the majority of packages is being worked on. In order to save on contributor and reviewer time, packages should only be migrated manually afterwards if they couldn't be migrated automatically.

  2. Manual migrations should only be lightly encouraged if the relevant code is being worked on anyways. For example with a package update or refactoring.

  3. Manual migrations should not remove definitions from all-packages.nix with custom arguments. That is a backwards-incompatible change because it changes the .override interface. Such packages may still be moved to pkgs/by-name however, while keeping the definition in all-packages.nix. See also changing implicit attribute defaults.

Limitations

There's some limitations as to which packages can be defined using this structure:

  • Only packages defined using pkgs.callPackage. This excludes packages defined using pkgs.python3Packages.callPackage ....

    Instead use the category hierarchy for such attributes.

  • Only top-level packages. This excludes packages for other package sets like pkgs.pythonPackages.*.

    Refer to the definition and documentation of the respective package set to figure out how such packages can be declared.

Validation

CI performs certain checks on the pkgs/by-name structure. This is done using the nixpkgs-check-by-name tool. The version of this tool used is the one that corresponds to the NixOS channel of the PR base branch. See here for details.

The tool can be run locally using

nix-build -A tests.nixpkgs-check-by-name
result/bin/nixpkgs-check-by-name .