feature: load modules in the repl #5940

rgrinberg · 2022-06-30T16:59:37Z

This PR introduces the $ dune ocaml top-level src/module.ml command. The purpose of this command is to load a particular module for interactive development. The way it differs from the other toplevel commands is that it only build the minimal amount needed to load a particular module and then it evaluates the module's source with #use. The point of this is to avoid sealing the module with the mli and thereby allowing interactive development with all the private parts of the module.

@ulugbekna this should work nicely for vscode

nojb · 2022-06-30T17:03:04Z

What's the relation between this PR and dune top ?

rgrinberg · 2022-06-30T17:05:10Z

What's the relation between this PR and dune top ?

Just updated the PR description.

ejgallego · 2022-07-04T15:45:55Z

I guess this needs documentation, right?

rgrinberg · 2022-07-04T15:54:03Z

I guess this needs documentation, right?

Do you think we need something in the online manual or is the man page enough?

ejgallego · 2022-07-04T16:39:55Z

I guess this needs documentation, right?

Do you think we need something in the online manual or is the man page enough?

Leaving this to doc experts, but I see dune utop appears in usage.rst , so maybe worth mentioning it too?

emillon · 2022-07-04T16:45:17Z

Sidenote, dune ocaml subcommands are not very discoverable. So I agree that a quick mention would be useful:

% dune ocaml       
dune ocaml: is a command group and requires a command argument.
Usage: dune ocaml [OPTION]... 
Try `dune ocaml --help' or `dune --help' for more information.
 % dune ocaml --help=plain
NAME
       dune-ocaml

SYNOPSIS
       dune ocaml [OPTION]... 

OPTIONS
       --help[=FMT] (default=auto)
           Show this help in format FMT. The value FMT must be one of `auto',
           `pager', `groff' or `plain'. With `auto', the format is `pager` or
           `plain' whenever the TERM env var is `dumb' or undefined.

       --version
           Show version information.

christinerose

Two minor capitalisations.

doc/toplevel-integration.rst

bin/top.ml

ejgallego · 2022-07-05T09:30:17Z

bin/top.ml

+      res
+    in
+    let* dir_contents =
+      drop_rules @@ fun () -> Dune_rules.Dir_contents.get sctx ~dir


What is drop_rules doing here?

The function returns the rules in addition, but we don't need the rules since they've already been setup.

ejgallego

LGTM

rgrinberg · 2022-07-09T14:47:03Z

Does the work with dialects?

Let me give this a try. Although I would say that this issue isn't blocking the PR.

Does it make sense to consider a utop version of the command which would launch utop directly, in the same way as dune utop does?

We could add this if there's demand for it. I personally preferred the approach of building the toplevel binary ourself, but Jeremie liked doing everything through directives more.

Also in the same direction, if indeed we have both "top" and "utop" variations of the command, does it make sense to extend those commands, intead of dune ocaml?

I would say that we should deprecate dune top and dune utop and stick to the dune ocaml subcommand for all this stuff.

There's still a few issues with this PR btw:

It doesn't evaluate -open Alias__module__ in the toplevel
It doesn't load the warnings flags from the stanza.
This is the biggest problem: #directory $stanza/obj_dir contains stale artifacts that lead to some inconsistent assumptions issues.

The first two problems can be fixed with additional directives. Although if we went for the approach of building the toplevel (like dune utop) we wouldn't even this stuff :/

To solve the 3rd problem, we must prepare an object directory free of stale artifacts. The simplest way to do that is just to copy the objects into some temp dir and use that. A more clever way is to introduce rules for each modules that will setup the subdirectory with only the relevant artifacts.

bin/top.ml

emillon · 2022-07-20T13:49:40Z

@rgrinberg I was about to include it into 3.4 even with the limitations you mentioned but happy to postpone to 3.5.

rgrinberg · 2022-07-20T13:51:25Z

The issue with the stale artifacts makes this feature not very ergonomic at the moment unfortunately. I'd rather solve this issue first

rgrinberg · 2022-08-04T00:58:15Z

Sidenote, dune ocaml subcommands are not very discoverable. So I agree that a quick mention would be useful:

That's actually due to a bug with our fork of cmdliner. Once we update our version of cmdliner, the per command docs should appear.

