New `ocaml-merlin` subcommand acting as a configuration server for next Merlin by voodoos · Pull Request #3395 · ocaml/dune

voodoos · 2020-04-20T14:41:15Z

This PR adds a new ocaml-merlin subcommand to Dune.

Behavior

When started (usually by merlin) this program will wait for input on stdin, When it receives a request for a files' configuration it will read the content of the corresponding merlin configuration file and print it to stdout. The empty list is returned if no configuration is found.

Each message is formed with one canonical s-expression. The test contain an example of a dialogue between Merlin and this configuration server, the most important part being:

  $ dune ocaml-merlin

  input:   
    (4:File9:/project_path/main.ml)

  output: 
    (
     (17:EXCLUDE_QUERY_DIR)
     (1:B65:/path/to/some/lib)
     (3:FLG105:-w @1..3@5..28@30..39@43@46..47@49..57@61..62-40 etc)
    )

Future versions of Merlin will check for the presence of a dune or dune-project file in the sources and decide if they should use the standard configuration reader or this new Dune subcommand.

In the future this new behaviour will allow for a finer grained merlin configuration: actual .merlin files work at the folder level while dune will be able to answer precisely for each file.

Breaking changes

This PR disables the promotion of .merlin files to the sources. Thus it is not compatible with actual version of Merlin.

Todo

Correct merlin related tests
Add tests for the new configuration server

voodoos · 2020-05-13T14:31:32Z

This PR is now ready for review.

However it should not be merged before the corresponding changes in Merlin are merged and released. (Before merging the incompatibility with previous versions of Merlin should also be added to the package dependency.)

src/dune/merlin_server.ml

ghost · 2020-05-14T16:16:54Z

@voodoos the PR looks ready to me!

I would just rename Dot to Dot_merlin, and you also need to revert the changes related to the renaming .merlin -> .merlin-conf. You should feel free to merge once this is done.

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

…ver promoted) Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

This reverts commit 868d09c. Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

This reverts commit e1f9724. Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

@bikallem

