OCaml Changelog

Fixes

• Fix executing ppx executables

Features

• Add better support for code folding: more folds and more precise folds

Fixes

• Fix infer interface code action crash when implementation source does not exist (#597)

• Improve error message when the reason plugin for merlin is absent (#608)

• Fix chdir races when running ppx (#550)

• More accurate completion kinds. New completion kinds for variants and fields. Removed inaccurate completion kinds for constructors and types. (#510)

• Fix handling request cancellation (#616)

Fixes

• Disable functionality reliant on ocamlformat-rpc for now (#555)

• 4.13 compatiblity

• ocaml support
  • add support for 4.13
  • stopped actively supporting version older than 4.12
• merlin binary
  • Mbrowse.select_leaf: correctly ignore merlin.hide (#1376)
  • enable occurrences to work when looking for locally abstract types (#1382)
  • handle -alert compiler flag (#1401)
  • avoid a race condition when the process started to read a configuration file crashes/is not found (#1378, @antalsz)
  • log the backtrace even when the exception is a Failure (#1377, @antalsz)
  • ignore -error-style compiler flag (#1402, @nojb)
  • fix handling of record field expressions (#1375)
  • allow -pp to return an AST (#1394)
  • fix merlin crashing due to short-paths (#1334, fixes #1322)
• editor modes
  • update quick setup instructions for emacs (#1380, @ScriptDevil)
• test suite
  • improve record field destruction testing (#1375)

Oops, we went looking but didn't find the changelog for this release 🙈

Fixes

• Ppx processes are now executed correctly (#513)

Breaking Change

• ocamllsp drops support for .merlin files, and as a consequence no longer depends on dot-merlin-reader. (#523)

Features

• New code action to automatically remove values, types, opens (#502)

• Fix debouncing of document updates. It was essentially completely broken in all but the most trivial cases. (#509 fixes #504)

• Fix completion when passing named and functional arguments (#512)

• Disable experimental dune support. It was accidentally left enabled.

Features

• Add a new code action Add missing rec keyword, which is available when adding a rec keyword can fix Unbound value ... error, e.g.,

  let fact n = if n = 0 then 1 else n * fact (n - 1)
                                    (* ^^^^ Unbound value fact *)
  

  Adding rec to the definition of fact will fix the problem. The new code action offers adding rec.

• Use ocamlformat to properly format type snippets. This feature requires the ocamlformat-rpc opam package to be installed. (#386)

• Add completion support for polymorphic variants, when it is possible to pin down the precise type. Examples (<|> stands for the cursor) when completion will work (#473)

  Function application:

  let foo (a: [`Alpha | `Beta]) = ()
  
  foo `A<|>
  

  Type explicitly shown:

  let a : [`Alpha | `Beta] = `B<|>
  

  Note: this is actually a bug fix, since we were ignoring the backtick when constructing the prefix for completion.

• Parse merlin errors (best effort) into a more structured form. This allows reporting all locations as "related information" (#475)

• Add support for Merlin Construct command as completion suggestions, i.e., show complex expressions that could complete the typed hole. (#472)

• Add a code action Construct an expression that is shown when the cursor is at the end of the typed hole, i.e., _|, where | is the cursor. The code action simply triggers the client (currently only VS Code is supported) to show completion suggestions. (#472)

• Change the formatting-on-save error notification to a warning notification (#472)

• Code action to qualify ("put module name in identifiers") and unqualify ("remove module name from identifiers") module names in identifiers (#399)

  Starting from:

  open Unix
  
  let times = Unix.times ()
  let f x = x.Unix.tms_stime, x.Unix.tms_utime
  

  Calling "remove module name from identifiers" with the cursor on the open statement will produce:

  open Unix
  
  let times = times ()
  let f x = x.tms_stime, x.tms_utime
  

  Calling "put module name in identifiers" will restore:

  open Unix
  
  let times = Unix.times ()
  let f x = x.Unix.tms_stime, x.Unix.tms_utime
  

Fixes

• Handle workspace change notifications. Previously, the server would only use the set of workspaces given at startup to search for workspace symbols. After this change, workspace folders that are added later will also be considered. (#498)

• Do not show "random" documentation on hover

  • fixed by merlin#1364
  • fixes duplicate:
    • ocaml-lsp#344
    • vscode-ocaml-platform#111

• Correctly rename a variable used as a named/optional argument (#478)

• When reporting an error at the beginning of the file, use the first line not the second (#489)

• merlin binary
  • recover ill-typed patterns (#1317, #1342)
  • more accurate type-enclosing for methods (#1328, fixes #1124)
  • fix location of patterns in Occurrences (#1324, fixes ocaml/ocaml-lsp#375)
  • fix location of module definitions done via functors (#1329, fixes #1199)
  • fix -cmt-path dirs mistakenly added to build path (#1330)
  • add new module holes that can replace module expressions (#1333)
  • add a new command construct that builds a list of possible terms when called on a typed hole (#1318)
  • refactor-open improvements (#1313, #1314, #1366, #1372)
    • do not make paths absolute, simply prefix with the identifier under the cursor

      open Foo (* calling refactor-open qualify on this open *)
      let _ = Foo.bar (* previously could result in [Dune__exe.Foo.bar] *)
      

    • do not return identical (duplicate) edits
    • do not return unnecessary edits that when applied do not change the document
    • handle record fields properly
    • handle multi-line paths
    • unqualify should not qualify
  • Handle Persistent_env.Error in Typemod.initial_env (#1355)
  • locate: reset global state from all entry points (#1364)
  • Windows: replace user name by its SID in socketnames (#1345, @ttamttam)
• editor modes
  • vim: add a simple interface to the new construct command: MerlinConstruct. When several results are suggested, <c-i> and <c-u> can be use to change the depth of the recursive construction. (#1318)
  • vim: add support for the merlin-locate-type command: MerlinLocateType (#1359)
  • emacs: add a simple interface to the new construct command: merlin-construct. (#1352)
  • emacs: add support for the merlin-locate-type command. (#1359)
  • emacs: fix issue with merlin--highlight and various minor improvements (#1367, @mattiase)
• test suite
  • cover the new construct command (#1318)
  • disable tests failing in Opam's CI due to nested dune projects (#1373)

Oops, we went looking but didn't find the changelog for this release 🙈

Features

• Add sub-errors as "related" information in diagnostics (#457)

• Add support for navigating to a symbol inside a workspace (#398)

• Show typed holes as errors

  Merlin has a concept of "typed holes" that are syntactically represented as _. Files that incorporate typed holes are not considered valid OCaml, but Merlin and OCaml-LSP support them. One example when such typed holes can occur is when on "destructs" a value, e.g., destructing (Some 1) will generate code match Some 1 with Some _ -> _ | None -> _. While the first underscore is a valid "match-all"/wildcard pattern, the rest of underscores are typed holes.

Fixes

• Switch verbosity from 1 to 0. This is the same default that merlin uses. The old value for verbosity (#433)

• Get fresh diagnostics (warning and error messages) on a file save (#438)

  Note: If you want the fresh diagnostics to take into account changes in other files, you likely need to rebuild your project. An easy way to get automatic rebuilds is to run dune in a watching mode, e.g.,[dune build --watch].

Features

• Code action to annotate a value with its type (#397)

Fixes

• Fix interface/implementation switching on Windows (#427)

• Correctly parse project paths with spaces and other special characters that must be escaped.

• Print types with -short-paths even if the project wasn't built yet

• merlin binary
  • external configuration reading:
    • use relative paths to communicate with Dune when possible. This solves issues related to symlinks on Unix and improve Windows support (#1271, fixes #1288)
    • make the workdir configuration value when using the dune ocaml-merlin configuration provider the same as when using dot-merlin-reader so that ppxes behaves in the same way as before (#1284, fixes ocaml/dune#4479, discussion in #1292)
  • destruct:
    • improve prefixing of generated constructors in Destruct by filtering opened modules (#1277)
    • make the destruct command more resilient to ill-typed expressions and when called without nodes (#1304, fixes #1300)
  • reintroduce some record recovery and improve completion (#1276)
  • introduce a new AST node for holes (_), allow correct typing of these holes and add a new holes command that returns the locations of all holes in the current file along with their types (#1242, #1289)
  • Mppx: don't restore cookies after invocation. Ppx are invoked only once so there is no need to manage cookies. This small change should increase performance and should not change any other behavior (#1309)
  • Windows: system command variant: do not open a window console when launching a ppx (#1270, fixes #714)
  • fix same file documentation bug (#1265 by @ulugbekna, fixes #1261)
• editor modes
  • vim: Add MerlinNextHole and MerlinPreviousHole commands to navigate between holes. Jump to the first hole after destruct (#1287, #1303)
  • emacs: Add merlin-next-hole and merlin-previous-hole commands to navigate holes. Jump to the first hole after calling destruct. (#1291)
  • emacs: modernization of the elisp code and conformance with coding guidelines (#1247, #1310 by Steve Purcell )
  • vim & emacs : new client-side "merlin use package" commands, restoring previous behavior (#1272, fixes #1191)
• test suite
  • cover constructor disambiguation and record fields (#1276)
  • cover the new holes command and AST node (#1242, #1289)
  • cover the document fix (#1265, #1315)

Oops, we went looking but didn't find the changelog for this release 🙈

• Support 4.12 and drop support for all earlier versions

• Update to the latest version of merlin

Fixes

• Backport fixes from merlin (#382, #383)

• Encode request & notification params in a list. This is required by the spec. (#351)

• ocaml support Detailed list of changes on https://tarides.com/blog/2021-01-26-recent-and-upcoming-changes-to-merlin#dropping-support-for-old-versions-of-ocaml Summary:
  • any revision of Merlin now only supports one version of OCaml. Support for other versions will be found in other branches
  • stopped actively supporting version older than 4.11
  • add support for 4.12
• merlin binary
  • add keyword completion (disabled by default) (#1243)
  • fix a bug which caused type-enclosing to sometimes look at an incorrect node (#1232, fixes #1226)
  • properly report leaked parsing error (#1223, fixes #1222)
  • wrap merlin_analysis and merlin_utils library
  • fix windows paths canonicalization (#1254)
  • fix hanging on windows (#1256, #1263)
• editor modes
  • emacs: add missing mandatory argument for define-obsolete-function-alias (#1250, by Atharva Shukla, fixes #1234)
  • emacs: use "opam var" instead of "opam config var" (#1249, by Raja Boujbel)
  • vim: fix CursorMoved semantics (#1213, by @ddickstein)
  • vim: add :MerlinLocateImpl and :MerlinLocateIntf (#1208 by Matthew Ryan)
• test suite
  • replace mdx usage by dune's cram mechanism

Features

• Support cancellation notifications when possible. (#323)

• Implement signature help request for functions (#324)

• Server LSP requests & notifications concurrently. Requests that require merlin are still serialized. (#330)

Features

• Code action to insert inferred module interface (#308)

• Filter keywords by context (#307)

Features

• Add keyword completion

• Add go to declaration functionality to jump to a value's specification in a .mli file (#294)

Fixes

• #245: correctly use mutexes on OpenBSD (#264)

• #268: Do not use vendored libraries when building the lsp package (#260)

• #271: Clear diagnostics when files are closed

• Disable non-prefix completion. There's no reliably way to trigger it and it can be slow.

• merlin binary
  • simplify local store implementation and API (#1188, #1184)
  • fix a destruct issue allowing ill-typed match completions (#1194)

• dot-merlin-reader
  • fix issue when multiple packages with pxxes are declared in the configuration. (#1181, fixes #1179)

• merlin binary
  • fix completion of pattern matchings with exception patterns (#1169)
  • delegate configuration reading to external programs via a simple protocol and create a new package dot-merlin-reader with a binary that reads .merlin files. (#1123, #1152)

Oops, we went looking but didn't find the changelog for this release 🙈

• merlin binary
  • dune: restore compatibility with dune 1.8.0 (#1157, #1153)

• ocaml support
  • full support from OCaml 4.02 to OCaml 4.11 (#1153)

• merlin binary
  • dune: remove duplicated rules for profile=release (#1143)
• test suite
  • fix a test that required Dune 2.5 (#1146)
  • fix another test that lacked reproducibility (#1146)

• ocaml support
  • alerts are no-more ignored and are reported as warnings (#1138)
• merlin binary
  • fix completion of names containing - (#1142)
  • fix several type-enclosing bugs by performing context-analysis (#1108)
  • lsp: add deprecation flag to outline items (#1087)
  • lsp: add go-to typedef (Locate_type) (#1067)

• ocaml support
  • full support from OCaml 4.02 to OCaml 4.10 (#1117, #1127)
  • fix desynchronized cache (#1120)
  • short path for OCaml 4.09 and OCaml 4.10 (#1082, #1117)
  • catch and test environment initialization errors (#1083, #1130)
  • restore type levels after recovery (#1092)
• merlin binary
  • fix syntax errors in 4.08 and 4.09 (#1081)
  • complete-prefix command accepts -kind option to filter results (#1071)
  • code cleanup (#1093, #1079, #1112)
  • better handling of expression and pattern extra nodes during browse tree traversal (#1091, #1121)
  • improve context detection (e.g. appropriate namespace for lookup) for various queries (#1104, #1110)
  • add stdlib to locate source path (#1085)
• editor modes
  • vim: tweak heuristic to select python version (#1111)
  • emacs: marlin/call
  • lsp: move server to its own repository (#1069), https://github.com/ocaml/ocaml-lsp
• test suite
  • dune rules for the test suite are now generated, deterministic and can be run individually (#1068, #1070, #1072)
  • fix incorrect command-line arguments in tests (#1073)
  • better coverage of frontend features (#1075, #1078, #1088, #1089, #1126)
• Build no longer relies on implicit transitive_deps (#1065).

• backend
  • support OCaml 4.09 (#1055)
  • fix parse errors in 4.08 (#1037)
  • update 4.08 support to OCaml 4.08.1 (#1053)
  • support without_cmis
  • separate reading from caching in file-cache, use caching in Env.check_state_consistency (#1044)
  • simplify compiler state management (#1056, #1059)
  • fix creation of initial environment, improve compatibility with upstream 4.08 (#1052)
• frontend
  • code re-organization (#1042)
  • error command: select which kind of errors to show (#995)
  • print value types in outline (#1014)
  • fix process handling in windows (#1005)
• editor modes
  • emacs
    • bugfixes in merlin-imenu, merlin-xref (#1000, #1021, #1001)
    • show types in merlin-imenu (#1013)
    • reset buffer local configurations when resetting server (#1004)
    • remove merlin-use-tuareg-imenu
    • fix stack overflow (#1024)
    • fix merlin-occurrence (#1043)
  • vim
    • display warn-error warnings as errors (#1009)
• testsuite
  • cover file-cache and check_state_consistency (#1044)
  • check inconsistent assumptions, test server versus single modes (#1047)

• backend
  • ** globbing in .merlin won't look into hidden directories (starting with a '.') (by Daniel Bünzli, #990)
  • fallback to "/dev/null" configuration for findlib
  • better 4.08 support:
    • support for letop (let+, and+, ...) (#986)
    • fix parsing recovery for 4.08 constructions (#987)
    • catch an exception raised by 4.08 Printtyp trying to rename a persistent identifier (#991)
  • locate: treat local locations differently from external locations (coming from a cmi), this fixes "jump to definition" on mutually recursive bindings (#984)
  • when completing an infix operator in a sub-module, wrap with () (#992)
  • disable arity checks on externals (for Bucklescript compatibility)
  • remove parser preprocessing (simplify compilation for OCaml < 4.08) (#997)
• editor modes
  • emacs
    • fix position computation in presence of tabs or multi-byte characters (#981)
    • log arguments in "merlin-debug-last-commands" (#981)
  • vim
    • install reason.vim file (by Hezekiah M. Carty, #974)

• backend
  • catch findlib initialization failures and keep going on

• backend

  • interpret -pp flag
  • backtrack warnings in all versions, not just 4.06
  • silence C compiler warnings (by David Allsopp and Bernhard Schommer)
  • remove sturgeon support
  • allow to select sections to log
  • better error message on ocaml version mismatch
  • locate:
    • handle functors and functor applications
    • do not use the location coming from the environment
  • tweaked caching policy
  • fix environment when a file disappears
  • fix -short-paths handling of classes and class types (by Leo White)
  • don't select deprecated paths in -short-paths (by Leo White)
  • return type info in outline query (by Andrey Popp)
  • properly handle new lines in the lexer
  • better tracking of errors reported by the parser and by preprocessors
  • add support for OCaml 4.08
  • tweaked the recovery strategy in presence of syntax errors
  • timing information in replies now includes wall clock time.
  • dump command can new dump the parsetree post preprocessing

• editors modes

  • emacs

    • fix merlin-xref.el install (by Emilio Jesus Gallego Arias)
    • keep labels matching the prefix the user has typed rather than dropping them (by Mitchell Plamann)
    • remove unused merlin--overlay function (by Wilfred Hughes)
    • show the number of errors in the modline (by Wilfred Hughes)
    • call a logger on the client side if one is defined
    • allow user to disable completion inside comments and strings
    • show errors and types even when buffer is narrowed (by Wilfred Hughes)
    • make sure PATH is updated when merlin-command is 'opam

  • vim

    • better FindBinary
    • make the log buffer a scratch buffer (by Tom Johnson)
    • execute buffer switching silently (by Fabian)
    • restore view after updating merlin type buffer (by Fabian)

• testsuite

  • Switched to mdx with cram syntax.

• Update cmt magic number for 4.07.1

• Switched build to dune (thanks to @nojb).
• Added support for 4.07.1
• Various bugfixes in the backend and in the editor modes.
• Fix build on OCaml 4.02 to 4.04

• backend

  • new "polarity search" feature: provides a Hoogle-like type-based search for libraries that are in merlin's scope. See https://github.com/ocaml/merlin/blob/master/doc/features.md#polarity-search
  • new "open refactoring" feature: helps cleaning the code in the scope of an open statement. See https://github.com/ocaml/merlin/blob/master/doc/features.md#open-refactoring
  • spell-checking: a simple spell-checker has been added to suggest corrections when nothing can be directly completed.
  • type-driven record completion: merlin will now make use of type information from the context for narrowing and refining completion candidates.
  • support for #require directive in a source file, and will treat it as a package use
  • Add support for OCaml 4.07
  • locate: various minor bugfixes, as well as the following general improvements:
    • improved context detection
    • better tracking of namespaces
    • fixed support for local bindings
    • fixed support of disambiguated record fields and variant constructors
    • improved support for functors: merlin will now jump through functor application to the functor definitions and in some cases go back to the argument that was given (if it is simply reexported).
  • backport fixes of OCaml 4.06.1 to the 4.06 backend
  • various minor bugfixes

• editor modes

  • emacs
    • proper handling of multibyte strings (by @Chris00)
    • bind "q" to close type buffer (by @MiloDavis)
    • make goto-point encoding independent
    • add reason-mode to the guessed favorite mode list (by @Khady)
    • sped up some tight loops (by @rgrinberg)
    • add support for x-ref backend (by @rgrinberg)
  • vim
    • fix support for Neomake (by @bobbypriambodo and @statianzo)
    • fix encoding issues in filepaths (by @Thelyria)
    • fix handling of enclosing-type cache (by @ELLIOTTCABLE)
    • add to prevent flashing when highlighting an enclosing (by @bluddy)

• Fix magic numbers for 4.06 (issue #749, reported by @Fourchaux).

Oops, we went looking but didn't find the changelog for this release 🙈

Oops, we went looking but didn't find the changelog for this release 🙈

Oops, we went looking but didn't find the changelog for this release 🙈

Oops, we went looking but didn't find the changelog for this release 🙈

Oops, we went looking but didn't find the changelog for this release 🙈

• fix flag parsing in .merlin (#661)

• handle hole in 4.04
• bug fixes in emacs mode
• introduce merlin-imenu

• fix Windows build with MSVC (#605).
• fix module level errors escaping

Oops, we went looking but didn't find the changelog for this release 🙈

• reintroduce lazy substitution to fix performance issue
• add "FINDLIB_PATH" directive to .merlin (contributed by Gerd Stolpmann)
• relax arity checks on externals (harmless, requested by Hongbo Zang)
• handle case insensitivity of OS X (fix longstanding bug)
• fix build under Cygwin
• minor cleanup, portability and usability improvements in build system and editor modes

• frontend:
  • now all commands can take a context, this reduce the amount of state in the command interpreter. Long term goal is to make protocol stateless
  • merlin now supports customizable "readers": processes responsible for parsing and pretty-printing. Main use-case is Reason, cppo/optcomp support might be added later
• backend:
  • drop support for 4.00 / 4.01
  • support for 4.03 has been added
  • new implementation of type recovery, should diverge less from upstream
  • support for 4.02 was reimplemented to use the same design
  • menhir's fork has been synchronized with upstream, recovery algorithm is completely new
• vim: add support for python3, update to new protocol
• emacs: update to new protocol, bug fixes