Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes #61

undu · 2020-09-17T15:01:27Z

Some ocaml extensions share the same vim filetype. This is an issue when trying to enable structural highlighting using the official ocaml tree-sitter parsers: https://github.com/tree-sitter/tree-sitter-ocaml on neovim.

In tree-sitter-ocaml there are two parsers, oner for implementation files and another for interfaces. Initially there was a single, shared one but this caused conflicts in the grammar, so it was split. The current situation makes the nvim-plugin to interpret all ocaml files as implementation files, having a separate filetype for interfaces solves the issue.

This PR adds the new filetype and at the same time tries to maintain previous behaviour, so only external plugins and scripts depending on the ocaml filetype would be affected.

The change breaks current vim plugins that only expect a single filetype for all those kind of files, this includes ocaml/merlin, for example.

The plan to have a smooth transition is:

The same situation happens with ocamllex files. And although there's not a tree-sitter syntax for ocamlyacc/menhir, I've split it to the menhir filetype to avoid merlin from parsing them.

mmottl · 2020-10-11T15:21:54Z

I've only done a short test of these changes, and there is still need for some improvements. The syntax highlighting of .mli files does not work with regular Vim. The syntax is set to ocamlinterface, but there is no such syntax file. I don't know how exactly this problem should be solved in a way that still fixes your issue. You may want to test the changes with regular Vim, too, to make sure that its users can upgrade seamlessly.

undu · 2020-10-11T16:20:16Z

The syntax is set to ocamlinterface, but there is no such syntax file.

Sorry I didn't create the file(s), I tested it on neovim and highlighting was working as expected.
I've added them and loaded the ocaml syntax file in a similar way to how cpp does it: https://github.com/vim/vim/blob/master/runtime/syntax/cpp.vim#L13

mmottl · 2020-10-11T22:50:03Z

Thanks, the highlighting of interface files is now working again. Another problem I've just run into is that syntax errors are not being highlighted anymore by Ale in interface files. I suppose it would require changes to some Vim-packages to fully support the proposed changes.

I'm not sure how much work it would be to update other packages. I believe it could even be done before we merge these changes, which would otherwise cause problems for some people.

If at all possible, maybe it would be best to allow tree-sitter to depend on flags other than the Vim filetype? This may allow you to add full OCaml support without breaking 3rd party Vim packages.

undu · 2020-10-11T23:08:30Z

If at all possible, maybe it would be best to allow tree-sitter to depend on flags other than the Vim filetype?

I'll ask around the tree-sitter community, I'm not sure if that's possible (or wanted)

I don't mind spending some effort making other plugins compatible to get this PR integrated. I think it's valuable to have a more accurate filetype for these different types of files. I've read people complaining about existing syntax problems for menhir files, having separate syntax might even be useful to fix it in the long term.

mmottl · 2020-10-11T23:16:30Z

Sounds reasonable. It may be a good idea long term to have different filetypes for interface and implementation files as well as for other files that incorporate OCaml code.

Since the proposed changes are conceivably intrusive, I should probably not be the only person to weigh in on that. Any other suggestions or opinions here on how to proceed?

copy · 2020-11-09T20:30:43Z

I do think this is the right way forward, since it also fixes several oddities that vim users come across every now and then:

merlin (at least via ale) tries to check mll and mly files, even though it doesn't have support for these
it's not possible to have different syntax colouring between ml and mli files, for example to make comments more readable in interface files

I would suggest announcing this change ahead of time on discuss.ocaml.org and/or the mailing lists to make people aware of this breaking change and give some time for other plugins to merge support for the new filetypes.

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

These are ocamlinterface, ocamllex and menhir. This is in preparation when these filetypes will be introduced in order to keep lsp working on them. The change is backwards compatible. For more information about the rationale of this change please read ocaml/vim-ocaml#61

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

This is needed for supporting the tree-sitter parsers in ocaml because the interface parser is different from the implementation one one.

edwintorok · 2022-04-25T20:17:42Z

