File: diagnostic_registration_options.rb

package info (click to toggle)
ruby-language-server-protocol 3.17.0.5-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,636 kB
  • sloc: ruby: 10,741; makefile: 4
file content (84 lines) | stat: -rw-r--r-- 2,490 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
module LanguageServer
  module Protocol
    module Interface
      #
      # Diagnostic registration options.
      #
      class DiagnosticRegistrationOptions
        def initialize(document_selector:, work_done_progress: nil, identifier: nil, inter_file_dependencies:, workspace_diagnostics:, id: nil)
          @attributes = {}

          @attributes[:documentSelector] = document_selector
          @attributes[:workDoneProgress] = work_done_progress if work_done_progress
          @attributes[:identifier] = identifier if identifier
          @attributes[:interFileDependencies] = inter_file_dependencies
          @attributes[:workspaceDiagnostics] = workspace_diagnostics
          @attributes[:id] = id if id

          @attributes.freeze
        end

        #
        # A document selector to identify the scope of the registration. If set to
        # null the document selector provided on the client side will be used.
        #
        # @return [DocumentSelector]
        def document_selector
          attributes.fetch(:documentSelector)
        end

        # @return [boolean]
        def work_done_progress
          attributes.fetch(:workDoneProgress)
        end

        #
        # An optional identifier under which the diagnostics are
        # managed by the client.
        #
        # @return [string]
        def identifier
          attributes.fetch(:identifier)
        end

        #
        # Whether the language has inter file dependencies meaning that
        # editing code in one file can result in a different diagnostic
        # set in another file. Inter file dependencies are common for
        # most programming languages and typically uncommon for linters.
        #
        # @return [boolean]
        def inter_file_dependencies
          attributes.fetch(:interFileDependencies)
        end

        #
        # The server provides support for workspace diagnostics as well.
        #
        # @return [boolean]
        def workspace_diagnostics
          attributes.fetch(:workspaceDiagnostics)
        end

        #
        # The id used to register the request. The id can be used to deregister
        # the request again. See also Registration#id.
        #
        # @return [string]
        def id
          attributes.fetch(:id)
        end

        attr_reader :attributes

        def to_hash
          attributes
        end

        def to_json(*args)
          to_hash.to_json(*args)
        end
      end
    end
  end
end