Skip to content

nix: devShell for oxcaml #12582

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2025
+288 −26
Merged

nix: devShell for oxcaml #12582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
96 changes: 95 additions & 1 deletion flake.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

142 changes: 117 additions & 25 deletions flake.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@
url = "github:nix-ocaml/nix-overlays";
inputs.nixpkgs.follows = "nixpkgs";
};
oxcaml = {
url = "github:oxcaml/oxcaml";
inputs.nixpkgs.follows = "nixpkgs";
};
oxcaml-opam-repository = {
url = "github:oxcaml/opam-repository";
flake = false;
};
};
outputs =
{
Expand All @@ -18,6 +26,8 @@
nixpkgs,
melange,
ocaml-overlays,
oxcaml,
oxcaml-opam-repository,
}:
flake-utils.lib.eachDefaultSystem (
system:
Expand Down Expand Up @@ -46,6 +56,13 @@
});
})
];

applyOxcamlPatches = import ./nix/ox-patches.nix {
inherit pkgs;
lib = pkgs.lib;
oxcamlOpamRepo = oxcaml-opam-repository;
};

dune-static-overlay = self: super: {
ocamlPackages = super.ocaml-ng.ocamlPackages_5_3.overrideScope (
oself: osuper: {
Expand Down Expand Up @@ -174,10 +191,29 @@
extraBuildInputs ? (pkgs: [ ]),
meta ? null,
duneFromScope ? false,
includeTestDeps ? true,
packageOverrides ? (oself: osuper: { }),
}:
let
hasOcamlOverride = (packageOverrides { } { ocaml = null; }) ? ocaml;

pkgs' =
if duneFromScope then
if hasOcamlOverride then
pkgs.extend (
pself: psuper: {
ocamlPackages = psuper.ocamlPackages.overrideScope (
oself: osuper:
(pkgs.lib.mapAttrs
(name: pkg:
if pkgs.lib.isDerivation pkg && pkg ? overrideAttrs
then pkg.overrideAttrs (old: { doCheck = false; })
else pkg)
osuper)
// (packageOverrides oself osuper)
);
}
)
else if duneFromScope then
pkgs.extend (
pself: psuper: {
ocamlPackages = psuper.ocamlPackages.overrideScope (
Expand All @@ -196,39 +232,45 @@
#!${stdenv.shell}
"$DUNE_SOURCE_ROOT"/_boot/dune.exe $@
'';

baseInputs = if includeTestDeps then (testNativeBuildInputs pkgs') ++ docInputs else [ ];

ocamlLibs = if includeTestDeps then
(with pkgs'.ocamlPackages; [
ctypes
cinaps
integers
lwt
mdx
menhir
merlin
ocaml-index
ocaml-lsp
odoc
patdiff
ppx_expect
re
spawn
uutf
])
else
[ ];
in

pkgs'.mkShell {
shellHook = ''
export DUNE_SOURCE_ROOT=$PWD
'';
inherit meta;
nativeBuildInputs = (testNativeBuildInputs pkgs') ++ docInputs ++ [ duneScript ];
inputsFrom = [ pkgs'.ocamlPackages.dune_3 ];
nativeBuildInputs = baseInputs ++ [ duneScript ] ++ (if hasOcamlOverride then [ pkgs'.ocamlPackages.ocaml ] else [ ]);
inputsFrom = if hasOcamlOverride then [ ] else [ pkgs'.ocamlPackages.dune_3 ];
buildInputs =
testBuildInputs
++ (
with pkgs'.ocamlPackages;
[
ctypes
cinaps
integers
lwt
mdx
menhir
merlin
ocaml-index
ocaml-lsp
odoc
patdiff
ppx_expect
re
spawn
uutf
]
++ (extraBuildInputs pkgs')
);
(if includeTestDeps then testBuildInputs else [ ])
++ ocamlLibs
++ (extraBuildInputs pkgs')
++ (if hasOcamlOverride then [ pkgs'.ocamlPackages.findlib ] else [ ]);
inherit INSIDE_NIX;
dontDetectOcamlConflicts = hasOcamlOverride;
};
in
{
Expand Down Expand Up @@ -333,6 +375,56 @@
'';
};

bootstrap-ox = pkgs.mkShell {
inherit INSIDE_NIX;
buildInputs = [
pkgs.gnumake
oxcaml.packages.${system}.default
];
meta.description = ''
Provides a minimal shell environment with OxCaml in order to
test the bootstrapping script.
'';
};

ox-minimal = makeDuneDevShell {
includeTestDeps = false;
packageOverrides = oself: osuper:
(applyOxcamlPatches oself osuper) // {
# dune_3 = self.packages.${system}.default;
ocaml = oxcaml.packages.${system}.default.overrideAttrs (old: {
passthru = (old.passthru or { }) // pkgs.ocamlPackages.ocaml.passthru;
meta = (old.meta or { }) // pkgs.ocamlPackages.ocaml.meta;
});
spawn = osuper.spawn.overrideAttrs (old: { doCheck = false; });
};
extraBuildInputs = pkgs: with pkgs.ocamlPackages; [
re
spawn
uutf
findlib
];
meta.description = ''
Provides a minimal shell environment with OxCaml in order to
run the OxCaml tests.
'';
};

ox = makeDuneDevShell {
packageOverrides = oself: osuper:
(applyOxcamlPatches oself osuper) // {
dune_3 = self.packages.${system}.default;
ocaml = oxcaml.packages.${system}.default.overrideAttrs (old: {
passthru = (old.passthru or { }) // pkgs.ocamlPackages.ocaml.passthru;
meta = (old.meta or { }) // pkgs.ocamlPackages.ocaml.meta;
});
};
meta.description = ''
Provides a full shell environment with the OxCaml compiler to
develop with Dune. Warning: does not work.
'';
};

microbench = makeDuneDevShell {
extraBuildInputs = pkgs: [
pkgs.ocamlPackages.core_bench
Expand Down
Loading
Loading