FWIW neovim-lsp-config uses "ocaml.ocamllex" and "ocaml.menhir" and "ocaml.interface".
I agree that it is nice to separate menhir/ocamllex out of the ocaml filetype, because curently if you use ocaml-lsp-server together with .mll or .mly files you get lots of warnings/errors because it tries to parse it as pure OCaml:
https://github.com/neovim/nvim-lspconfig/blob/8c9962bae5ac3b1f8b3d84c18314325f2d8df7fd/lua/lspconfig/server_configurations/ocamllsp.lua#L18
They got introduced in neovim/nvim-lspconfig@b9e79ca refering to this PR, but is the . incorrect? (this PR doesn't have a . in the filetype).

undu · 2022-04-25T20:53:05Z

They got introduced in neovim/nvim-lspconfig@b9e79ca refering to this PR, but is the . incorrect? (this PR doesn't have a . in the filetype).

It's correct, that mapping is needed to translate between the vim filetype (key) and the filetype reported by LSP (the value)

rgrinberg · 2022-04-26T01:42:06Z

@undu is this PR ready for review?

undu · 2022-04-26T04:05:42Z

The merlin PR should be reviewed first: ocaml/merlin#1340

Please do test the branch and let me know if you find anything broken

edwintorok · 2022-05-02T22:44:57Z

I have tested this with NeoVim v0.6.1 and the new filetype detection didn't take effect (when vim-ocaml is used as a plugin). That is because filetype.vim in Neovim itself already has an autocommand that assigns a filetype to *.mll and *.mli and the ocamllex.vim in this PR uses setf which only sets the filetype if it has not been set already.

Changing ocamlinterface.vim to this makes it detect the new filetype though:

au BufNewFile,BufRead *.mli,*.mlip,*.mli.cppo set ft=ocamlinterface

I haven't tested NeoVim 0.7 yet which adds a filetype.lua (and changes how filetypes are detected instead of having N autocommands for each filetype it has one autocommand that triggers on all BufNewFile,BufRead and then checks the extension there and decides, this mode is not yet active by default though). Overriding the filetype should in theory work with both approaches.

OCamllex and menhir I can't really test yet:

ocamllex treesitter seems to require Neovim 0.7 because it requires grammar generation (I'll be able to test this after I upgrade). Without tree sitter there is no syntax highlighting for it though
menhir seems to have no tree sitter or traditional syntax highlighting

Prior to this PR I did get some highlighting for both .mll and .mly but it was often slightly wrong.

More information on how filetype works in Neovim is available here: https://neovim.io/doc/user/filetype.html#new-filetype, and for Vim here http://vimdoc.sourceforge.net/htmldoc/filetype.html#new-filetype

Now ocamlinterface ocamllex and menhir types must be taken into account as well. Menhir filetype is not included as there seem to be no plans to include it and even then it would take a big effort. The filetypes are introduced by ocaml/vim-ocaml#61

undu mentioned this pull request Oct 1, 2020

Add ocamllex highlights nvim-treesitter/nvim-treesitter#549

Merged

undu force-pushed the ocaml_interface branch from 6b34d73 to 51e03f5 Compare October 9, 2020 13:54

undu changed the title ~~[RFC] Use ocamlinterface filetype for mli files~~ Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes Oct 10, 2020

undu force-pushed the ocaml_interface branch from 63a8acc to 33506fe Compare October 11, 2020 16:30

undu mentioned this pull request Nov 10, 2020

ocamllex, ocamlyacc, and menhir support #62

Open

undu force-pushed the ocaml_interface branch from 33506fe to c5ce8dd Compare January 5, 2021 22:29

undu force-pushed the ocaml_interface branch from c5ce8dd to 564856b Compare May 16, 2021 16:50

undu added a commit to undu/merlin that referenced this pull request May 16, 2021

Split the ocaml filetype into several filetypes

38090aa

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu mentioned this pull request May 16, 2021

(vim) Split the ocaml filetype into several filetypes ocaml/merlin#1340

Merged

undu mentioned this pull request May 17, 2021

Add multiple types for ocamllsp neovim/nvim-lspconfig#912

Merged

undu force-pushed the ocaml_interface branch from 564856b to 383e7fa Compare May 19, 2021 18:52

undu added a commit to undu/merlin that referenced this pull request May 19, 2021

Split the ocaml filetype into several filetypes

d5e6399

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu added a commit to undu/merlin that referenced this pull request May 19, 2021

Split the ocaml filetype into several filetypes

c53ba91

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu added a commit to undu/merlin that referenced this pull request May 19, 2021

Split the ocaml filetype into several filetypes

b60b10d

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu added a commit to undu/merlin that referenced this pull request May 19, 2021

Split the ocaml filetype into several filetypes

d2cf766

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu force-pushed the ocaml_interface branch from 383e7fa to 564856b Compare May 22, 2021 09:13

undu mentioned this pull request May 22, 2021

ocaml: prepare for filetype separation, drop ols support dense-analysis/ale#3732

Merged

undu added a commit to undu/merlin that referenced this pull request Jun 19, 2021

Split the ocaml filetype into several filetypes

3d3fe95

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu added a commit to undu/merlin that referenced this pull request Jun 19, 2021

Split the ocaml filetype into several filetypes

d24acb0

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

undu force-pushed the ocaml_interface branch from 564856b to cb21f61 Compare October 31, 2021 16:50

undu added a commit to undu/merlin that referenced this pull request Feb 22, 2022

Split the ocaml filetype into several filetypes

a325109

Now ocamlinterface ocamllex and menhir types must be taken into account as well. The filetypes are introduced by ocaml/vim-ocaml#61

feature: create ocamlinterface filetype for mli files

74dc3c3

This is needed for supporting the tree-sitter parsers in ocaml because the interface parser is different from the implementation one one.

undu added 2 commits February 22, 2022 20:34

feature: create ocamllex filetype for mll files

e176dbc

feature: create menhir filetype for mly files

c187037

undu force-pushed the ocaml_interface branch from cb21f61 to c187037 Compare February 22, 2022 20:34

edwintorok mentioned this pull request May 7, 2022

Override filetypes that already exist in filetype.vim undu/vim-ocaml#1

Open

undu mentioned this pull request Aug 16, 2022

rename ocaml interface filetype nvim-treesitter/nvim-treesitter#3309

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes #61

Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes #61

undu commented Sep 17, 2020 •

edited

Loading

mmottl commented Oct 11, 2020

undu commented Oct 11, 2020 •

edited

Loading

mmottl commented Oct 11, 2020

undu commented Oct 11, 2020

mmottl commented Oct 11, 2020

copy commented Nov 9, 2020

edwintorok commented Apr 25, 2022

undu commented Apr 25, 2022 •

edited

Loading

rgrinberg commented Apr 26, 2022

undu commented Apr 26, 2022 •

edited

Loading

edwintorok commented May 2, 2022

Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes #61

Are you sure you want to change the base?

Use ocamlinterface (mli), ocamllex (mll) and menhir (mly) filetypes #61

Conversation

undu commented Sep 17, 2020 • edited Loading

mmottl commented Oct 11, 2020

undu commented Oct 11, 2020 • edited Loading

mmottl commented Oct 11, 2020

undu commented Oct 11, 2020

mmottl commented Oct 11, 2020

copy commented Nov 9, 2020

edwintorok commented Apr 25, 2022

undu commented Apr 25, 2022 • edited Loading

rgrinberg commented Apr 26, 2022

undu commented Apr 26, 2022 • edited Loading

edwintorok commented May 2, 2022

undu commented Sep 17, 2020 •

edited

Loading

undu commented Oct 11, 2020 •

edited

Loading

undu commented Apr 25, 2022 •

edited

Loading

undu commented Apr 26, 2022 •

edited

Loading