Module: Solargraph

Defined in:
lib/solargraph.rb,
lib/solargraph/pin.rb,
lib/solargraph/page.rb,
lib/yard-solargraph.rb,
lib/solargraph/bench.rb,
lib/solargraph/range.rb,
lib/solargraph/shell.rb,
lib/solargraph/parser.rb,
lib/solargraph/source.rb,
lib/solargraph/api_map.rb,
lib/solargraph/environ.rb,
lib/solargraph/library.rb,
lib/solargraph/logging.rb,
lib/solargraph/version.rb,
lib/solargraph/location.rb,
lib/solargraph/pin/base.rb,
lib/solargraph/position.rb,
lib/solargraph/yard_map.rb,
lib/solargraph/pin/block.rb,
lib/solargraph/workspace.rb,
lib/solargraph/convention.rb,
lib/solargraph/documentor.rb,
lib/solargraph/pin/common.rb,
lib/solargraph/pin/method.rb,
lib/solargraph/pin/symbol.rb,
lib/solargraph/source_map.rb,
lib/solargraph/diagnostics.rb,
lib/solargraph/pin/closure.rb,
lib/solargraph/pin/keyword.rb,
lib/solargraph/complex_type.rb,
lib/solargraph/pin/constant.rb,
lib/solargraph/source/chain.rb,
lib/solargraph/type_checker.rb,
lib/solargraph/api_map/cache.rb,
lib/solargraph/api_map/store.rb,
lib/solargraph/parser/legacy.rb,
lib/solargraph/parser/region.rb,
lib/solargraph/parser/rubyvm.rb,
lib/solargraph/pin/localized.rb,
lib/solargraph/pin/namespace.rb,
lib/solargraph/pin/parameter.rb,
lib/solargraph/pin/reference.rb,
lib/solargraph/pin/singleton.rb,
lib/solargraph/source/change.rb,
lib/solargraph/source/cursor.rb,
lib/solargraph/parser/snippet.rb,
lib/solargraph/pin/proxy_type.rb,
lib/solargraph/server_methods.rb,
lib/solargraph/source/updater.rb,
lib/solargraph/yard_map/cache.rb,
lib/solargraph/convention/base.rb,
lib/solargraph/language_server.rb,
lib/solargraph/pin/conversions.rb,
lib/solargraph/pin/documenting.rb,
lib/solargraph/pin/duck_method.rb,
lib/solargraph/source/chain/or.rb,
lib/solargraph/source_map/clip.rb,
lib/solargraph/yard_map/mapper.rb,
lib/solargraph/convention/rspec.rb,
lib/solargraph/diagnostics/base.rb,
lib/solargraph/pin/method_alias.rb,
lib/solargraph/workspace/config.rb,
lib/solargraph/yard_map/helpers.rb,
lib/solargraph/pin/base_variable.rb,
lib/solargraph/pin/keyword_param.rb,
lib/solargraph/source/chain/call.rb,
lib/solargraph/source/chain/head.rb,
lib/solargraph/source/chain/link.rb,
lib/solargraph/source_map/mapper.rb,
lib/solargraph/yard_map/core_gen.rb,
lib/solargraph/convention/gemfile.rb,
lib/solargraph/convention/gemspec.rb,
lib/solargraph/pin/class_variable.rb,
lib/solargraph/pin/local_variable.rb,
lib/solargraph/type_checker/rules.rb,
lib/solargraph/yard_map/core_docs.rb,
lib/solargraph/yard_map/to_method.rb,
lib/solargraph/diagnostics/rubocop.rb,
lib/solargraph/parser/node_methods.rb,
lib/solargraph/pin/global_variable.rb,
lib/solargraph/type_checker/checks.rb,
lib/solargraph/yard_map/core_fills.rb,
lib/solargraph/language_server/host.rb,
lib/solargraph/pin/reference/extend.rb,
lib/solargraph/source/chain/literal.rb,
lib/solargraph/source/chain/z_super.rb,
lib/solargraph/type_checker/problem.rb,
lib/solargraph/parser/comment_ripper.rb,
lib/solargraph/parser/node_processor.rb,
lib/solargraph/pin/instance_variable.rb,
lib/solargraph/pin/reference/include.rb,
lib/solargraph/pin/reference/prepend.rb,
lib/solargraph/pin/reference/require.rb,
lib/solargraph/source/chain/constant.rb,
lib/solargraph/source/chain/variable.rb,
lib/solargraph/source/encoding_fixes.rb,
lib/solargraph/source/source_chainer.rb,
lib/solargraph/source_map/completion.rb,
lib/solargraph/yard_map/rdoc_to_yard.rb,
lib/solargraph/yard_map/stdlib_fills.rb,
lib/solargraph/api_map/source_to_yard.rb,
lib/solargraph/diagnostics/severities.rb,
lib/solargraph/diagnostics/type_check.rb,
lib/solargraph/pin/reference/override.rb,
lib/solargraph/type_checker/param_def.rb,
lib/solargraph/api_map/bundler_methods.rb,
lib/solargraph/language_server/message.rb,
lib/solargraph/language_server/request.rb,
lib/solargraph/complex_type/unique_type.rb,
lib/solargraph/pin/reference/superclass.rb,
lib/solargraph/complex_type/type_methods.rb,
lib/solargraph/diagnostics/update_errors.rb,
lib/solargraph/language_server/transport.rb,
lib/solargraph/yard_map/mapper/to_method.rb,
lib/solargraph/parser/legacy/node_chainer.rb,
lib/solargraph/parser/legacy/node_methods.rb,
lib/solargraph/parser/node_processor/base.rb,
lib/solargraph/parser/rubyvm/node_chainer.rb,
lib/solargraph/parser/rubyvm/node_methods.rb,
lib/solargraph/diagnostics/rubocop_helpers.rb,
lib/solargraph/language_server/error_codes.rb,
lib/solargraph/language_server/uri_helpers.rb,
lib/solargraph/parser/legacy/class_methods.rb,
lib/solargraph/parser/rubyvm/class_methods.rb,
lib/solargraph/source/chain/block_variable.rb,
lib/solargraph/source/chain/class_variable.rb,
lib/solargraph/yard_map/mapper/to_constant.rb,
lib/solargraph/language_server/host/sources.rb,
lib/solargraph/language_server/message/base.rb,
lib/solargraph/language_server/symbol_kinds.rb,
lib/solargraph/parser/legacy/flawed_builder.rb,
lib/solargraph/source/chain/global_variable.rb,
lib/solargraph/yard_map/mapper/to_namespace.rb,
lib/solargraph/diagnostics/require_not_found.rb,
lib/solargraph/language_server/host/dispatch.rb,
lib/solargraph/language_server/message_types.rb,
lib/solargraph/parser/legacy/node_processors.rb,
lib/solargraph/parser/rubyvm/node_processors.rb,
lib/solargraph/language_server/host/cataloger.rb,
lib/solargraph/language_server/host/diagnoser.rb,
lib/solargraph/language_server/message/client.rb,
lib/solargraph/source/chain/instance_variable.rb,
lib/solargraph/language_server/message/extended.rb,
lib/solargraph/language_server/message/shutdown.rb,
lib/solargraph/language_server/message/workspace.rb,
lib/solargraph/language_server/transport/adapter.rb,
lib/solargraph/language_server/message/initialize.rb,
lib/solargraph/language_server/message/initialized.rb,
lib/solargraph/language_server/completion_item_kinds.rb,
lib/solargraph/language_server/message/text_document.rb,
lib/solargraph/language_server/transport/data_reader.rb,
lib/solargraph/language_server/message/cancel_request.rb,
lib/solargraph/parser/legacy/node_processors/def_node.rb,
lib/solargraph/parser/legacy/node_processors/sym_node.rb,
lib/solargraph/parser/rubyvm/node_processors/def_node.rb,
lib/solargraph/parser/rubyvm/node_processors/lit_node.rb,
lib/solargraph/parser/rubyvm/node_processors/sym_node.rb,
lib/solargraph/language_server/message/completion_item.rb,
lib/solargraph/language_server/message/extended/search.rb,
lib/solargraph/parser/legacy/node_processors/args_node.rb,
lib/solargraph/parser/legacy/node_processors/defs_node.rb,
lib/solargraph/parser/legacy/node_processors/send_node.rb,
lib/solargraph/parser/rubyvm/node_processors/args_node.rb,
lib/solargraph/parser/rubyvm/node_processors/defs_node.rb,
lib/solargraph/parser/rubyvm/node_processors/send_node.rb,
lib/solargraph/language_server/message/method_not_found.rb,
lib/solargraph/parser/legacy/node_processors/alias_node.rb,
lib/solargraph/parser/legacy/node_processors/begin_node.rb,
lib/solargraph/parser/legacy/node_processors/block_node.rb,
lib/solargraph/parser/legacy/node_processors/casgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/alias_node.rb,
lib/solargraph/parser/rubyvm/node_processors/begin_node.rb,
lib/solargraph/parser/rubyvm/node_processors/block_node.rb,
lib/solargraph/parser/rubyvm/node_processors/casgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/scope_node.rb,
lib/solargraph/language_server/message/exit_notification.rb,
lib/solargraph/language_server/message/extended/document.rb,
lib/solargraph/parser/legacy/node_processors/cvasgn_node.rb,
lib/solargraph/parser/legacy/node_processors/gvasgn_node.rb,
lib/solargraph/parser/legacy/node_processors/ivasgn_node.rb,
lib/solargraph/parser/legacy/node_processors/lvasgn_node.rb,
lib/solargraph/parser/legacy/node_processors/orasgn_node.rb,
lib/solargraph/parser/legacy/node_processors/sclass_node.rb,
lib/solargraph/parser/rubyvm/node_processors/cvasgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/gvasgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/ivasgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/kw_arg_node.rb,
lib/solargraph/parser/rubyvm/node_processors/lvasgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/orasgn_node.rb,
lib/solargraph/parser/rubyvm/node_processors/sclass_node.rb,
lib/solargraph/language_server/message/text_document/base.rb,
lib/solargraph/parser/legacy/node_processors/resbody_node.rb,
lib/solargraph/parser/rubyvm/node_processors/opt_arg_node.rb,
lib/solargraph/parser/rubyvm/node_processors/resbody_node.rb,
lib/solargraph/language_server/message/text_document/hover.rb,
lib/solargraph/language_server/message/extended/environment.rb,
lib/solargraph/parser/legacy/node_processors/namespace_node.rb,
lib/solargraph/parser/rubyvm/node_processors/namespace_node.rb,
lib/solargraph/language_server/message/extended/document_gems.rb,
lib/solargraph/language_server/message/extended/download_core.rb,
lib/solargraph/language_server/message/method_not_implemented.rb,
lib/solargraph/language_server/message/text_document/did_open.rb,
lib/solargraph/language_server/message/text_document/did_save.rb,
lib/solargraph/language_server/message/completion_item/resolve.rb,
lib/solargraph/language_server/message/text_document/did_close.rb,
lib/solargraph/language_server/message/text_document/completion.rb,
lib/solargraph/language_server/message/text_document/did_change.rb,
lib/solargraph/language_server/message/text_document/formatting.rb,
lib/solargraph/language_server/message/text_document/code_action.rb,
lib/solargraph/language_server/message/client/register_capability.rb,
lib/solargraph/language_server/message/extended/check_gem_version.rb,
lib/solargraph/language_server/message/text_document/folding_range.rb,
lib/solargraph/language_server/message/text_document/signature_help.rb,
lib/solargraph/language_server/message/text_document/on_type_formatting.rb

