Skip to content

Commit

Permalink
Setup SyntaxSuggest as default gem
Browse files Browse the repository at this point in the history
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 ruby/syntax_suggest#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 (ruby/syntax_suggest#124 (comment)).
  - 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.
  • Loading branch information
schneems authored and hsbt committed Aug 19, 2022
1 parent 3541f32 commit a50df1a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 0 deletions.
7 changes: 7 additions & 0 deletions gem_prelude.rb
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,10 @@
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)

6 changes: 6 additions & 0 deletions ruby.c
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ void rb_warning_category_update(unsigned int mask, unsigned int bits);
SEP \
X(did_you_mean) \
SEP \
X(syntax_suggest) \
SEP \
X(rubyopt) \
SEP \
X(frozen_string_literal) \
Expand Down Expand Up @@ -307,6 +309,7 @@ usage(const char *name, int help, int highlight, int columns)
M("gems", "", "rubygems (only for debugging, default: "DEFAULT_RUBYGEMS_ENABLED")"),
M("error_highlight", "", "error_highlight (default: "DEFAULT_RUBYGEMS_ENABLED")"),
M("did_you_mean", "", "did_you_mean (default: "DEFAULT_RUBYGEMS_ENABLED")"),
M("syntax_suggest", "", "syntax_suggest (default: "DEFAULT_RUBYGEMS_ENABLED")"),
M("rubyopt", "", "RUBYOPT environment variable (default: enabled)"),
M("frozen-string-literal", "", "freeze all string literals (default: disabled)"),
#if USE_MJIT
Expand Down Expand Up @@ -1553,6 +1556,9 @@ ruby_opt_init(ruby_cmdline_options_t *opt)
if (opt->features.set & FEATURE_BIT(did_you_mean)) {
rb_define_module("DidYouMean");
}
if (opt->features.set & FEATURE_BIT(syntax_suggest)) {
rb_define_module("SyntaxSuggest");
}
}

rb_warning_category_update(opt->warn.mask, opt->warn.set);
Expand Down
1 change: 1 addition & 0 deletions tool/sync_default_gems.rb
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@
pathname: "ruby/pathname",
digest: "ruby/digest",
error_highlight: "ruby/error_highlight",
syntax_suggest: "zombocom/syntax_suggest",
un: "ruby/un",
win32ole: "ruby/win32ole",
}
Expand Down

0 comments on commit a50df1a

Please sign in to comment.