Ruby LSP running but formatting not working

[hawm]

Operating System

Debian GNU/Linux 11 (bullseye), Docker Image (debian:bullseye-slim)

Ruby version

ruby 3.2.2 (2023-03-30 revision e51014f9c0) [x86_64-linux]

Project has a bundle

• Has bundle

Ruby version manager being used

no manager

Description

I am running VSCode and vscode-ruby-lsp in devcontainer, the Ruby LSP starts normally but formatting not working.

I already tweaked the "rubyLsp.formatter" in settiings.json, with values auto, rubocop or syntax_tree but was not lucky.

Project's Gemfile

# frozen_string_literal: true

source "https://rubygems.org"

group :development do
  gem "rubocop"
  gem "rubocop-discourse"
  gem "syntax_tree"
  gem "syntax_tree-disable_ternary"
end

.vscode/settings.json

{
  "rubyLsp.rubyVersionManager": "none",
  "rubyLsp.formatter": "rubocop",
  "rubyLsp.yjit": true,
  "rubyLsp.enableExperimentalFeatures": false,
  "rubyLsp.enabledFeatures": {
    "codeActions": false,
    "diagnostics": false,
    "documentHighlights": false,
    "documentLink": false,
    "documentSymbols": false,
    "foldingRanges": false,
    "formatting": true,
    "hover": false,
    "inlayHint": false,
    "onTypeFormatting": false,
    "selectionRanges": false,
    "semanticHighlighting": false,
    "completion": false,
    "codeLens": false,
    "definition": false
  },

  "[ruby]": {
    "editor.defaultFormatter": "Shopify.ruby-lsp",
    "editor.formatOnSave": true,
    "editor.formatOnType": true,
    "editor.tabSize": 2,
    "files.trimTrailingWhitespace": true,
    "files.trimFinalNewlines": true,
    "editor.rulers": [120],
    "editor.semanticHighlighting.enabled": true
  },

  "ruby lsp.trace.server": "verbose"
}

Ruby file content ensure has formatting issue

# test.rb
def say_hello
  puts "Hello" # --> formatting: fixes the indentation on save
  end

Ruby LSP verbose output

[vinistock]

The issue is likely related to the devcontainer. I suspect the server is running outside of the container and can't see the actual Gemfile.

Have you tried using the remote extension as pointed here?

[hawm]

The issue is likely related to the devcontainer. I suspect the server is running outside of the container and can't see the actual Gemfile.

Have you tried using the remote extension as pointed here?

I can ensure that the server is running inside the container since there no ruby installation in my host machine. And I'm using the dev containers extension rather than the you pointed, but dose it really be matter?

Any I also forget to mention that I do custom the GEM_HOME and BUNDLE_PATH. Because inside the devcontainer we usually don't running as root user so when the LSP server start and try togem install will occur permission issue to install to system path.

Finally I discovered some other features seems not working either, like hover.

LSP verbose output:

[Trace - 11:51:14 AM] Sending request 'textDocument/hover - (3)'.
Params: {
    "textDocument": {
        "uri": "file:///var/www/discourse/plugins/hawm-template-engine/test.rb"
    },
    "position": {
        "line": 0,
        "character": 9
    }
}


[Trace - 11:51:14 AM] Received response 'textDocument/hover - (3)' in 4ms.
No result returned.


[Trace - 11:51:14 AM] Received notification 'telemetry/event'.
Params: {
    "request": "textDocument/hover",
    "lspVersion": "0.8.0",
    "requestTime": 0.0004472310029086657,
    "uri": "/var/www/discourse/plugins/hawm-template-engine/test.rb"
}

[vinistock]

We currently only implemented hover for some Rails DSL methods, we're working on generally available hover - so I don't think there are any issues there.

When you say a custom GEM_HOME, how does that work with rbenv? Does rbenv configure the GEM_HOME path for you?

[hawm]

Well I don't use any version manager like rbenv or others since the Ruby environment is isolated by devcontainer.

[hawm]

Seems I found the root cause, it's my .rubocpo.yml configurations problem

inherit_gem:
   rubocop-discourse: default.yml

AllCops:
  Exclude:
    - "gems/**/*"

While I comment on the first two lines, the formatting is working.

When not comment on it and run rubocop -a test.rb manually , the formatting does not apply either, and shows below outputs

/var/bundle/gems/rubocop-discourse-3.3.0/rubocop-rspec.yml: RSpec/FactoryBot/AttributeDefinedStatically has the wrong namespace - should be FactoryBot
/var/bundle/gems/rubocop-discourse-3.3.0/rubocop-rspec.yml: RSpec/FactoryBot/CreateList has the wrong namespace - should be FactoryBot
/var/bundle/gems/rubocop-discourse-3.3.0/rubocop-rspec.yml: RSpec/FactoryBot/FactoryClassName has the wrong namespace - should be FactoryBot
Inspecting 1 file
C

Offenses:

test.rb:1:1: C: [Correctable] Style/FrozenStringLiteralComment: Missing frozen string literal comment.
def say_hello
^

1 file inspected, 1 offense detected, 1 more offense can be corrected with `rubocop -A`

So it's may not the issue of the extension, but obviously should output something helpful information not just like below

[Trace - 2:36:49 PM] Received response 'textDocument/formatting - (1)' in 37ms.
No result returned.

[vinistock]

How would the LSP detect issues with configuration? And how would we know it's not intentional configuration?

In this case, the configuration is valid, it's just not how you wanted it configured, right? I'm not sure there's anything we can do in this case.

[hawm]

Reopen this since I still can't make it work.

This time I can confirm that not a configuration problem because I totally disable/remove .rubocop.yml. And
manually run is working.

> rubocop -a test.rb
Inspecting 1 file
W

Offenses:

test.rb:1:1: C: [Correctable] Style/FrozenStringLiteralComment: Missing frozen string literal comment.
def say_hello
^
test.rb:3:3: W: [Corrected] Layout/DefEndAlignment: end at 3, 2 is not aligned with def at 1, 0.
  end
  ^^^

1 file inspected, 2 offenses detected, 1 offense corrected, 1 more offense can be corrected with `rubocop -A`

> rubocop -x test.rb
Inspecting 1 file
W

Offenses:

test.rb:3:3: W: [Corrected] Layout/DefEndAlignment: end at 3, 2 is not aligned with def at 1, 0.
  end
  ^^^

1 file inspected, 1 offense detected, 1 offense corrected

Still got this when formatting by this extension

[Trace - 2:53:11 PM] Received response 'textDocument/formatting - (25)' in 8ms.
No result returned.

Since the latest update of this extension, so my project Gemfile:

# frozen_string_literal: true

source 'https://rubygems.org'

group :development do
  gem 'ruby-lsp'
  gem 'debug'
  gem 'rubocop'
  gem 'rubocop-discourse'
  gem 'syntax_tree'
  gem 'syntax_tree-disable_ternary'
end

[jmdfm]

@hawm You closed this, did you get it to work? What was the solution?

[hawm]

@hawm You closed this, did you get it to work? What was the solution?

I'm not sure it's working, but my workround is make sure this extension is enable on one workspace only not globally or multi workspakce.