rgrinberg · 2022-11-03T21:18:03Z

src/dune_rules/ml_sources.ml

+        [ `Library of Dune_file.Library.t
+        | `Executables of Dune_file.Executables.t
+        ]
+        Module_name.Map.t


fyi @jchavarri

ftr: Merged into 8b1d684

introduce a $ dune ocaml top-module command to load modules directly Signed-off-by: Rudi Grinberg <[email protected]> ps-id: 79f4ac2d-0e7b-4983-9bee-c410d534bc8e

@rgrinberg

…ne-site, dune-rpc, dune-rpc-lwt, dune-private-libs, dune-glob, dune-configurator, dune-build-info, dune-action-plugin and chrome-trace (3.6.0) CHANGES: - Forbid multiple instances of dune running concurrently in the same workspace. (ocaml/dune#6360, fixes ocaml/dune#236, @rgrinberg) - Allow promoting into source directories specified by `subdir` (ocaml/dune#6404, fixes ocaml/dune#3502, @rgrinberg) - Make dune describe workspace return the correct root path (ocaml/dune#6380, fixes ocaml/dune#6379, @esope) - Introduce a `$ dune ocaml top-module` subcommand to load modules directly without sealing them behind the signature. (ocaml/dune#5940, @rgrinberg) - [ctypes] do not mangle user written names in the ctypes stanza (ocaml/dune#6374, fixes ocaml/dune#5561, @rgrinberg) - Support `CLICOLOR` and `CLICOLOR_FORCE` to enable/disable/force ANSI colors. (ocaml/dune#6340, fixes ocaml/dune#6323, @MisterDA). - Forbid private libraries with `(package ..)` set from depending on private libraries that don't belong to a package (ocaml/dune#6385, fixes ocaml/dune#6153, @rgrinberg) - Allow `Byte_complete` binaries to be installable (ocaml/dune#4873, @AltGr, @rgrinberg) - Revive `$ dune external-lib-deps` under `$ dune describe external-lib-deps`. (ocaml/dune#6045, @moyodiallo) - Fix running inline tests in bytecode mode (ocaml/dune#5622, fixes ocaml/dune#5515, @dariusf) - [ctypes] always re-run `pkg-config` because we aren't tracking its external dependencies (ocaml/dune#6052, @rgrinberg) - [ctypes] remove dependency on configurator in the generated rules (ocaml/dune#6052, @rgrinberg) - Build progress status now shows number of failed jobs (ocaml/dune#6242, @Alizter) - Allow absolute build directories to find public executables. For example, those specified with `(deps %{bin:...})` (ocaml/dune#6326, @anmonteiro) - Create a fake socket file `_build/.rpc/dune` on windows to allow rpc clients to connect using the build directory. (ocaml/dune#6329, @rgrinberg) - Prevent crash if absolute paths are used in the install stanza and in recursive globs. These cases now result in a user error. (ocaml/dune#6331, @gridbugs) - Add `(glob_files <glob>)` and `(glob_files_rec <glob>)` terms to the `files` field of the `install` stanza (ocaml/dune#6250, closes ocaml/dune#6018, @gridbugs) - Allow `:standard` in the `(modules)` field of the `coq.pp` stanza (ocaml/dune#6229, fixes ocaml/dune#2414, @Alizter) - Fix passing of flags to dune coq top (ocaml/dune#6369, fixes ocaml/dune#6366, @Alizter) - Extend the promotion CLI to a `dune promotion` group: `dune promote` is moved to `dune promotion apply` (the former still works) and the new `dune promotion diff` command can be used to just display the promotion without applying it. (ocaml/dune#6160, fixes ocaml/dune#5368, @emillon)

rgrinberg requested review from nojb, emillon and Alizter June 30, 2022 17:05

rgrinberg added this to the 3.4.0 milestone Jun 30, 2022

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch 11 times, most recently from 4228460 to c6c0096 Compare July 1, 2022 22:18

emillon approved these changes Jul 4, 2022

View reviewed changes

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch 3 times, most recently from 0e86fb6 to fe8b0f7 Compare July 4, 2022 22:58

rgrinberg requested a review from christinerose as a code owner July 4, 2022 22:58

christinerose approved these changes Jul 5, 2022

View reviewed changes

doc/toplevel-integration.rst Show resolved Hide resolved

ejgallego reviewed Jul 5, 2022

View reviewed changes

bin/top.ml Outdated Show resolved Hide resolved

ejgallego reviewed Jul 5, 2022

View reviewed changes

ejgallego approved these changes Jul 5, 2022

View reviewed changes

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch from fe8b0f7 to e04fd0d Compare July 19, 2022 18:03

emillon reviewed Jul 20, 2022

View reviewed changes

bin/top.ml Show resolved Hide resolved

bin/top.ml Outdated Show resolved Hide resolved

bin/top.ml Outdated Show resolved Hide resolved

bin/top.ml Show resolved Hide resolved

emillon force-pushed the ps/rr/feature__load_modules_in_the_repl branch 5 times, most recently from 7279d02 to ab352d4 Compare July 20, 2022 13:47

rgrinberg modified the milestones: 3.4.0, 3.5.0 Jul 20, 2022

christinerose approved these changes Aug 4, 2022

View reviewed changes

rgrinberg modified the milestones: 3.5.0, 3.6.0 Oct 5, 2022

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch from ab352d4 to 371d15a Compare November 3, 2022 17:35

rgrinberg commented Nov 3, 2022

View reviewed changes

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch 6 times, most recently from 8c3d5cb to d0aaeae Compare November 3, 2022 21:56

feature: load modules in the toplevel

1bc4e91

introduce a $ dune ocaml top-module command to load modules directly Signed-off-by: Rudi Grinberg <[email protected]> ps-id: 79f4ac2d-0e7b-4983-9bee-c410d534bc8e

rgrinberg force-pushed the ps/rr/feature__load_modules_in_the_repl branch from d0aaeae to 1bc4e91 Compare November 3, 2022 22:16

rgrinberg merged commit 8a59adf into main Nov 3, 2022

Alizter deleted the ps/rr/feature__load_modules_in_the_repl branch November 12, 2022 15:11

emillon mentioned this pull request Nov 14, 2022

[new release] xdg, stdune, ordering, ocamlc-loc, fiber, dyn, dune, dune-site, dune-rpc, dune-rpc-lwt, dune-private-libs, dune-glob, dune-configurator, dune-build-info, dune-action-plugin and chrome-trace (3.6.0) ocaml/opam-repository#22498

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: load modules in the repl #5940

feature: load modules in the repl #5940

rgrinberg commented Jun 30, 2022 •

edited

Loading

nojb commented Jun 30, 2022

rgrinberg commented Jun 30, 2022 •

edited

Loading

ejgallego commented Jul 4, 2022

rgrinberg commented Jul 4, 2022

ejgallego commented Jul 4, 2022

emillon commented Jul 4, 2022

christinerose left a comment

ejgallego Jul 5, 2022

rgrinberg Nov 3, 2022

ejgallego left a comment

rgrinberg commented Jul 9, 2022

emillon commented Jul 20, 2022

rgrinberg commented Jul 20, 2022

rgrinberg commented Aug 4, 2022

rgrinberg Nov 3, 2022

jchavarri Nov 4, 2022

feature: load modules in the repl #5940

feature: load modules in the repl #5940

Conversation

rgrinberg commented Jun 30, 2022 • edited Loading

nojb commented Jun 30, 2022

rgrinberg commented Jun 30, 2022 • edited Loading

ejgallego commented Jul 4, 2022

rgrinberg commented Jul 4, 2022

ejgallego commented Jul 4, 2022

emillon commented Jul 4, 2022

christinerose left a comment

Choose a reason for hiding this comment

ejgallego Jul 5, 2022

Choose a reason for hiding this comment

rgrinberg Nov 3, 2022

Choose a reason for hiding this comment

ejgallego left a comment

Choose a reason for hiding this comment

rgrinberg commented Jul 9, 2022

emillon commented Jul 20, 2022

rgrinberg commented Jul 20, 2022

rgrinberg commented Aug 4, 2022

rgrinberg Nov 3, 2022

Choose a reason for hiding this comment

jchavarri Nov 4, 2022

Choose a reason for hiding this comment

rgrinberg commented Jun 30, 2022 •

edited

Loading

rgrinberg commented Jun 30, 2022 •

edited

Loading