2021-01-05 17:05:55 +00:00
# Idris {#idris}
2020-04-24 23:36:52 +00:00
2021-06-28 23:13:55 +00:00
## Installing Idris {#installing-idris}
2020-04-24 23:36:52 +00:00
The easiest way to get a working idris version is to install the `idris` attribute:
2021-06-28 23:13:55 +00:00
```ShellSession
2021-12-21 02:18:32 +00:00
$ nix-env -f "< nixpkgs > " -iA idris
2020-04-24 23:36:52 +00:00
```
This however only provides the `prelude` and `base` libraries. To install idris with additional libraries, you can use the `idrisPackages.with-packages` function, e.g. in an overlay in `~/.config/nixpkgs/overlays/my-idris.nix` :
```nix
self: super: {
myIdris = with self.idrisPackages; with-packages [ contrib pruviloj ];
}
```
And then:
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ # On NixOS
$ nix-env -iA nixos.myIdris
$ # On non-NixOS
$ nix-env -iA nixpkgs.myIdris
```
To see all available Idris packages:
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ # On NixOS
$ nix-env -qaPA nixos.idrisPackages
$ # On non-NixOS
$ nix-env -qaPA nixpkgs.idrisPackages
```
Similarly, entering a `nix-shell` :
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
```
2021-06-28 23:13:55 +00:00
## Starting Idris with library support {#starting-idris-with-library-support}
2020-04-24 23:36:52 +00:00
To have access to these libraries in idris, call it with an argument `-p <library name>` for each library:
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ nix-shell -p 'idrisPackages.with-packages (with idrisPackages; [ contrib pruviloj ])'
[nix-shell:~]$ idris -p contrib -p pruviloj
```
A listing of all available packages the Idris binary has access to is available via `--listlibs` :
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ idris --listlibs
00prelude-idx.ibc
pruviloj
base
contrib
prelude
00pruviloj-idx.ibc
00base-idx.ibc
00contrib-idx.ibc
```
2021-06-28 23:13:55 +00:00
## Building an Idris project with Nix {#building-an-idris-project-with-nix}
2020-04-24 23:36:52 +00:00
As an example of how a Nix expression for an Idris package can be created, here is the one for `idrisPackages.yaml` :
```nix
2021-02-05 17:12:51 +00:00
{ lib
, build-idris-package
2020-04-24 23:36:52 +00:00
, fetchFromGitHub
, contrib
, lightyear
}:
build-idris-package {
name = "yaml";
version = "2018-01-25";
# This is the .ipkg file that should be built, defaults to the package name
# In this case it should build `Yaml.ipkg` instead of `yaml.ipkg`
# This is only necessary because the yaml packages ipkg file is
# different from its package name here.
ipkgName = "Yaml";
# Idris dependencies to provide for the build
idrisDeps = [ contrib lightyear ];
src = fetchFromGitHub {
owner = "Heather";
repo = "Idris.Yaml";
rev = "5afa51ffc839844862b8316faba3bafa15656db4";
2022-12-17 10:02:37 +00:00
hash = "sha256-h28F9EEPuvab6zrfeE+0k1XGQJGwINnsJEG8yjWIl7w=";
2020-04-24 23:36:52 +00:00
};
2024-04-21 15:54:59 +00:00
meta = {
2020-04-24 23:36:52 +00:00
description = "Idris YAML lib";
homepage = "https://github.com/Heather/Idris.Yaml";
2024-04-21 15:54:59 +00:00
license = lib.licenses.mit;
maintainers = [ lib.maintainers.brainrape ];
2020-04-24 23:36:52 +00:00
};
}
```
Assuming this file is saved as `yaml.nix` , it's buildable using
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ nix-build -E '(import < nixpkgs > {}).idrisPackages.callPackage ./yaml.nix {}'
```
Or it's possible to use
```nix
with import < nixpkgs > {};
{
yaml = idrisPackages.callPackage ./yaml.nix {};
}
```
in another file (say `default.nix` ) to be able to build it with
2021-06-28 23:13:55 +00:00
```ShellSession
2020-04-24 23:36:52 +00:00
$ nix-build -A yaml
```
2021-06-28 23:13:55 +00:00
## Passing options to `idris` commands {#passing-options-to-idris-commands}
2020-04-24 23:36:52 +00:00
The `build-idris-package` function provides also optional input values to set additional options for the used `idris` commands.
Specifically, you can set `idrisBuildOptions` , `idrisTestOptions` , `idrisInstallOptions` and `idrisDocOptions` to provide additional options to the `idris` command respectively when building, testing, installing and generating docs for your package.
For example you could set
2021-04-05 15:23:46 +00:00
```nix
2020-04-24 23:36:52 +00:00
build-idris-package {
2024-04-21 15:54:59 +00:00
idrisBuildOptions = [ "--log" "1" "--verbose" ];
2020-04-24 23:36:52 +00:00
2024-04-21 15:54:59 +00:00
# ...
2020-04-24 23:36:52 +00:00
}
```
to require verbose output during `idris` build phase.