ruby/gem_prelude.rb

begin
  require 'rubygems'
rescue LoadError => e
  raise unless e.path == 'rubygems'

  warn "`RubyGems' were not loaded."
end if defined?(Gem)

begin
  require 'error_highlight'
rescue LoadError
  warn "`error_highlight' was not loaded."
end if defined?(ErrorHighlight)

begin
  require 'did_you_mean'
rescue LoadError
  warn "`did_you_mean' was not loaded."
end if defined?(DidYouMean)

begin
  require 'syntax_suggest/core_ext'
rescue LoadError
  warn "`syntax_suggest' was not loaded."
end if defined?(SyntaxSuggest)
Don't fail when 'RubyGems' are not available. Although 'RubyGems' are always available in upstream Ruby, it might not be available optionally when Ruby is delivered via packaging systems. E.g. Linux distributions. 2019-12-18 16:55:25 +03:00			`begin`
Removed needless .rb 2020-12-02 07:32:43 +03:00			`require 'rubygems'`
Silence LoadError only if it is for `rubygems` itself Co-authored-by: David Rodríguez <deivid.rodriguez@riseup.net> Co-authored-by: Hiroshi SHIBATA <hsbt@ruby-lang.org> 2021-08-08 16:15:40 +03:00			`rescue LoadError => e`
			`raise unless e.path == 'rubygems'`

Emit warning when 'RubyGems' were not properly loaded. 2019-12-18 17:03:38 +03:00			warn "`RubyGems' were not loaded."
Don't fail when 'RubyGems' are not available. Although 'RubyGems' are always available in upstream Ruby, it might not be available optionally when Ruby is delivered via packaging systems. E.g. Linux distributions. 2019-12-18 16:55:25 +03:00			`end if defined?(Gem)`
Don't fail when 'did_you_mean' is not available. Although 'did_you_mean' is always available in upstream Ruby, it might not be available when speed, memory, disk or network bandwidth is a concern. This is typically the case for production environment, where 'did_you_mean' is of limited usage. Also it might not be available optionally when Ruby is delivered via packaging systems. E.g. Linux distributions. 2019-12-18 16:29:17 +03:00
[WIP] add error_squiggle gem ``` $ ./local/bin/ruby -e '1.time {}' -e:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError) 1.time {} ^^^^^ Did you mean? times ``` https://bugs.ruby-lang.org/issues/17930 2021-06-18 11:11:39 +03:00			`begin`
Rename error_squiggle to error_highlight 2021-06-28 07:27:35 +03:00			`require 'error_highlight'`
[WIP] add error_squiggle gem ``` $ ./local/bin/ruby -e '1.time {}' -e:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError) 1.time {} ^^^^^ Did you mean? times ``` https://bugs.ruby-lang.org/issues/17930 2021-06-18 11:11:39 +03:00			`rescue LoadError`
Rename error_squiggle to error_highlight 2021-06-28 07:27:35 +03:00			warn "`error_highlight' was not loaded."
			`end if defined?(ErrorHighlight)`
[WIP] add error_squiggle gem ``` $ ./local/bin/ruby -e '1.time {}' -e:1:in `<main>': undefined method `time' for 1:Integer (NoMethodError) 1.time {} ^^^^^ Did you mean? times ``` https://bugs.ruby-lang.org/issues/17930 2021-06-18 11:11:39 +03:00
Don't fail when 'did_you_mean' is not available. Although 'did_you_mean' is always available in upstream Ruby, it might not be available when speed, memory, disk or network bandwidth is a concern. This is typically the case for production environment, where 'did_you_mean' is of limited usage. Also it might not be available optionally when Ruby is delivered via packaging systems. E.g. Linux distributions. 2019-12-18 16:29:17 +03:00			`begin`
			`require 'did_you_mean'`
			`rescue LoadError`
Emit warning when 'did_you_mean' was not properly loaded. 2019-12-18 17:02:31 +03:00			warn "`did_you_mean' was not loaded."
Don't fail when 'did_you_mean' is not available. Although 'did_you_mean' is always available in upstream Ruby, it might not be available when speed, memory, disk or network bandwidth is a concern. This is typically the case for production environment, where 'did_you_mean' is of limited usage. Also it might not be available optionally when Ruby is delivered via packaging systems. E.g. Linux distributions. 2019-12-18 16:29:17 +03:00			`end if defined?(DidYouMean)`
Setup SyntaxSuggest as default gem Adds the `syntax_suggest` syntax error display tool to Ruby through the same mechanism as `error_highlight` and `did_you_mean`. Reference ticket: https://bugs.ruby-lang.org/issues/18159 close #4845 ## What is syntax_suggest? When a syntax error is raised by requiring a file, dead_end will use a combination of indentation and lexing to identify the problem. > Note: Previously this tool was named `dead_end`. ## Known issues - SyntaxSearch's approach of showing syntax errors only works through integration with `require`, `load`, `autoload`, and `require_relative` (since it monkeypatches them to detect syntax errors). It does not work with direct Ruby file invocations https://github.com/zombocom/dead_end/issues/31. - This causes failure in the test suite (test_expected_backtrace_location_when_inheriting_from_basic_object_and_including_kernel) and confusion when inspecting backtraces if there's a different error when trying to require a file such as measuring memory (https://github.com/zombocom/syntax_suggest/issues/124#issuecomment-1006705016). - Discussed fix. We previously talked about opening up `SyntaxError` to be monkeypatched in the same way that other gems hook into `NoMethodError`. This is currently not possible and requires development work. When we last talked about it at RubyKaigi Nobu expressed an ability to make such a change. 2022-07-26 23:16:21 +03:00
			`begin`
			`require 'syntax_suggest/core_ext'`
			`rescue LoadError`
			warn "`syntax_suggest' was not loaded."
			`end if defined?(SyntaxSuggest)`