languages/beancount: init

[gmvar]

Create the vim.languages.beancount module using bean-format and beancount-language-server.

Current Issues

1. Formatting Behavior:
   • The beancount-language-server currently lacks an option to disable formatting. This results in documents being automatically formatted, even when the setting vim.languages.beancount.format.enable is set to false.
   • I have opened an issue on the project's GitHub repository requesting the addition of a toggle for this behavior. Until this feature is implemented, users will experience automatic formatting regardless of their preferences. GitHub Issue #650.
   • beancount-language-server added an option to disable the automatic formatting, though it's not clear to me how to enable that option... Until then, the language server will always format the document.

Sanity Checking

• I have updated the changelog as per my changes
• I have tested, and self-reviewed my code
• My changes fit guidelines found in hacking nvf
• Style and consistency
  • I ran Alejandra to format my code (nix fmt)
  • My code conforms to the editorconfig configuration of the project
  • My changes are consistent with the rest of the codebase
• If new changes are particularly complex:
  • My code includes comments in particularly complex areas
  • I have added a section in the manual
  • (For breaking changes) I have included a migration guide
• Package(s) built:
  • .#nix (default package)
  • .#maximal
  • .#docs-html (manual, must build)
  • .#docs-linkcheck (optional, please build if adding links)
• Tested on platform(s)
  • x86_64-linux
  • aarch64-linux
  • x86_64-darwin
  • aarch64-darwin

[github-actions]

🚀 Live preview deployed from a3123a9

View it here:

Debug Information

Triggered by: gmvar

HEAD at: languages/beancount

Reruns: 2232

[NotAShelf]

Sorry for the delay, I've meant to reply much earlier but kept forgetting each time. Two little comments before we can get this merged.

[NotAShelf]

Just one blocker, LGTM afterwards.

[NotAShelf]

The Vala module uses wrapProgram as follows:

       (getExe (pkgs.symlinkJoin {
          name = "vala-language-server-wrapper";
          paths = [pkgs.vala-language-server];
          meta.mainProgram = "vala-language-server-wrapper";
          buildInputs = [pkgs.makeBinaryWrapper];
          postBuild = ''
            wrapProgram $out/bin/vala-language-server \
              --prefix PATH : ${pkgs.uncrustify}/bin
          '';
        }))

What you're using is not incorrect, but there are existing conventions that I'd rather prefer for their history of adoption and overall reliability. iirc writeShellScriptBin also pulls in another interpreter.

With makeBinaryWrapper we can also ensure better Darwin compatibility.

[gmvar]

Thanks for the guidance! I made the change but opted for a PATH suffix instead of a prefix. This ensures that existing configurations remain prioritized, as beancount allows users to install plugins. If the LSP uses a different version of beancount, it can cause diagnostic errors due to unknown features.

[gmvar]

Also, I think the existing Vala module cmd needs to be changed like so:

- meta.mainProgram = "vala-language-server-wrapper";
+ meta.mainProgram = "vala-language-server";

Doing the current way wasn't successful as a drop in replacement for beancount-language-server during testing.