Skip to content

Releases: swyddfa/esbonio

Esbonio VSCode Extension v0.94.1 - 2024-06-07

07 Jun 20:15
Compare
Choose a tag to compare

v0.94.1 - 2024-06-07

Misc

  • Update bundled version of the language server to v1.0.0b5 (#831)

Esbonio Language Server v1.0.0b5 - 2024-06-07

07 Jun 19:25
Compare
Choose a tag to compare

v1.0.0b5 - 2024-06-07

Misc

  • Fix release pipeline (#831)

v1.0.0b4 - 2024-06-07

Features

  • Implement role target completions for MyST syntax (#823)

Enhancements

  • The server now includes the eval-rst directive in its completion suggestions for MyST files (#799)

API Changes

  • In the server's context LanguageFeatures can now define a CompletionTrigger which among other things, allows them to declare trigger characters (#413)
  • In the Sphinx process, it is now possible for extensions to declare a role target provider through the app.esbonio.create_role_target_provider and app.esbonio.add_role methods.
    Note: This does require an associated implementation of the target provider on the server side. (#823)

Fixes

  • The language server should now launch the correct version of the sphinx agent, even if an installation of esbonio exists in the target environment (#782)
  • The server no longer raises ValueErrors when typing : characters in markdown files. (#800)
  • The server should no longer throw path mount errors when used across partitions on Windows (#810)

Esbonio VSCode Extension v0.94.0 - 2024-04-28

28 Apr 18:08
Compare
Choose a tag to compare

v0.94.0 - 2024-04-28

Breaking Changes

  • The Open Preview to the Side and Open Preview commands have been renamed to Preview Documentation in Split Window and Preview Documentation respectively. (#780)

Enhancements

  • Esbonio now adds an icon to the editor toolbar that opens the preview in markdown files. (#780)
  • The preview pane will now show a "No Content Found" message if the file could not be previewed.
    The message contains troubleshooting steps on how the preview might be fixed. (#793)

Misc

Esbonio Language Server v1.0.0b3 - 2024-04-28

28 Apr 18:07
Compare
Choose a tag to compare

v1.0.0b3 - 2024-04-28

Features

  • Add support for role completions in MyST documents (#775)

Enhancements

  • If the client supports it, the server will now send window/showDocument requests when previewing a file.

    The server will automatically react to changes to esbonio.preview.* configuration options. (#793)

Fixes

  • The server should once again, correctly guess a reasonable basic sphinx-build build command for projects located in a sub-folder of the workspace (#779)
  • The server should once again automatically trigger a build when previewing a file, when necessary (#783)

Esbonio VSCode Extension v0.93.2 - 2024-04-22

22 Apr 17:34
Compare
Choose a tag to compare

v0.93.2 - 2024-04-22

Fixes

  • Fix pipeline to publish to Open VSX (#777)

Esbonio VSCode Extension v0.93.1 - 2024-04-20

20 Apr 18:37
Compare
Choose a tag to compare

v0.93.1 - 2024-04-20

Fixes

  • Rebuild extension to pull in the latest esbonio release (#775)

Esbonio VSCode Extension v0.93.0 - 2024-04-20

20 Apr 18:29
Compare
Choose a tag to compare

v0.93.0 - 2024-04-20

Breaking Changes

    • Removed the esbonio.server.logLevel option, use esbonio.logging.level instead.
    • Removed the esbonio.server.logFilter option, it has been made obselete by the other esbonio.logging.* options

    (#748)

  • The esbonio.server.enabledInPyFiles configuration option has been removed, use esbonio.server.documentSelector instead (#756)

Enhancements

  • Added the following configuration options

    • esbonio.logging.level, set the default logging level of the server
    • esbonio.logging.format, set the default format of server log messages
    • esbonio.logging.filepath, enable logging to a file
    • esbonio.logging.stderr, print log messages to stderr
    • esbonio.logging.window, send log messages as window/logMessage notifications
    • esbonio.logging.config, override logging configuration for individual loggers, see the documentation for details
    • esbonio.trace.server enables the logging of LSP messages sent to/from the server

    (#748)

  • Added the esbonio.server.documentSelector option, granting the user fine grained control over which files the server is enabled in. (#756)

Fixes

  • The extension will now notify the server when the user changes Python environment via the Python extension (#703)

Esbonio Language Server v1.0.0b2 - 2024-04-20

20 Apr 18:30
Compare
Choose a tag to compare

v1.0.0b2 - 2024-04-20

Breaking Changes

    • Removed the esbonio.server.logLevel option, use esbonio.logging.level instead.
    • Removed the esbonio.server.logFilter option, it has been made obselete by the other esbonio.logging.* options

    (#748)

Enhancements

  • Added the following configuration options

    • esbonio.logging.level, set the default logging level of the server
    • esbonio.logging.format, set the default format of server log messages
    • esbonio.logging.filepath, enable logging to a file
    • esbonio.logging.stderr, print log messages to stderr
    • esbonio.logging.window, send log messages as window/logMessage notifications
    • esbonio.logging.config, override logging configuration for individual loggers, see the documentation for details

    (#748)

  • The server will now automatically restart the underlying Sphinx process when it detects a change in its configuration (#750)

  • The server now emits sphinx/clientCreated, sphinx/clientErrored and sphinx/clientDestroyed notifications that correspond to the lifecycle of the underlying Sphinx process (#756)

Fixes

  • The server should no longer sometimes spawn duplicated Sphinx processes (#660)
  • The server now respects Sphinx configuration values like suppress_warnings (#695)
  • The server will no longer raise a ValueError when used in a situation where there is an empty workspace (#718)

Esbonio VSCode Extension v0.92.1 - 2024-01-15

15 Jan 23:11
Compare
Choose a tag to compare

v0.92.1 - 2024-01-15

Breaking Changes

  • The following server configuration options have been removed as they are no longer required.

    • esbonio.server.installBehavior
    • esbonio.server.updateBehavior
    • esbonio.server.updateFrequency

    The language server is now bundled as part of the VSCode extension itself, so a separate installation step is no longer necessary.

    The following sphinx configuration options have been removed

    • esbonio.server.hideSphinxOutput
    • esbonio.sphinx.buildDir
    • esbonio.sphinx.builderName
    • esbonio.sphinx.confDir
    • esbonio.sphinx.doctreeDir
    • esbonio.sphinx.forceFullBuild
    • esbonio.sphinx.keepGoing
    • esbonio.sphinx.makeMode
    • esbonio.sphinx.numJobs
    • esbonio.sphinx.quiet
    • esbonio.sphinx.silent
    • esbonio.sphinx.srcDir
    • esbonio.sphinx.tags
    • esbonio.sphinx.verbosity
    • esbonio.sphinx.warningIsError

    The Sphinx application instance is now launched using a standard sphinx-build command line provided through the esbonio.sphinx.buildCommand option, so individual options are no longer necessary.
    Note: The esbonio.sphinx.configOverrides option has been preserved as it can be easier to use than the equivalent command line options.

    (#619)

  • The minimum required VSCode version is now 1.82.0 (#666)

Enhancements

  • The following server configuration values have been added

    • esbonio.server.enableDevTools: Enable integration with lsp-devtools for the language server itself.

    The following sphinx configuration values have been added

    • esbonio.sphinx.buildCommand: Set the sphinx-build command to use when invoking the Sphinx subprocess

    • esbonio.sphinx.pythonCommand: By default, the extension will attempt to reuse the Python environment you have configured in the Python extension when invoking Sphinx.
      This option can be used to override this behavior.

    • esbonio.sphinx.cwd: The working directory from which to launch the Sphinx process

    • esbonio.sphinx.envPassthrough: A list of envrionment variables to pass through to the Sphinx process.

    • esbonio.sphinx.enableDevTools: Enable integration with lsp-devtools for the sphinx process

      • esbonio.sphinx.pythonPath: Used to override the Python packages (typically esbonio.sphinx_agent) that are injected into the Sphinx environment

    The following preview related options have been added

    • esbonio.sphinx.enableSyncScrolling: Enable support for syncronised scrolling between the editor and preview pane
    • esbonio.preview.bind: Set the network interface that the preview server binds to
    • esbonio.preview.httpPort: Set the port number the HTTP server binds to
    • esbonio.preview.wsPort: Set the port number the WebSocket server binds to

    (#626)

Misc

  • Updated the bundled version of esbonio to 1.0.0b1 (#720)

Esbonio Language Server v1.0.0b1 - 2024-01-15

15 Jan 22:40
Compare
Choose a tag to compare

v1.0.0b1 - 2024-01-15

Breaking Changes

  • Removed esbonio.lsp.spelling module, though it will be available as esbonio.ext.spelling via the esbonio-extensions package. (#583)
  • Drop Python 3.7 support (#584)
  • Drop Sphinx 4.x support (#585)

Features

  • The language server now supports reading configuration values from workspace/configuration requests and pyproject.toml files.
    When supported by the client, the server can detect and respond to changes in (most) configuration automatically - no more manually restarting the server! (#527)
  • The language server now supports workspace/symbol requests (#611)
  • Sphinx build progress is now reported using the window/workDoneProgress/create API (#659)
  • For the clients that support the pull diagnostics model, the server now supports the textDocument/diagnostic and workspace/diagnostic methods. (#689)
  • The language server can now provide completion suggestions for MyST directives. (#706)

Enhancements

  • When providing completion suggestions for directives, esbonio now takes the .. default-domain:: directive into account (#105)

Fixes