jimeh-solargraph 0.40.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.github/workflows/ci.yml +54 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +24 -0
- data/.yardopts +2 -0
- data/CHANGELOG.md +1003 -0
- data/Gemfile +7 -0
- data/LICENSE +21 -0
- data/README.md +123 -0
- data/Rakefile +25 -0
- data/SPONSORS.md +15 -0
- data/bin/solargraph +5 -0
- data/jimeh-solargraph.gemspec +44 -0
- data/lib/.rubocop.yml +21 -0
- data/lib/solargraph.rb +67 -0
- data/lib/solargraph/api_map.rb +752 -0
- data/lib/solargraph/api_map/bundler_methods.rb +27 -0
- data/lib/solargraph/api_map/cache.rb +70 -0
- data/lib/solargraph/api_map/source_to_yard.rb +81 -0
- data/lib/solargraph/api_map/store.rb +256 -0
- data/lib/solargraph/bench.rb +30 -0
- data/lib/solargraph/compat.rb +23 -0
- data/lib/solargraph/complex_type.rb +213 -0
- data/lib/solargraph/complex_type/type_methods.rb +127 -0
- data/lib/solargraph/complex_type/unique_type.rb +75 -0
- data/lib/solargraph/convention.rb +47 -0
- data/lib/solargraph/convention/base.rb +33 -0
- data/lib/solargraph/convention/gemfile.rb +15 -0
- data/lib/solargraph/convention/gemspec.rb +22 -0
- data/lib/solargraph/convention/rspec.rb +21 -0
- data/lib/solargraph/converters/dd.rb +12 -0
- data/lib/solargraph/converters/dl.rb +12 -0
- data/lib/solargraph/converters/dt.rb +12 -0
- data/lib/solargraph/converters/misc.rb +1 -0
- data/lib/solargraph/diagnostics.rb +55 -0
- data/lib/solargraph/diagnostics/base.rb +29 -0
- data/lib/solargraph/diagnostics/require_not_found.rb +37 -0
- data/lib/solargraph/diagnostics/rubocop.rb +90 -0
- data/lib/solargraph/diagnostics/rubocop_helpers.rb +45 -0
- data/lib/solargraph/diagnostics/severities.rb +15 -0
- data/lib/solargraph/diagnostics/type_check.rb +54 -0
- data/lib/solargraph/diagnostics/update_errors.rb +41 -0
- data/lib/solargraph/documentor.rb +78 -0
- data/lib/solargraph/environ.rb +45 -0
- data/lib/solargraph/language_server.rb +19 -0
- data/lib/solargraph/language_server/completion_item_kinds.rb +35 -0
- data/lib/solargraph/language_server/error_codes.rb +20 -0
- data/lib/solargraph/language_server/host.rb +746 -0
- data/lib/solargraph/language_server/host/cataloger.rb +56 -0
- data/lib/solargraph/language_server/host/diagnoser.rb +81 -0
- data/lib/solargraph/language_server/host/dispatch.rb +112 -0
- data/lib/solargraph/language_server/host/sources.rb +156 -0
- data/lib/solargraph/language_server/message.rb +92 -0
- data/lib/solargraph/language_server/message/base.rb +85 -0
- data/lib/solargraph/language_server/message/cancel_request.rb +13 -0
- data/lib/solargraph/language_server/message/client.rb +11 -0
- data/lib/solargraph/language_server/message/client/register_capability.rb +15 -0
- data/lib/solargraph/language_server/message/completion_item.rb +11 -0
- data/lib/solargraph/language_server/message/completion_item/resolve.rb +57 -0
- data/lib/solargraph/language_server/message/exit_notification.rb +13 -0
- data/lib/solargraph/language_server/message/extended.rb +21 -0
- data/lib/solargraph/language_server/message/extended/check_gem_version.rb +100 -0
- data/lib/solargraph/language_server/message/extended/document.rb +20 -0
- data/lib/solargraph/language_server/message/extended/document_gems.rb +32 -0
- data/lib/solargraph/language_server/message/extended/download_core.rb +23 -0
- data/lib/solargraph/language_server/message/extended/environment.rb +25 -0
- data/lib/solargraph/language_server/message/extended/search.rb +20 -0
- data/lib/solargraph/language_server/message/initialize.rb +153 -0
- data/lib/solargraph/language_server/message/initialized.rb +26 -0
- data/lib/solargraph/language_server/message/method_not_found.rb +16 -0
- data/lib/solargraph/language_server/message/method_not_implemented.rb +14 -0
- data/lib/solargraph/language_server/message/shutdown.rb +13 -0
- data/lib/solargraph/language_server/message/text_document.rb +28 -0
- data/lib/solargraph/language_server/message/text_document/base.rb +19 -0
- data/lib/solargraph/language_server/message/text_document/code_action.rb +17 -0
- data/lib/solargraph/language_server/message/text_document/completion.rb +57 -0
- data/lib/solargraph/language_server/message/text_document/definition.rb +38 -0
- data/lib/solargraph/language_server/message/text_document/did_change.rb +15 -0
- data/lib/solargraph/language_server/message/text_document/did_close.rb +15 -0
- data/lib/solargraph/language_server/message/text_document/did_open.rb +15 -0
- data/lib/solargraph/language_server/message/text_document/did_save.rb +17 -0
- data/lib/solargraph/language_server/message/text_document/document_symbol.rb +23 -0
- data/lib/solargraph/language_server/message/text_document/folding_range.rb +26 -0
- data/lib/solargraph/language_server/message/text_document/formatting.rb +105 -0
- data/lib/solargraph/language_server/message/text_document/hover.rb +44 -0
- data/lib/solargraph/language_server/message/text_document/on_type_formatting.rb +34 -0
- data/lib/solargraph/language_server/message/text_document/prepare_rename.rb +11 -0
- data/lib/solargraph/language_server/message/text_document/references.rb +16 -0
- data/lib/solargraph/language_server/message/text_document/rename.rb +19 -0
- data/lib/solargraph/language_server/message/text_document/signature_help.rb +29 -0
- data/lib/solargraph/language_server/message/workspace.rb +14 -0
- data/lib/solargraph/language_server/message/workspace/did_change_configuration.rb +29 -0
- data/lib/solargraph/language_server/message/workspace/did_change_watched_files.rb +33 -0
- data/lib/solargraph/language_server/message/workspace/did_change_workspace_folders.rb +24 -0
- data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -0
- data/lib/solargraph/language_server/message_types.rb +14 -0
- data/lib/solargraph/language_server/request.rb +24 -0
- data/lib/solargraph/language_server/symbol_kinds.rb +36 -0
- data/lib/solargraph/language_server/transport.rb +13 -0
- data/lib/solargraph/language_server/transport/adapter.rb +56 -0
- data/lib/solargraph/language_server/transport/data_reader.rb +72 -0
- data/lib/solargraph/language_server/uri_helpers.rb +49 -0
- data/lib/solargraph/library.rb +426 -0
- data/lib/solargraph/location.rb +37 -0
- data/lib/solargraph/logging.rb +27 -0
- data/lib/solargraph/page.rb +83 -0
- data/lib/solargraph/parser.rb +26 -0
- data/lib/solargraph/parser/comment_ripper.rb +52 -0
- data/lib/solargraph/parser/legacy.rb +12 -0
- data/lib/solargraph/parser/legacy/class_methods.rb +109 -0
- data/lib/solargraph/parser/legacy/flawed_builder.rb +16 -0
- data/lib/solargraph/parser/legacy/node_chainer.rb +118 -0
- data/lib/solargraph/parser/legacy/node_methods.rb +311 -0
- data/lib/solargraph/parser/legacy/node_processors.rb +54 -0
- data/lib/solargraph/parser/legacy/node_processors/alias_node.rb +23 -0
- data/lib/solargraph/parser/legacy/node_processors/args_node.rb +35 -0
- data/lib/solargraph/parser/legacy/node_processors/begin_node.rb +15 -0
- data/lib/solargraph/parser/legacy/node_processors/block_node.rb +22 -0
- data/lib/solargraph/parser/legacy/node_processors/casgn_node.rb +25 -0
- data/lib/solargraph/parser/legacy/node_processors/cvasgn_node.rb +23 -0
- data/lib/solargraph/parser/legacy/node_processors/def_node.rb +63 -0
- data/lib/solargraph/parser/legacy/node_processors/defs_node.rb +36 -0
- data/lib/solargraph/parser/legacy/node_processors/gvasgn_node.rb +23 -0
- data/lib/solargraph/parser/legacy/node_processors/ivasgn_node.rb +38 -0
- data/lib/solargraph/parser/legacy/node_processors/lvasgn_node.rb +28 -0
- data/lib/solargraph/parser/legacy/node_processors/namespace_node.rb +39 -0
- data/lib/solargraph/parser/legacy/node_processors/orasgn_node.rb +16 -0
- data/lib/solargraph/parser/legacy/node_processors/resbody_node.rb +36 -0
- data/lib/solargraph/parser/legacy/node_processors/sclass_node.rb +21 -0
- data/lib/solargraph/parser/legacy/node_processors/send_node.rb +257 -0
- data/lib/solargraph/parser/legacy/node_processors/sym_node.rb +18 -0
- data/lib/solargraph/parser/node_methods.rb +43 -0
- data/lib/solargraph/parser/node_processor.rb +43 -0
- data/lib/solargraph/parser/node_processor/base.rb +80 -0
- data/lib/solargraph/parser/region.rb +66 -0
- data/lib/solargraph/parser/rubyvm.rb +40 -0
- data/lib/solargraph/parser/rubyvm/class_methods.rb +150 -0
- data/lib/solargraph/parser/rubyvm/node_chainer.rb +135 -0
- data/lib/solargraph/parser/rubyvm/node_methods.rb +301 -0
- data/lib/solargraph/parser/rubyvm/node_processors.rb +62 -0
- data/lib/solargraph/parser/rubyvm/node_processors/alias_node.rb +23 -0
- data/lib/solargraph/parser/rubyvm/node_processors/args_node.rb +86 -0
- data/lib/solargraph/parser/rubyvm/node_processors/begin_node.rb +15 -0
- data/lib/solargraph/parser/rubyvm/node_processors/block_node.rb +22 -0
- data/lib/solargraph/parser/rubyvm/node_processors/casgn_node.rb +22 -0
- data/lib/solargraph/parser/rubyvm/node_processors/cvasgn_node.rb +23 -0
- data/lib/solargraph/parser/rubyvm/node_processors/def_node.rb +64 -0
- data/lib/solargraph/parser/rubyvm/node_processors/defs_node.rb +57 -0
- data/lib/solargraph/parser/rubyvm/node_processors/gvasgn_node.rb +23 -0
- data/lib/solargraph/parser/rubyvm/node_processors/ivasgn_node.rb +38 -0
- data/lib/solargraph/parser/rubyvm/node_processors/kw_arg_node.rb +39 -0
- data/lib/solargraph/parser/rubyvm/node_processors/lit_node.rb +20 -0
- data/lib/solargraph/parser/rubyvm/node_processors/lvasgn_node.rb +27 -0
- data/lib/solargraph/parser/rubyvm/node_processors/namespace_node.rb +39 -0
- data/lib/solargraph/parser/rubyvm/node_processors/opt_arg_node.rb +26 -0
- data/lib/solargraph/parser/rubyvm/node_processors/orasgn_node.rb +15 -0
- data/lib/solargraph/parser/rubyvm/node_processors/resbody_node.rb +45 -0
- data/lib/solargraph/parser/rubyvm/node_processors/sclass_node.rb +21 -0
- data/lib/solargraph/parser/rubyvm/node_processors/scope_node.rb +15 -0
- data/lib/solargraph/parser/rubyvm/node_processors/send_node.rb +277 -0
- data/lib/solargraph/parser/rubyvm/node_processors/sym_node.rb +18 -0
- data/lib/solargraph/parser/snippet.rb +13 -0
- data/lib/solargraph/pin.rb +36 -0
- data/lib/solargraph/pin/base.rb +296 -0
- data/lib/solargraph/pin/base_variable.rb +84 -0
- data/lib/solargraph/pin/block.rb +62 -0
- data/lib/solargraph/pin/class_variable.rb +8 -0
- data/lib/solargraph/pin/closure.rb +37 -0
- data/lib/solargraph/pin/common.rb +70 -0
- data/lib/solargraph/pin/constant.rb +43 -0
- data/lib/solargraph/pin/conversions.rb +96 -0
- data/lib/solargraph/pin/documenting.rb +105 -0
- data/lib/solargraph/pin/duck_method.rb +16 -0
- data/lib/solargraph/pin/global_variable.rb +8 -0
- data/lib/solargraph/pin/instance_variable.rb +30 -0
- data/lib/solargraph/pin/keyword.rb +15 -0
- data/lib/solargraph/pin/keyword_param.rb +8 -0
- data/lib/solargraph/pin/local_variable.rb +21 -0
- data/lib/solargraph/pin/localized.rb +43 -0
- data/lib/solargraph/pin/method.rb +245 -0
- data/lib/solargraph/pin/method_alias.rb +31 -0
- data/lib/solargraph/pin/namespace.rb +85 -0
- data/lib/solargraph/pin/parameter.rb +206 -0
- data/lib/solargraph/pin/proxy_type.rb +29 -0
- data/lib/solargraph/pin/reference.rb +14 -0
- data/lib/solargraph/pin/reference/extend.rb +10 -0
- data/lib/solargraph/pin/reference/include.rb +10 -0
- data/lib/solargraph/pin/reference/override.rb +29 -0
- data/lib/solargraph/pin/reference/prepend.rb +10 -0
- data/lib/solargraph/pin/reference/require.rb +14 -0
- data/lib/solargraph/pin/reference/superclass.rb +10 -0
- data/lib/solargraph/pin/singleton.rb +11 -0
- data/lib/solargraph/pin/symbol.rb +47 -0
- data/lib/solargraph/position.rb +100 -0
- data/lib/solargraph/range.rb +95 -0
- data/lib/solargraph/server_methods.rb +16 -0
- data/lib/solargraph/shell.rb +222 -0
- data/lib/solargraph/source.rb +537 -0
- data/lib/solargraph/source/chain.rb +154 -0
- data/lib/solargraph/source/chain/block_variable.rb +13 -0
- data/lib/solargraph/source/chain/call.rb +203 -0
- data/lib/solargraph/source/chain/class_variable.rb +13 -0
- data/lib/solargraph/source/chain/constant.rb +75 -0
- data/lib/solargraph/source/chain/global_variable.rb +13 -0
- data/lib/solargraph/source/chain/head.rb +35 -0
- data/lib/solargraph/source/chain/instance_variable.rb +13 -0
- data/lib/solargraph/source/chain/link.rb +67 -0
- data/lib/solargraph/source/chain/literal.rb +23 -0
- data/lib/solargraph/source/chain/or.rb +23 -0
- data/lib/solargraph/source/chain/variable.rb +13 -0
- data/lib/solargraph/source/chain/z_super.rb +30 -0
- data/lib/solargraph/source/change.rb +79 -0
- data/lib/solargraph/source/cursor.rb +164 -0
- data/lib/solargraph/source/encoding_fixes.rb +23 -0
- data/lib/solargraph/source/source_chainer.rb +190 -0
- data/lib/solargraph/source/updater.rb +54 -0
- data/lib/solargraph/source_map.rb +188 -0
- data/lib/solargraph/source_map/clip.rb +224 -0
- data/lib/solargraph/source_map/completion.rb +23 -0
- data/lib/solargraph/source_map/mapper.rb +215 -0
- data/lib/solargraph/type_checker.rb +503 -0
- data/lib/solargraph/type_checker/checks.rb +99 -0
- data/lib/solargraph/type_checker/param_def.rb +35 -0
- data/lib/solargraph/type_checker/problem.rb +32 -0
- data/lib/solargraph/type_checker/rules.rb +57 -0
- data/lib/solargraph/version.rb +5 -0
- data/lib/solargraph/views/_method.erb +62 -0
- data/lib/solargraph/views/_name_type_tag.erb +10 -0
- data/lib/solargraph/views/_namespace.erb +24 -0
- data/lib/solargraph/views/document.erb +23 -0
- data/lib/solargraph/views/environment.erb +58 -0
- data/lib/solargraph/views/layout.erb +44 -0
- data/lib/solargraph/views/search.erb +11 -0
- data/lib/solargraph/workspace.rb +209 -0
- data/lib/solargraph/workspace/config.rb +230 -0
- data/lib/solargraph/yard_map.rb +435 -0
- data/lib/solargraph/yard_map/cache.rb +19 -0
- data/lib/solargraph/yard_map/core_docs.rb +170 -0
- data/lib/solargraph/yard_map/core_fills.rb +185 -0
- data/lib/solargraph/yard_map/core_gen.rb +76 -0
- data/lib/solargraph/yard_map/helpers.rb +16 -0
- data/lib/solargraph/yard_map/mapper.rb +77 -0
- data/lib/solargraph/yard_map/mapper/to_constant.rb +25 -0
- data/lib/solargraph/yard_map/mapper/to_method.rb +78 -0
- data/lib/solargraph/yard_map/mapper/to_namespace.rb +27 -0
- data/lib/solargraph/yard_map/rdoc_to_yard.rb +140 -0
- data/lib/solargraph/yard_map/stdlib_fills.rb +43 -0
- data/lib/solargraph/yard_map/to_method.rb +79 -0
- data/lib/yard-solargraph.rb +30 -0
- data/yardoc/2.2.2.tar.gz +0 -0
- metadata +564 -0
@@ -0,0 +1,33 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Convention
|
5
|
+
# The base class for Conventions.
|
6
|
+
#
|
7
|
+
# A Convention provides Environs that customize ApiMaps with additional
|
8
|
+
# pins and other information. Subclasses should implement the `local` and
|
9
|
+
# `global` methods as necessary.
|
10
|
+
#
|
11
|
+
class Base
|
12
|
+
EMPTY_ENVIRON = Environ.new
|
13
|
+
|
14
|
+
# The Environ for a source map.
|
15
|
+
# Subclasses can override this method.
|
16
|
+
#
|
17
|
+
# @param source_map [SourceMap]
|
18
|
+
# @return [Environ]
|
19
|
+
def local source_map
|
20
|
+
EMPTY_ENVIRON
|
21
|
+
end
|
22
|
+
|
23
|
+
# The Environ for a YARD map.
|
24
|
+
# Subclasses can override this method.
|
25
|
+
#
|
26
|
+
# @param yard_map [YardMap]
|
27
|
+
# @return [Environ]
|
28
|
+
def global yard_map
|
29
|
+
EMPTY_ENVIRON
|
30
|
+
end
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Convention
|
5
|
+
class Gemfile < Base
|
6
|
+
def local source_map
|
7
|
+
return EMPTY_ENVIRON unless File.basename(source_map.filename) == 'Gemfile'
|
8
|
+
@environ ||= Environ.new(
|
9
|
+
requires: ['bundler'],
|
10
|
+
domains: ['Bundler::Dsl']
|
11
|
+
)
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Convention
|
5
|
+
class Gemspec < Base
|
6
|
+
def local source_map
|
7
|
+
return EMPTY_ENVIRON unless File.basename(source_map.filename).end_with?('.gemspec')
|
8
|
+
@environ ||= Environ.new(
|
9
|
+
requires: ['rubygems'],
|
10
|
+
pins: [
|
11
|
+
Solargraph::Pin::Reference::Override.from_comment(
|
12
|
+
'Gem::Specification.new',
|
13
|
+
%(
|
14
|
+
@yieldparam [self]
|
15
|
+
)
|
16
|
+
)
|
17
|
+
]
|
18
|
+
)
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,21 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Convention
|
5
|
+
class Rspec < Base
|
6
|
+
def local source_map
|
7
|
+
return EMPTY_ENVIRON unless File.basename(source_map.filename) =~ /_spec\.rb$/
|
8
|
+
@environ ||= Environ.new(
|
9
|
+
requires: ['rspec'],
|
10
|
+
domains: ['RSpec::Matchers', 'RSpec::ExpectationGroups'],
|
11
|
+
# This override is necessary due to an erroneous @return tag in
|
12
|
+
# rspec's YARD documentation.
|
13
|
+
# @todo The return types have been fixed (https://github.com/rspec/rspec-expectations/pull/1121)
|
14
|
+
pins: [
|
15
|
+
Solargraph::Pin::Reference::Override.method_return('RSpec::Matchers#expect', 'RSpec::Expectations::ExpectationTarget')
|
16
|
+
]
|
17
|
+
)
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
21
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
module ReverseMarkdown
|
2
|
+
module Converters
|
3
|
+
class Dd < Base
|
4
|
+
def convert node, state = {}
|
5
|
+
content = treat_children(node, state)
|
6
|
+
": #{content.strip}\n"
|
7
|
+
end
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
ReverseMarkdown::Converters.register :dd, ReverseMarkdown::Converters::Dd.new
|
@@ -0,0 +1,12 @@
|
|
1
|
+
module ReverseMarkdown
|
2
|
+
module Converters
|
3
|
+
class Dl < Base
|
4
|
+
def convert node, state = {}
|
5
|
+
content = treat_children(node, state).strip
|
6
|
+
"\n\n#{content}\n"
|
7
|
+
end
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
ReverseMarkdown::Converters.register :dl, ReverseMarkdown::Converters::Dl.new
|
@@ -0,0 +1,12 @@
|
|
1
|
+
module ReverseMarkdown
|
2
|
+
module Converters
|
3
|
+
class Dt < Base
|
4
|
+
def convert node, state = {}
|
5
|
+
content = treat_children(node, state)
|
6
|
+
"\n#{content.strip}\n"
|
7
|
+
end
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
ReverseMarkdown::Converters.register :dt, ReverseMarkdown::Converters::Dt.new
|
@@ -0,0 +1 @@
|
|
1
|
+
ReverseMarkdown::Converters.register :tt, ReverseMarkdown::Converters::Code.new
|
@@ -0,0 +1,55 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
# The Diagnostics library provides reporters for analyzing problems in code
|
5
|
+
# and providing the results to language server clients.
|
6
|
+
#
|
7
|
+
module Diagnostics
|
8
|
+
autoload :Base, 'solargraph/diagnostics/base'
|
9
|
+
autoload :Severities, 'solargraph/diagnostics/severities'
|
10
|
+
autoload :Rubocop, 'solargraph/diagnostics/rubocop'
|
11
|
+
autoload :RubocopHelpers, 'solargraph/diagnostics/rubocop_helpers'
|
12
|
+
autoload :RequireNotFound, 'solargraph/diagnostics/require_not_found'
|
13
|
+
autoload :UpdateErrors, 'solargraph/diagnostics/update_errors'
|
14
|
+
autoload :TypeCheck, 'solargraph/diagnostics/type_check'
|
15
|
+
|
16
|
+
class << self
|
17
|
+
# Add a reporter with a name to identify it in .solargraph.yml files.
|
18
|
+
#
|
19
|
+
# @param name [String] The name
|
20
|
+
# @param klass [Class<Solargraph::Diagnostics::Base>] The class implementation
|
21
|
+
# @return [void]
|
22
|
+
def register name, klass
|
23
|
+
reporter_hash[name] = klass
|
24
|
+
end
|
25
|
+
|
26
|
+
# Get an array of reporter names.
|
27
|
+
#
|
28
|
+
# @return [Array<String>]
|
29
|
+
def reporters
|
30
|
+
reporter_hash.keys - ['type_not_defined'] # @todo Hide type_not_defined for now
|
31
|
+
end
|
32
|
+
|
33
|
+
# Find a reporter by name.
|
34
|
+
#
|
35
|
+
# @param name [String] The name with which the reporter was registered
|
36
|
+
# @return [Class<Solargraph::Diagnostics::Base>]
|
37
|
+
def reporter name
|
38
|
+
reporter_hash[name]
|
39
|
+
end
|
40
|
+
|
41
|
+
private
|
42
|
+
|
43
|
+
# @return [Hash]
|
44
|
+
def reporter_hash
|
45
|
+
@reporter_hash ||= {}
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
register 'rubocop', Rubocop
|
50
|
+
register 'require_not_found', RequireNotFound
|
51
|
+
register 'typecheck', TypeCheck
|
52
|
+
register 'update_errors', UpdateErrors
|
53
|
+
register 'type_not_defined', TypeCheck # @todo Retained for backwards compatibility
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,29 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Diagnostics
|
5
|
+
# The base class for diagnostics reporters.
|
6
|
+
#
|
7
|
+
class Base
|
8
|
+
# @return [Array<String>]
|
9
|
+
attr_reader :args
|
10
|
+
|
11
|
+
def initialize *args
|
12
|
+
@args = args
|
13
|
+
end
|
14
|
+
|
15
|
+
# Perform a diagnosis on a Source within the context of an ApiMap.
|
16
|
+
# The result is an array of hash objects that conform to the LSP's
|
17
|
+
# Diagnostic specification.
|
18
|
+
#
|
19
|
+
# Subclasses should override this method.
|
20
|
+
#
|
21
|
+
# @param source [Solargraph::Source]
|
22
|
+
# @param api_map [Solargraph::ApiMap]
|
23
|
+
# @return [Array<Hash>]
|
24
|
+
def diagnose source, api_map
|
25
|
+
[]
|
26
|
+
end
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Diagnostics
|
5
|
+
# RequireNotFound reports required paths that could not be resolved to
|
6
|
+
# either a file in the workspace or a gem.
|
7
|
+
#
|
8
|
+
class RequireNotFound < Base
|
9
|
+
def diagnose source, api_map
|
10
|
+
return [] unless source.parsed? && source.synchronized?
|
11
|
+
result = []
|
12
|
+
refs = {}
|
13
|
+
map = api_map.source_map(source.filename)
|
14
|
+
map.requires.each { |ref| refs[ref.name] = ref }
|
15
|
+
api_map.unresolved_requires.each do |r|
|
16
|
+
next unless refs.key?(r)
|
17
|
+
result.push require_error(r, refs[r].location)
|
18
|
+
end
|
19
|
+
result
|
20
|
+
end
|
21
|
+
|
22
|
+
private
|
23
|
+
|
24
|
+
# @param path [String]
|
25
|
+
# @param location [Location]
|
26
|
+
# @return [Hash]
|
27
|
+
def require_error path, location
|
28
|
+
{
|
29
|
+
range: location.range.to_hash,
|
30
|
+
severity: Diagnostics::Severities::WARNING,
|
31
|
+
source: 'RequireNotFound',
|
32
|
+
message: "Required path #{path} could not be resolved."
|
33
|
+
}
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
@@ -0,0 +1,90 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require 'rubocop'
|
4
|
+
require 'stringio'
|
5
|
+
|
6
|
+
module Solargraph
|
7
|
+
module Diagnostics
|
8
|
+
# This reporter provides linting through RuboCop.
|
9
|
+
#
|
10
|
+
class Rubocop < Base
|
11
|
+
include RubocopHelpers
|
12
|
+
|
13
|
+
# Conversion of RuboCop severity names to LSP constants
|
14
|
+
SEVERITIES = {
|
15
|
+
'refactor' => Severities::HINT,
|
16
|
+
'convention' => Severities::INFORMATION,
|
17
|
+
'warning' => Severities::WARNING,
|
18
|
+
'error' => Severities::ERROR,
|
19
|
+
'fatal' => Severities::ERROR
|
20
|
+
}
|
21
|
+
|
22
|
+
# @param source [Solargraph::Source]
|
23
|
+
# @param _api_map [Solargraph::ApiMap]
|
24
|
+
# @return [Array<Hash>]
|
25
|
+
def diagnose source, _api_map
|
26
|
+
options, paths = generate_options(source.filename, source.code)
|
27
|
+
store = RuboCop::ConfigStore.new
|
28
|
+
runner = RuboCop::Runner.new(options, store)
|
29
|
+
result = redirect_stdout{ runner.run(paths) }
|
30
|
+
make_array JSON.parse(result)
|
31
|
+
rescue RuboCop::ValidationError, RuboCop::ConfigNotFoundError => e
|
32
|
+
raise DiagnosticsError, "Error in RuboCop configuration: #{e.message}"
|
33
|
+
rescue JSON::ParserError
|
34
|
+
raise DiagnosticsError, 'RuboCop returned invalid data'
|
35
|
+
end
|
36
|
+
|
37
|
+
private
|
38
|
+
|
39
|
+
# @param resp [Hash]
|
40
|
+
# @return [Array<Hash>]
|
41
|
+
def make_array resp
|
42
|
+
diagnostics = []
|
43
|
+
resp['files'].each do |file|
|
44
|
+
file['offenses'].each do |off|
|
45
|
+
diagnostics.push offense_to_diagnostic(off)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
diagnostics
|
49
|
+
end
|
50
|
+
|
51
|
+
# Convert a RuboCop offense to an LSP diagnostic
|
52
|
+
#
|
53
|
+
# @param off [Hash] Offense received from Rubocop
|
54
|
+
# @return [Hash] LSP diagnostic
|
55
|
+
def offense_to_diagnostic off
|
56
|
+
{
|
57
|
+
range: offense_range(off).to_hash,
|
58
|
+
# 1 = Error, 2 = Warning, 3 = Information, 4 = Hint
|
59
|
+
severity: SEVERITIES[off['severity']],
|
60
|
+
source: off['cop_name'],
|
61
|
+
message: off['message'].gsub(/^#{off['cop_name']}\:/, '')
|
62
|
+
}
|
63
|
+
end
|
64
|
+
|
65
|
+
# @param off [Hash]
|
66
|
+
# @return [Range]
|
67
|
+
def offense_range off
|
68
|
+
Range.new(offense_start_position(off), offense_ending_position(off))
|
69
|
+
end
|
70
|
+
|
71
|
+
# @param off [Hash]
|
72
|
+
# @return [Position]
|
73
|
+
def offense_start_position off
|
74
|
+
Position.new(off['location']['start_line'] - 1, off['location']['start_column'] - 1)
|
75
|
+
end
|
76
|
+
|
77
|
+
# @param off [Hash]
|
78
|
+
# @return [Position]
|
79
|
+
def offense_ending_position off
|
80
|
+
if off['location']['start_line'] != off['location']['last_line']
|
81
|
+
Position.new(off['location']['start_line'], 0)
|
82
|
+
else
|
83
|
+
Position.new(
|
84
|
+
off['location']['start_line'] - 1, off['location']['last_column']
|
85
|
+
)
|
86
|
+
end
|
87
|
+
end
|
88
|
+
end
|
89
|
+
end
|
90
|
+
end
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Diagnostics
|
5
|
+
# Utility methods for the RuboCop diagnostics reporter.
|
6
|
+
#
|
7
|
+
module RubocopHelpers
|
8
|
+
module_function
|
9
|
+
|
10
|
+
# Generate command-line options for the specified filename and code.
|
11
|
+
#
|
12
|
+
# @param filename [String]
|
13
|
+
# @param code [String]
|
14
|
+
# @return [Array(Array<String>, Array<String>)]
|
15
|
+
def generate_options filename, code
|
16
|
+
args = ['-f', 'j', filename]
|
17
|
+
base_options = RuboCop::Options.new
|
18
|
+
options, paths = base_options.parse(args)
|
19
|
+
options[:stdin] = code
|
20
|
+
[options, paths]
|
21
|
+
end
|
22
|
+
|
23
|
+
# RuboCop internally uses capitalized drive letters for Windows paths,
|
24
|
+
# so we need to convert the paths provided to the command.
|
25
|
+
#
|
26
|
+
# @param path [String]
|
27
|
+
# @return [String]
|
28
|
+
def fix_drive_letter path
|
29
|
+
return path unless path.match(/^[a-z]:/)
|
30
|
+
path[0].upcase + path[1..-1]
|
31
|
+
end
|
32
|
+
|
33
|
+
# @todo This is a smelly way to redirect output, but the RuboCop specs do
|
34
|
+
# the same thing.
|
35
|
+
# @return [String]
|
36
|
+
def redirect_stdout
|
37
|
+
redir = StringIO.new
|
38
|
+
$stdout = redir
|
39
|
+
yield if block_given?
|
40
|
+
$stdout = STDOUT
|
41
|
+
redir.string
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Diagnostics
|
5
|
+
# These severity constants match the DiagnosticSeverity constants in the
|
6
|
+
# language server protocol.
|
7
|
+
#
|
8
|
+
module Severities
|
9
|
+
ERROR = 1
|
10
|
+
WARNING = 2
|
11
|
+
INFORMATION = 3
|
12
|
+
HINT = 4
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,54 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module Solargraph
|
4
|
+
module Diagnostics
|
5
|
+
# TypeCheck reports methods with undefined return types, untagged
|
6
|
+
# parameters, and invalid param tags.
|
7
|
+
#
|
8
|
+
class TypeCheck < Base
|
9
|
+
def diagnose source, api_map
|
10
|
+
return [] unless args.include?('always') || api_map.workspaced?(source.filename)
|
11
|
+
severity = Diagnostics::Severities::ERROR
|
12
|
+
level = (args.reverse.find { |a| ['normal', 'typed', 'strict', 'strong'].include?(a) }) || :normal
|
13
|
+
checker = Solargraph::TypeChecker.new(source.filename, api_map: api_map, level: level.to_sym)
|
14
|
+
checker.problems
|
15
|
+
.sort { |a, b| a.location.range.start.line <=> b.location.range.start.line }
|
16
|
+
.map do |problem|
|
17
|
+
{
|
18
|
+
range: extract_first_line(problem.location, source),
|
19
|
+
severity: severity,
|
20
|
+
source: 'Typecheck',
|
21
|
+
message: problem.message
|
22
|
+
}
|
23
|
+
end
|
24
|
+
end
|
25
|
+
|
26
|
+
private
|
27
|
+
|
28
|
+
# @param location [Location]
|
29
|
+
# @param source [Source]
|
30
|
+
# @return [Hash]
|
31
|
+
def extract_first_line location, source
|
32
|
+
return location.range.to_hash if location.range.start.line == location.range.ending.line
|
33
|
+
{
|
34
|
+
start: {
|
35
|
+
line: location.range.start.line,
|
36
|
+
character: location.range.start.character
|
37
|
+
},
|
38
|
+
end: {
|
39
|
+
line: location.range.start.line,
|
40
|
+
character: last_character(location.range.start, source)
|
41
|
+
}
|
42
|
+
}
|
43
|
+
end
|
44
|
+
|
45
|
+
# @param position [Solargraph::Position]
|
46
|
+
# @param source [Solargraph::Source]
|
47
|
+
# @return [Integer]
|
48
|
+
def last_character position, source
|
49
|
+
cursor = Position.to_offset(source.code, position)
|
50
|
+
source.code.index(/[\r\n]/, cursor) || source.code.length
|
51
|
+
end
|
52
|
+
end
|
53
|
+
end
|
54
|
+
end
|