Formatting via `just --dump` overwrites edits when called as a pre-save hook

[djanderson]

@terror, unfortunately I believe that PR #77 may have lead to a bug.

I'm using Zed and this lsp via sectore/zed-just-ls. It seems that format_document is called as a pre-save hook by default, I have not modified any lsp configuration.

When I edit a Justfile, the edits are held in memory and were previously passed to format_document, but now the file contents are read off disk.

This means that if format is configured as a pre-save hook, it deletes your edits.

[djanderson]

Related upstream issue:

casey/just#1585

!include has been stabilized as import and the exact behavior in that bug is no longer true (the imported file is not injected), however, conceptually just --fmt should be working only on parsed tokens, but it appears there's either a preprocessing step handing imports or --fmt doesn't stop at just parsing the target justfile.

IMO #76 is an upstream bug. It's not immediately clear to me how that could be handled in this project.

[djanderson]

Temporary workaround for Zed users:

  "languages": {
    "Just": {
      // https://github.com/terror/just-lsp/issues/81
      "format_on_save": "off"
    }
  }

(thanks @dargor)

[terror]

Thank you for reporting this! Apologies for the delay, going to merge #85 and cut a new release that fixes this.

I'll likely follow up to try and fix the upstream issue. These commands are also unstable in just with no guarantees of functioning properly, so it also may be worth looking into implementing a custom formatter based on the IR just-lsp uses.

[joprice]

I'm hitting some issues with the reverted change: When updating from 0.2.3 to 0.2.5, my asdf-configured just binary is no longer found. This is due to the command being run from a temp directory. I can work around this by configuring my global .tool-versions file with just, but ideally, if someone uses asdf or some similar project-specific tool to modify the available binaries in the path, it's discovered locally and not system-wide. Perhaps the command could first resolve the just binary, then execute the process using it in the temp directory?

After setting my system wide just to 1.42.4, I get the following error when saving, where the message is either cut short or an empty string, so not much to go on for debugging.

  LSP[just] Failed to format document: just formatting failed:

Also, I've been using the LSP from neovim for a few weeks and the behavior in 0.2.3 has been working, for whatever reason. Perhaps it could be exposed as a flag, --mode=[dump|fmt] with the default being the unstable command?