OCaml Changelog

• merlin binary
  • Add a "heap_mbytes" field to Merlin server responses to report heap usage (#1717)
  • Add cache stats to telemetry (#1711)
  • Add new SyntaxDocument command to find information about the node under the cursor (#1706)
  • Fix FLG -pp ppx.exe -as-pp/-dump-ast use of invalid shell redirection when direct process launch on Windows. (#1723, fixes #1722)
  • Add a query_num field to the ocamlmerlin responses to detect server crashes (#1716)
  • Jump to cases within a match statement (#1726)
  • Jump to module-type (#1728, partially fixes #1656)
  • Exposes stable functions for configuration handling and pattern variable destruction. (#1730)
• editor modes
  • vim: load merlin under the ocamlinterface and ocamllex filetypes (#1340)
  • Fix merlinpp not using binary file open (#1725, fixes #1724)

• merlin binary
  • Fix a follow-up issue to the preference of non-ghost nodes introduced in #1660 (#1690, fixes #1689)
  • Add -cache-lifespan flag, that sets cache invalidation period. (#1698, #1705)
  • Fix Merlin locate not fallbacking on the correct file in case of ambiguity (@goldfirere, #1699)
  • Fix Merlin reporting errors provoked by the recovery itself (#1709, fixes #1704)
• editor modes
  • vim: load merlin when Vim is compiled with +python3/dyn (e.g. MacVim)
  • emacs: highlight only first error line by default (#1693, fixes #1663)

• merlin binary
  • Fix issue with let operators and tuples (ocaml/merlin#1684, fixes ocaml/merlin#1683, fixes ocaml/ocaml-lsp#1182)
  • Fix an issue causing Merlin locate queries to hang (ocaml/merlin#1686, fixes ocaml/ocaml-lsp#1192)

• Merlin binary
  • Improve error messages for missing configuration reader (ocaml/merlin#1669)
  • Fix regression causing crash when using PPXs under Windows (ocaml/merlin#1673)
  • Fix confusion between aliased modules and module types (ocaml/merlin#1676, fixes ocaml/merlin#1667)
  • Ignore hidden branches when listing occurrences (ocaml/merlin#1677, fixes ocaml/merlin#1671)
• Editor modes
  • Emacs: fix/improve keybindings (ocaml/merlin#1668, fixes ocaml/merlin#1386): Unbind C-c C-r (to avoid shadowing tuareg-eval-region) and bind C-c C-v instead to merlin-error-check; rebind C-c C-d to merlin-document and bind C-c M-d and C-c | instead to merlin-destruct; bind C-u C-c C-t to merlin-type-expr.
  • Emacs: remove use of obsolete defadvice macro (ocaml/merlin#1675)

• merlin binary
  • Constrain socket path buffer size to avoid build warnings (#1631)
  • Handle concurrent server start (#1622)
  • Omit module prefixes for constructors and record fields in the construct command (#1618). Prefixes are still produced when warning 42 (disambiguated name) is active.
  • Correctly invalidate PPX cache when pipeline ran partially (#1650, fixes #1647)
  • Prevent short-path from looping in some cases related to recursive type definitions (#1645)
  • Support parsing negative numbers in sexps (#1655)
  • Fix construct not working with inline records (#1658)
  • Improve behavior of type-enclosing on let/and operators (#1653)
  • Fix occurrences of extension constructors (#1662)
  • Improve node selection when ghosts are present (#1664, fixes #1660)
• editor modes
  • emacs: call merlin-client-logger with "interrupted" if the merlin binary itself is interrupted, not just the parsing of the result (#1626).
  • emacs: merlin-construct, with a prefix argument, now includes local values in the completion options. Alternatively, this behavior can be enabled permanently by customizing merlin-construct-with-local-values (#1644)
  • emacs: add support for opam-switch-mode (#1654, fixes #1591). See https://github.com/ProofGeneral/opam-switch-mode

• merlin binary
  • Allow monadic IO in dot protocol (#1581)
  • Add a scope option to the occurrences command in preparation for the upcoming project-wide-occurrences feature (#1596)
  • Construct bool-typed holes as false instead of true in the construct command, for consistency (#1599).
  • Add a hook to configure system command for spawning ppxes when Merlin is used as a library. (#1585)
  • Implement an all-or-nothing cache for the PPX phase (#1584)
  • Cleanup functors caches when backtracking, to avoid memory leaks (#1609, fixes #1529 and ocaml-lsp#1032)
  • Fix construct results ordering for sum types sand poly variants (#1603)
  • Fix object method completion not working (#1606, fixes #1575)
  • Improve context detection for package types (#1608, fixes #1607)
  • Fix incorrect locations for string literals (#1574)
  • Fixed an issue that caused errors to erroneously alert about missing cmi files (#1577)
  • Prevent destruct from crashing on closed variant types (#1602, fixes #1601)
  • Improve longident parsing (#1612, fixes #945)
• editor modes
  • emacs: call the user's configured completion UI in merlin-construct (#1598)
• test suite
  • Add missing dependency to a test using ppxlib (#1583)
  • Add tests for the new PPX phase cache (#1584)
  • Add and update tests for construct ordering (#1603)

• merlin binary
  • Update internal typer to match OCaml 4.14.1 release (#1557)
  • Improve type-enclosing behaviour when used on records' labels (#1565, fixes #1564)
  • Restore compatibility with some OCaml compiler's debug flags that were incorrectly rejected by Merlin (#1556)
  • Traverse aliases when jumping to declaration. This matches jump-to-definition's behavior (#1563)
  • Improve locate's behavior in various ill-typed expressions (#1546, fixes #1567 and partially #1543)
  • Correctly traverse patterns when looking for docs in the typedtree (#1572)
  • Get documentation when the declaration or definition is selected (#1542, fixes #1540)
  • On Windows, change to a harmless directory when launching server to avoid locking down current directory (#1569, fixes #1474)
• test suite
  • Add multiple tests for locate over ill-typed expressions (#1546)
  • Add non-regression tests for other fixes in this release

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

• merlin binary
  • Replace custom "holes" AST nodes by extensions. This restores binary compatibility and fixes issues with PPXs when using typed-holes. (#1503)
  • Do not change temporarily Merlin's cwd when starting a PPX (#1521, fixes #1420)
  • Fix a parsing issue when declaring the (??) custom prefix operator. (#1507, fixes #1506)
  • Fix variant constructors' comments grouping (#1516, @mheiber, fixes #1513)
  • Filter-out duplicates from the enclosing command result (#1512)
  • Add a new verbosity=smart mode for type enclosing that only expand modules' types (#1374, @ulugbekna)
  • Improve locate for labels' declarations in the current buffer. (#1505, fixes #1524)
  • Fix locate on module without implementation (#1522, fixes #1519)
  • Allow program name customization when merlin is used as a library. (#1532)
• editor modes
  • vim: load the plugin when necessary if it wasn't loaded before (#1511)
  • emacs: xref works from context menus; better highlighting of xref matches; xref recognises operators and binding operators at the cursor position; bad locations are filtered out (#1385, fixes #1410)
  • emacs: update CI for newer releases and fix some warnings (#1454, @mattiase)
• test suite
  • Add tests for constructors' documentation (#1511)
  • Add test cases for label comment documentation (#1526, @mheiber)
  • Add a test for the enclosing command (#1512)
  • Add tests for interactions between locate and record labels (#1505)
  • Add test showing an issue with locate and implicit transitive deps

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

• merlin binary
  • make most library public and split merlin in two packages: the merlin-lib package that exposes merlin's internals and the merlin package with the frontend. (#1448, #1455, #1457, #1497, @rgrinberg, @tmattio, @kit-ty-kate)
  • Type printing: use best_module_path for paths from Mty_alias (#1470)
  • Attempt at finding the 'real' capitalization of files on windows (#1462 by @mlasson)
  • Use newer Seq-based API of Yojson 2.0, avoiding the need for the deprecated Stream module (#1475 by @Leonidas-from-XIV)
  • unify parsing of MERLIN_LOG (#1480 by @ulugbekna)
  • Fix type deduplication in type-enclosing results (#1483, fixes #1477)
  • Only weakly reduce the shapes to speed up the new Merlin locate implementation. (#1488)
  • Ignore unknown configuration tags from dune configuration provider but not from dot-merlin-reader (#1486)
  • typing recovery: recover at the granularity of core_type (#1484)
• editor modes
  • add method imenu items for emacs (#1481, @mndrix)
  • emacs: Make the prefix argument to merlin-locate optional, both for consistency with Emacs convention and for backwards compatibility. (#1476, @antalsz)
  • emacs: fix duplicated prefix path in imenu entries (#1495, @bcc32)

• merlin binary
  • don't reset the environment when running merlin in single mode so that the parent environment is forwarded the the child processes (#1425)
  • filter dups in source paths (#1218)
  • improve load path performance (#1323)
  • fix handlink of ppx's under Windows (#1413)
  • locate: look for original source files before looking for preprocessed files (#1219 by @ddickstein, fixes #894)
  • handle = syntax in compiler flags (#1409)
  • expose all destruct exceptions in the api (#1437)
  • fix superfluous break in error reporting (#1432)
  • recognise binding operators in locate and occurrences (#1398, @mattiase)
  • remove dependency on Result (#1441, @kit-ty-kate)
  • use the new "shapes" generated by the compiler to perform precise jump-to-definition (#1431)
• editor modes
  • fix an issue in Neovim where the current line jumps to the top of the window on repeated calls to MerlinTypeOf (#1433 by @ddickstein, fixes #1221)
  • add module, module type, and class imenu items for emacs (#1244, @ivg)
  • add prefix argument to force or prevent opening in a new buffer in locate command (#1426, @panglesd)
  • add type-on-hover functionality for vim (#1439, @nilsbecker)
  • add a dedicated buffer *merlin-errors* containing the last viewed error (#1414, @panglesd)
• test suite
  • make merlin-wrapper create a default .merlin file only when there is no dune-project to let tests use dune ocaml-merlin reader. (#1425)
  • cover locate calls on module aliases with and without dune
  • Add a test expliciting the interaction between locate and Dune's generated source files (#1444)

• 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 occurences 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 🙈

• 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 🙈

• 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 🙈

• 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

• 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).

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

• 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)