…lugin, dune-private-libs and dune-glob (2.6.0) CHANGES: - Fix a bug where valid lib names in `dune init exec --libs=lib1,lib2` results in an error. (ocaml/dune#3444, fix ocaml/dune#3443, @bikallem) - Add and `enabled_ if` field to the `install` stanza. Enforce the same variable restrictions for `enabled_if` fields in the `executable` and `install` stanzas than in the `library` stanza. When using dune lang < 2.6, the usage of forbidden variables in executables stanzas with only trigger a warning to maintain compatibility. (ocaml/dune#3408 and ocaml/dune#3496, fixes ocaml/dune#3354, @voodoos) - Insert a constraint one the version of dune when the user explicitly specify the dependency on dune in the `dune-project` file (ocaml/dune#3434 , fixes ocaml/dune#3427, @diml) - Generate correct META files for sub-libraries (of the form `lib.foo`) that contain .js runtime files. (ocaml/dune#3445, @hhugo) - Add a `(no-infer ...)` action that prevents inference of targets and dependencies in actions. (ocaml/dune#3456, fixes ocaml/dune#2006, @roddyyaga) - Correctly infer targets for the `diff?` action. (ocaml/dune#3457, fixes ocaml/dune#2990, @greedy) - Fix `$ dune print-rules` crashing (ocaml/dune#3459, fixes ocaml/dune#3440, @rgrinberg) - Simplify js_of_ocaml rules using js_of_ocaml.3.6 (ocaml/dune#3375, @hhugo) - Add a new `ocaml-merlin` subcommand that can be used by Merlin to get configuration directly from dune instead of using `.merlin` files. (ocaml/dune#3395, @voodoos) - Remove experimental variants feature and make default implementations part of the language (ocaml/dune#3491, fixes ocaml/dune#3483, @rgrinberg)

@bikallem

…lugin, dune-private-libs and dune-glob (2.6.0) CHANGES: - Fix a bug where valid lib names in `dune init exec --libs=lib1,lib2` results in an error. (ocaml/dune#3444, fix ocaml/dune#3443, @bikallem) - Add and `enabled_ if` field to the `install` stanza. Enforce the same variable restrictions for `enabled_if` fields in the `executable` and `install` stanzas than in the `library` stanza. When using dune lang < 2.6, the usage of forbidden variables in executables stanzas with only trigger a warning to maintain compatibility. (ocaml/dune#3408 and ocaml/dune#3496, fixes ocaml/dune#3354, @voodoos) - Insert a constraint one the version of dune when the user explicitly specify the dependency on dune in the `dune-project` file (ocaml/dune#3434 , fixes ocaml/dune#3427, @diml) - Generate correct META files for sub-libraries (of the form `lib.foo`) that contain .js runtime files. (ocaml/dune#3445, @hhugo) - Add a `(no-infer ...)` action that prevents inference of targets and dependencies in actions. (ocaml/dune#3456, fixes ocaml/dune#2006, @roddyyaga) - Correctly infer targets for the `diff?` action. (ocaml/dune#3457, fixes ocaml/dune#2990, @greedy) - Fix `$ dune print-rules` crashing (ocaml/dune#3459, fixes ocaml/dune#3440, @rgrinberg) - Simplify js_of_ocaml rules using js_of_ocaml.3.6 (ocaml/dune#3375, @hhugo) - Add a new `ocaml-merlin` subcommand that can be used by Merlin to get configuration directly from dune instead of using `.merlin` files. (ocaml/dune#3395, @voodoos) - Remove experimental variants feature and make default implementations part of the language (ocaml/dune#3491, fixes ocaml/dune#3483, @rgrinberg)

@bikallem

…lugin, dune-private-libs and dune-glob (2.6.0) CHANGES: - Fix a bug where valid lib names in `dune init exec --libs=lib1,lib2` results in an error. (ocaml/dune#3444, fix ocaml/dune#3443, @bikallem) - Add and `enabled_ if` field to the `install` stanza. Enforce the same variable restrictions for `enabled_if` fields in the `executable` and `install` stanzas than in the `library` stanza. When using dune lang < 2.6, the usage of forbidden variables in executables stanzas with only trigger a warning to maintain compatibility. (ocaml/dune#3408 and ocaml/dune#3496, fixes ocaml/dune#3354, @voodoos) - Insert a constraint one the version of dune when the user explicitly specify the dependency on dune in the `dune-project` file (ocaml/dune#3434 , fixes ocaml/dune#3427, @diml) - Generate correct META files for sub-libraries (of the form `lib.foo`) that contain .js runtime files. (ocaml/dune#3445, @hhugo) - Add a `(no-infer ...)` action that prevents inference of targets and dependencies in actions. (ocaml/dune#3456, fixes ocaml/dune#2006, @roddyyaga) - Correctly infer targets for the `diff?` action. (ocaml/dune#3457, fixes ocaml/dune#2990, @greedy) - Fix `$ dune print-rules` crashing (ocaml/dune#3459, fixes ocaml/dune#3440, @rgrinberg) - Simplify js_of_ocaml rules using js_of_ocaml.3.6 (ocaml/dune#3375, @hhugo) - Add a new `ocaml-merlin` subcommand that can be used by Merlin to get configuration directly from dune instead of using `.merlin` files. (ocaml/dune#3395, @voodoos) - Remove experimental variants feature and make default implementations part of the language (ocaml/dune#3491, fixes ocaml/dune#3483, @rgrinberg)

voodoos mentioned this pull request Apr 21, 2020

External config readers ocaml/merlin#1123

Merged

1 task

voodoos changed the title ~~New ocaml-merlin subcommand acting as a configuration server for next Merlin~~ [WIP] ocaml-merlin subcommand acting as a configuration server for next Merlin Apr 22, 2020

voodoos force-pushed the ocaml-merlin branch 5 times, most recently from 259a2ad to a687879 Compare May 13, 2020 13:31

voodoos marked this pull request as ready for review May 13, 2020 14:31

voodoos requested review from aalekseyev, emillon, nojb and rgrinberg as code owners May 13, 2020 14:31

voodoos force-pushed the ocaml-merlin branch from a687879 to 345afa2 Compare May 13, 2020 15:08

voodoos changed the title ~~[WIP] ocaml-merlin subcommand acting as a configuration server for next Merlin~~ ocaml-merlin subcommand acting as a configuration server for next Merlin May 13, 2020

voodoos changed the title ~~ocaml-merlin subcommand acting as a configuration server for next Merlin~~ New ocaml-merlin subcommand acting as a configuration server for next Merlin May 13, 2020

voodoos force-pushed the ocaml-merlin branch from 345afa2 to f9065a3 Compare May 13, 2020 15:20

ghost reviewed May 14, 2020

View reviewed changes

src/dune/merlin_server.ml Show resolved Hide resolved

ghost reviewed May 14, 2020

View reviewed changes

src/dune/merlin_server.ml Outdated Show resolved Hide resolved

ghost reviewed May 14, 2020

View reviewed changes

src/dune/merlin_server.ml Outdated Show resolved Hide resolved

voodoos added 9 commits May 15, 2020 12:57

Add a simple ocaml-merlin subcommand

c595025

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Implement new merlin_server feedback loop

68956b5

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Disable generation of .merlin files in sources (Break tests)

764da5e

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Rename internal merlin file

d4472ef

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

disable-promotion test does not make sense anymore (.merlin-conf ne…

57c51ae

…ver promoted) Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Refactor

33aef07

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Use correct workspace

33054aa

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Compat with 4.07

a30f6ea

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Reformat

8125c07

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

voodoos added 10 commits May 15, 2020 12:57

Halt on EOF and non-csexp input

b435cbb

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

More doc

ed38b7d

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Add test for new merlin config server

4fcbaf2

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Remove useless line break in output

338ecd3

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Correct comment

ea4e7ed

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Reformat

c50836c

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Rename Dot to Dot_melrin

179d594

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Revert "Disable promotion of .merlin files"

67edcf0

This reverts commit 868d09c. Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Revert renaming of melrin files

a235a50

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

Revert "disable-promotion test suppression"

7d10413

This reverts commit e1f9724. Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

voodoos force-pushed the ocaml-merlin branch from a4bbe22 to 7d10413 Compare May 15, 2020 10:57

Add changelog entry

02bee73

Signed-off-by: Ulysse Gérard <thevoodoos@gmail.com>

voodoos merged commit e5bec1a into ocaml:master May 15, 2020

rgrinberg mentioned this pull request Jun 6, 2020

[new release] dune-build-info, dune, dune-configurator, dune-action-plugin, dune-private-libs and dune-glob (2.6.0) ocaml/opam-repository#16585

Merged

hongchangwu mentioned this pull request Sep 24, 2020

dot-merlin-reader: init at 3.4.0 NixOS/nixpkgs#98603

Merged

10 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

New `ocaml-merlin` subcommand acting as a configuration server for next Merlin#3395

New `ocaml-merlin` subcommand acting as a configuration server for next Merlin#3395
voodoos merged 20 commits intoocaml:masterfrom
voodoos:ocaml-merlin

voodoos commented Apr 20, 2020 •

edited

Loading

Uh oh!

voodoos commented May 13, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented May 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

voodoos commented Apr 20, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Behavior

Breaking changes

Todo

Uh oh!

voodoos commented May 13, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ghost commented May 14, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

voodoos commented Apr 20, 2020 •

edited

Loading