ocaml-flake

ocaml-flake uses opam-nix to build ocaml packages. The module structure is inspired by haskell-flake.

Since the flake is fairly new future versions may introduce breaking changes.

Installation

To initialize a new dune project using ocaml-flake simply run:

nix flake init -t github:9glenda/ocaml-flake#simple

This will set up a devshell and package for you.

perSystem.ocaml

Ocaml module

Type: submodule

Default: { }

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects

dune Projects.

Type: attribute set of (submodule)

Default: {}

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.autoWire

What will be added to the flake outputs.

Note for dev shells nix will create a dev shell from the default package in case no dev shell is specified.

Type: list of (one of “devShell”, “package”)

Default: ["devShell" "package"]

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.enable

Create a dev shell for the project. The devShell is located in ocaml.dunePackage.<name>.outputs.devShell. To automatically add the dev shell to the outputs of the flake add "devshell" to autoWire.

Type: boolean

Default: true

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.extraPackages

Extra packages to install into the dev shell alongside the opamPackages.

Type: list of package

Default: []

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.inputsFromPackage

Take inputs from the package.

Type: boolean

Default: true

Example: false

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.mkShellArgs

Extra arguments to pass to pkgs.mkShell.

The already set arguments get overwritten. It’s implemented like this:

  pkgs.mkShell ({ ... } // mkShellArgs)

Type: attribute set of raw value

Default: { }

Example:

''
  {
    shellHook = \'\'
      echo "example shell hook"
    \'\';
  };
''

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.name

name of the devShell

Type: string

Default: " development development shell"

Declared by:

ocaml-flake/flake-module.nix

perSystem.ocaml.duneProjects.<name>.devShell.opamPackages

development packages like the lsp and ocamlformat. Those packages get installed in the dev shell too. If the devShell is disabled this option will be ignored.

Type: attribute set of (null or string)

Default:

{
                  ocaml-lsp-server = "1.16.2";
                  ocamlformat = "0.26.1";
                  utop = "2.13.1";
                  ocamlfind = "1.9.6";
                }

Declared by: