如何使用ocamlbuild构建基于utop的自定义toplevel？

嘿，我之前也碰到过这种两难的情况——一边是已经搭建好的ocamlbuild项目，一边是想要的utop交互体验，其实不用二选一，也不用走ocamlfind那条官方不推荐的路，下面给你两种可行的方案：

ocamlbuild的扩展性其实很强，我们可以通过myocamlbuild.ml文件给它加个自定义规则，让它能生成带utop功能的toplevel。

1. 创建/修改项目根目录的myocamlbuild.ml #

把下面的代码复制进去，它会告诉ocamlbuild如何处理.mltop文件并生成utop版本的toplevel：

open Ocamlbuild_plugin

let () =
  dispatch (function
    | After_rules ->
        (* 定义utop toplevel的生成规则 *)
        rule "utop: mktop -> utop executable"
          ~prod:"%.utop"
          ~dep:"%.mltop"
          (fun env _build ->
             let source_mktop = env "%.mltop" in
             let target_utop = env "%.utop" in
             Cmd(S[
               Sh"ocamlfind";
               A"ocamlmktop";
               A"-package"; A"utop";
               A"-linkpkg";
               P source_mktop;
               A"-o"; P target_utop
             ]));
    | _ -> ())

2. 准备你的.mltop文件 #

假设你已经有一个my_project.mltop文件（如果没有就新建一个），里面列出你希望在toplevel中预加载的模块，比如：

MyCoreModule
MyUtilsModule

替换成你项目里实际需要的模块名就行。

3. 编译并运行 #

在终端执行编译命令：

ocamlbuild my_project.utop

编译完成后，直接运行生成的可执行文件：

./my_project.utop

这下你就能进入带自动补全、历史记录、语法高亮等utop特性的toplevel了，而且预加载了你指定的所有模块。

如果不想修改ocamlbuild的配置，还有个更轻量的临时方案：

1. 先用ocamlbuild生成默认的标准toplevel：

ocamlbuild my_project.byte

2. 运行这个toplevel，然后在交互环境里手动加载utop：

# #use "topfind";;
# #require "utop";;
# #utop;;

执行完#utop;;后就会切换到utop的交互环境，缺点是每次启动都要手动输入这几行，适合临时测试场景。

如果你的项目还处于初期，没有大量依赖ocamlbuild的自定义规则，那么切换到dune（也就是之前的jbuilder）确实是更省心的选择——dune对utop的支持是原生的，只需要在dune文件里加几行配置就能生成utop toplevel。但如果你的项目已经基于ocamlbuild搭建得比较完善了，上面的自定义规则方案完全能满足需求，没必要折腾迁移。

内容的提问来源于stack exchange，提问作者vog