Sha256: c18582287a687523d93d59d8d2a1933eb05dd485f522098a2c84d7a045e7cb36
Contents?: true
Size: 1.39 KB
Versions: 9
Compression:
Stored size: 1.39 KB
Contents
# typed: strict
# frozen_string_literal: true
require "ruby_lsp/requests/support/rubocop_diagnostics_runner"
module RubyLsp
module Requests
# 
#
# The
# [diagnostics](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics)
# request informs the editor of RuboCop offenses for a given file.
#
# # Example
#
# ```ruby
# def say_hello
# puts "Hello" # --> diagnostics: incorrect indentation
# end
# ```
class Diagnostics < BaseRequest
extend T::Sig
sig { params(document: Document).void }
def initialize(document)
super(document)
@uri = T.let(document.uri, URI::Generic)
end
sig { override.returns(T.nilable(T.all(T::Array[Support::RuboCopDiagnostic], Object))) }
def run
# Running RuboCop is slow, so to avoid excessive runs we only do so if the file is syntactically valid
return if @document.syntax_error?
return unless defined?(Support::RuboCopDiagnosticsRunner)
# Don't try to run RuboCop diagnostics for files outside the current working directory
path = @uri.to_standardized_path
return unless path.nil? || path.start_with?(T.must(WORKSPACE_URI.to_standardized_path))
Support::RuboCopDiagnosticsRunner.instance.run(@uri, @document)
end
end
end
end
Version data entries
9 entries across 9 versions & 1 rubygems