This is an experimental stab at populating Nix derivations for all the same packages as Pack currently offers.
In addition to the brief instructions given below, you can find example
projects that use this packageset in the examples/ folder.
This is a Nix wrapper around the Idris2 Pack package database. What that means
is that it makes it easy to use the packages found in that database within a
Nix derivation that builds your own Idris2 package. This project doesn't
facilitate using Pack itself, it provides packages wrapped in buildIdris Nix
derivations that can be used in your own buildIdris call by passing them as
the idrisLibraries argument.
The buildIdris function offered by this package set is the same one you may be
familiar with from the Nix tooling in the Idris2 compiler repo or the Nixpkgs
idris2Packages.buildIdris. This project additionally offers a buildIdris'
function that uses ipkg data to fill in additional information. See the
section on buildIdris' below for details.
You can use this packageset in your Flake-based project, your non-Flake project, or a developer shell.
Cachix is currently only populated for the non-Flake usecase but its quite
optional to take advantage of the binary cache anyway. To use the cachix build
cache, add "https://gh-nix-idris2-packages.cachix.org" to your list of
substituters and
"gh-nix-idris2-packages.cachix.org-1:iOqSB5DrESFT+3A1iNzErgB68IDG8BrHLbLkhztOXfo="
to your list of trusted-public-keys.
You can use this package set as either a flake input or imported from a derivation.
A flake project can use the Idris2 package set as an input. If you want to
benefit from the Cachix cash at all (currently only caches the compiler & LSP,
but that's quite a bit of time saved), you'll need to avoid changing the
follows for the package set.
inputs.packageset.url = "github:mattpolzin/nix-idris2-packages";
outputs = { packageset, ...}:
let
inherit (packageset.packages.x86_64-linux) idris2 idris2Lsp buildIdris;
idris2Packages = packageset.idris2Packages.x86_64-linux;
in
{}If you're setting up a developer shell or have some other need for source code
of your dependencies, use packageset.idris2PackagesWithSource... instead.
A non-flake project can import the Idris2 package set pinned at a particular revision as in the following snippet.
let
packageset = import (pkgs.fetchgit {
url = "https://github.com/mattpolzin/nix-idris2-packages";
rev = "245a47d5f86aa74c4aa423dc448488e26507e114";
hash = "sha256-QAtztZ30wxrx8XAFO5UbxpLr+hyLD+UwdQn9+AKitKY=";
}) {};
inherit (packageset) idris2 idris2Lsp buildIdris idris2Packages;
in
{}If you're setting up a developer shell or have some other need for source code
of your dependencies, pass the packageset import { withSource = true; }.
Once you've got the package set, whether as a flake or not, you can use the
buildIdris function (or see below for the even more convenient buildIdris'
function). You get back a package set with options to build your
package as either a library or an executable. If you are building a library, you
can choose to include the source code or not (including the source code is
helpful for editor integrations when developing against the library). Here's a
snippet illustrating building a library with source code included:
let myPkg = packageset.buildIdris {
ipkgName = "my-pkg";
src = ./.;
idrisLibraries = [];
};
in myPkg.library { withSource = true; }The three arguments shown above are required. Note that the ipkgName is the
exact name of the ipkg file without a file extension. You can pass
buildIdris any other arguments supported by mkDerivation as well. Commonly
this may include passing a C library required at runtime to the buildInputs.
If you'd like to build an executable, replace myPkg.library {...} with
myPkg.executable. If you'd like to build a library and not include the source
code, you can omit the withSource argument which will default to false:
myPkg.library {}.
If your package depends on other Idris2 packages, build them with buildIdris
and pass them in the idrisLibraries list. If you need to use other packages
that are already a part of the package set, you can include them even more
readily; for example, including the ncurses-idris library looks like:
idrisLibraries = [ packageset.idris2Packages.ncurses-idris ].
In addition to surfacing the buildIdris function, this project supports
buildIdris'. The latter will attempt to do the following:
ipkg file.idrisLibraries of buildIdris.ipkg file has an executable property and call the appropriate
.executable or .library {} attributes of the buildIdris result.This means you probably don't want to set idrisLibraries yourself or you will
overwrite the libraries buildIdris' finds in the package set, but if you need
to add additional libraries (perhaps not all dependencies are found in the
package set) you can still do that with the extraIdrisLibaries argument to
buildIdris'.
See examples/non-flake-build-idris-prime/ for an example using this
convenience function.
You can easily set a dev shell up with the Nixpkgs mkShell function. Pass it
any executables you want to use in your dev shell under the packages argument
and pass it your project's library {} or executable under the inputsFrom
argument.
let
inherit (packageset) idris2 idris2Lsp;
myPkg = import ./my-pkg.nix;
in
pkgs.mkShell {
packages = [
idris2
idris2Lsp
];
inputsFrom = [
myPkg.executable
];
}If you are going to work on an Idris2 package for which no shell.nix file exists
ahead of time, there is an experimental flake-based command you can run to get
idris2 and idris2-lsp set up for a project in the current directory along
with all dependencies built and available. The following only works trivially if
there is exactly one ipkg file in the current directory.
nix develop --impure --expr '(builtins.getFlake "github:mattpolzin/nix-idris2-packages").impureShell'It's a bit of a mouthful, but that'll spin up a new developer shell.
Although you do need the flakes experimental feature enabled either way, you can
run the same expression with nix-shell if you prefer:
nix-shell --expr '(builtins.getFlake "github:mattpolzin/nix-idris2-packages").impureShell'To update to the package set & package versions to the latest Pack has to offer,
run the update.sh script from the root of the repository.
To add new packages to this packageset, please add them to Pack's package database. New packages in Pack's database will automatically be pulled into this Nix packageset each night.