Sha256: bb4abab6f3561c8313c68f5fef05e0ec8ec9e1980b62a1e71d70122309b28a20
Contents?: true
Size: 1.93 KB
Versions: 22
Compression:
Stored size: 1.93 KB
Contents
# typed: strict
# frozen_string_literal: true
module RubyLsp
module Requests
# The [formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting)
# request uses RuboCop to fix auto-correctable offenses in the document. This requires enabling format on save and
# registering the ruby-lsp as the Ruby formatter.
class Formatting < Request
extend T::Sig
class Error < StandardError; end
class << self
extend T::Sig
sig { returns(Interface::DocumentFormattingRegistrationOptions) }
def provider
Interface::DocumentFormattingRegistrationOptions.new(
document_selector: [
Interface::DocumentFilter.new(language: "ruby"),
],
)
end
end
sig { params(global_state: GlobalState, document: RubyDocument).void }
def initialize(global_state, document)
super()
@document = document
@active_formatter = T.let(global_state.active_formatter, T.nilable(Support::Formatter))
@uri = T.let(document.uri, URI::Generic)
end
sig { override.returns(T.nilable(T.all(T::Array[Interface::TextEdit], Object))) }
def perform
return unless @active_formatter
return if @document.syntax_error?
# We don't format erb documents yet
formatted_text = @active_formatter.run_formatting(@uri, @document)
return unless formatted_text
lines = @document.source.lines
size = @document.source.size
return if formatted_text.size == size && formatted_text == @document.source
[
Interface::TextEdit.new(
range: Interface::Range.new(
start: Interface::Position.new(line: 0, character: 0),
end: Interface::Position.new(line: lines.size, character: 0),
),
new_text: formatted_text,
),
]
end
end
end
end
Version data entries
22 entries across 22 versions & 1 rubygems