|
| 1 | +v0.16.0 - 2023-02-04 |
| 2 | +-------------------- |
| 3 | + |
| 4 | +Features |
| 5 | +^^^^^^^^ |
| 6 | + |
| 7 | +- Add new ``server.completion.preferredInsertBehavior`` option. |
| 8 | + This allows the user to indicate to the server how they would prefer completions to behave when accepted. |
| 9 | + |
| 10 | + The default value is ``replace`` and corresponds to the server's current behavior where completions replace existing text. |
| 11 | + In this mode the server will set the ``textEdit`` field of a ``CompletionItem``. |
| 12 | + |
| 13 | + This release also introduces a new mode ``insert``, where completions will append to existing text rather than replacing it. |
| 14 | + This also means that only the completions that are compatible with any existing text will be returned. |
| 15 | + In this mode the server will set the ``insertText`` field of a ``CompletionItem`` which should work better with editors that do no support ``textEdits``. |
| 16 | + |
| 17 | + **Note:** This option is only a hint and the server will not ensure that it is followed, though it is planned for all first party completion suggestions to (eventually) respect this setting. |
| 18 | + As of this release, all completion suggestions support ``replace`` and role, directive and directive option completions support ``insert``. (`#471 <https://github.com/swyddfa/esbonio/issues/471>`_) |
| 19 | + |
| 20 | + |
| 21 | +Documentation |
| 22 | +^^^^^^^^^^^^^ |
| 23 | + |
| 24 | +- Add getting started guide for Sublime Text by @vkhitrin (`#522 <https://github.com/swyddfa/esbonio/issues/522>`_) |
| 25 | + |
| 26 | + |
| 27 | +API Changes |
| 28 | +^^^^^^^^^^^ |
| 29 | + |
| 30 | +- ``CompletionContext`` objects now expose a ``config`` field that contains any user supplied configuration values affecting completions. (`#531 <https://github.com/swyddfa/esbonio/issues/531>`_) |
| 31 | + |
| 32 | + |
| 33 | +Misc |
| 34 | +^^^^ |
| 35 | + |
| 36 | +- Drop Python 3.6 support (`#400 <https://github.com/swyddfa/esbonio/issues/400>`_) |
| 37 | +- Migrate to pygls ``v1.0`` |
| 38 | + |
| 39 | + There are some breaking changes, but only if you use Esbonio's extension APIs, if you simply use the language server in your favourite editor you *shouldn't* notice a difference. |
| 40 | + |
| 41 | + The most notable change is the replacement of ``pydantic`` type definitions with ``attrs`` and ``cattrs`` via the new `lsprotocol <https://github.com/microsoft/lsprotocol>`__ package. |
| 42 | + For more details see pygls' `migration guide <https://pygls.readthedocs.io/en/latest/pages/migrating-to-v1.html>`__. (`#484 <https://github.com/swyddfa/esbonio/issues/484>`_) |
| 43 | +- Drop support for Sphinx 3.x |
| 44 | + |
| 45 | + Add support for Sphinx 6.x (`#523 <https://github.com/swyddfa/esbonio/issues/523>`_) |
| 46 | + |
| 47 | + |
1 | 48 | v0.15.0 - 2022-12-03 |
2 | 49 | -------------------- |
3 | 50 |
|
|
0 commit comments