Overview

The top-level namespace for the Solargraph code mapping, documentation, static analysis, and language server libraries.

Defined Under Namespace

Modules: Convention, Diagnostics, LanguageServer, Logging, Parser, Pin, ServerMethods Classes: ApiMap, Bench, BundleNotFoundError, ComplexType, ComplexTypeError, DiagnosticsError, Documentor, DomainDirective, Environ, FileNotFoundError, InvalidOffsetError, Library, Location, Page, Position, Range, Shell, Source, SourceMap, SourceNotAvailableError, TypeChecker, Workspace, WorkspaceTooLargeError, YardMap

Constant Summary collapse

YARDOC_PATH = 
File.realpath(File.join(dir, '..', 'yardoc'))
YARD_EXTENSION_FILE = 
File.join(dir, 'yard-solargraph.rb')
VIEWS_PATH = 
File.join(dir, 'solargraph', 'views')
VERSION = 
'0.40.2'

Class Method Summary collapse

Class Method Details

.logger ⇒ Logger

A convenience method for Solargraph::Logging.logger.

Returns:

  • (Logger) 


52
53
54
 
# File 'lib/solargraph.rb', line 52

def self.logger
  Solargraph::Logging.logger
end

.with_clean_env(&block) ⇒ Object

A helper method that runs Bundler.with_unbundled_env or falls back to Bundler.with_clean_env for earlier versions of Bundler.



59
60
61
62
63
64
65
66
 
# File 'lib/solargraph.rb', line 59

def self.with_clean_env &block
  meth = if Bundler.respond_to?(:with_unbundled_env)
    :with_unbundled_env
  else
    :with_clean_env
  end
  Bundler.send meth, &block
end