Use StandardRB to Format Ruby Code

[willkoehler]

For people that use StandardRB (https://github.com/testdouble/standard), here's the configuration I'm using.

"language_overrides": {
    "Ruby": {
        "formatter": {
            "external": {
                "command": "standardrb",
                "arguments": [
                    "--fix",
                    "--stdin",
                    "ignored",
                    "--stderr"
                ]
            }
        }
    }
}

Make sure you have format_on_save turned on (see caveats below)

{
  "format_on_save": "on"
}

A Few Caveats

• IMPORTANT Edit: This is fixed in StandardRB v1.25.1 If you're using an older version you need to... turn off parallel in .standard.yml (parallel: false). This is the default. Just make sure you didn't turn it on at some point. Otherwise StandardRB will run quitely but you won't see the fixes in Zed
  • See parallel: true broken for ale standardrb/standard#530
  • And Not making fixes in stdout when using parallel: true standardrb/standard#536
• This config runs the version of StandardRB globally available in your path. I don't think it's possible to run using bundler because I don't think you can control what path Zed runs commands from (to be fair I'm mostly guessing, based on comments here https://github.com/zed-industries/community/discussions/1017#discussioncomment-5292800)
• This won't lint your code or show you problems as you edit. It only formats your code when you save it. There's more work to be done here (BTW I would be happy to help /cc @JosephTLyons)
• The third argument ignored is required by Rubocop as a parameter for --stdin. It's supposed to be "...a path, relative to the root of the project. RuboCop will use this path to determine which cops are enabled" But, from what I can tell, this is ignored by StandardRB.

/cc @searls Zed looks really promising. I'm excited to start using it and helping to improve the Ruby experience. Integration with StandardRB was one of the first things on my list.

[searls]

Hey @willkoehler, thanks for this. Heads up I just released 1.25.1 which should fix the parallel bug such that you don't need to worry about turning it off in stdin mode any more

[willkoehler]

Yep 🙌 1.25.1 fixes it. I updated the note above ☝️ to indicate this

[searls]

By the way, since standard ruby ships with an LSP server, it'd be neat to see support for it in Zed. As an example, I recently published this VS Code extension that uses the LSP to avoid shelling out repeatedly for formatting and diagnostics

[willkoehler]

I'm using the Standard Ruby VS Code extension with the LSP server. I agree. It's fantastic 🙌 Very fast and well integrated. I would love to help the Zed team build something like this.

I have some capacity coming up and would be happy to put in the work (and, in particular, keep a low profile and stay out of the team's way) if someone on the Zed team (/cc @JosephTLyons) could help point me in the right direction.

[bjeanes]

It'd be great to be able to set a custom LSP for a language.

[vanhecke]

This doesn't work for me. I'm getting a "failed to format via external command" error from zed. I'm guessing because stderr is not empty?

I put the following in a bash file and call that instead:

#!/bin/bash
standardrb --fix --stdin ignored --stderr 2>/dev/null
exit 0

[rhatherall]

I have tried this and also through Solargraph but no matter how I configure this, I get this in the logs:

[WARN] timed out waiting for formatting

I have tested calling this externally and it takes about 1.5s to spit out the formatted code. I know that isn't the fastest turn around but it doesn't seem entirely unreasonable. What is Zed's timeout for formatting? Is it configurable?

[askegg]

Can confirm. This is what I am getting as well.

[rhatherall]

After having a little time to dig into this...

It appears to be an issue loading the Ruby dependencies. I couldn't get this config to work so I tried to revert to using LSP/Solargraph for formatting with either Standard or RuboCop. I ran into issues as I did before. Opening the language server logs showed me that it was having difficulty with resolving the right versions of standard* and rubocop* gems.

Zed doesn't appear to use the bundle configuration, which is where it would have found the correctly installed gems. I have my gems installed per project in .bundle so I can have different versions. After installing the gems manually with gem install the LSP and formatting started to work. Be warned: The versions had to match the versions defined in Gemfile/Gemfile.lock, so this is not a solution if you work on more than one project (who doesn't?!). I think this is the root of any issues I am having with my Ruby projects/tools.

Also, I have seen occasions where Zed failed to attempt loading an LSP for Ruby files. The Solargraph output just wasn't available until I manually called it to restart the LSP.