1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00
The Ruby Programming Language [mirror]
Find a file
schneems a50df1ab0e 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-08-19 10:02:24 +09:00
.github
basictest
benchmark
bin
bootstraptest
ccan
coroutine
coverage
cygwin
defs
doc
enc
ext
gems
include
internal
lib
libexec
man
misc
missing
sample
spec
template
test
tool
wasm
win32
yjit
.appveyor.yml
.cirrus.yml
.dir-locals.el
.document
.editorconfig
.gdbinit
.git-blame-ignore-revs
.gitattributes
.gitignore
.indent.pro
.rdoc_options
.rspec_parallel
.travis.yml
aclocal.m4
addr2line.c
addr2line.h
array.c
array.rb
ast.c
ast.rb
autogen.sh
bignum.c
BSDL
builtin.c
builtin.h
class.c
common.mk
compar.c
compile.c
complex.c
configure.ac
constant.h
cont.c
CONTRIBUTING.md
COPYING
COPYING.ja
darray.h
debug.c
debug_counter.c
debug_counter.h
dir.c
dir.rb
dln.c
dln.h
dln_find.c
dmydln.c
dmyenc.c
dmyext.c
encindex.h
encoding.c
enum.c
enumerator.c
error.c
eval.c
eval_error.c
eval_intern.h
eval_jump.c
file.c
gc.c
gc.h
gc.rb
gem_prelude.rb
golf_prelude.rb
goruby.c
GPL
hash.c
hrtime.h
id_table.c
id_table.h
inits.c
insns.def
internal.h
io.c
io.rb
io_buffer.c
iseq.c
iseq.h
kernel.rb
KNOWNBUGS.rb
LEGAL
lex.c.blt
load.c
loadpath.c
localeinit.c
main.c
marshal.c
marshal.rb
math.c
memory_view.c
method.h
mini_builtin.c
miniinit.c
mjit.c
mjit.h
mjit.rb
mjit_compile.c
mjit_unit.h
NEWS.md
nilclass.rb
node.c
node.h
numeric.c
numeric.rb
object.c
pack.c
pack.rb
parse.y
prelude.rb
probes.d
probes_helper.h
proc.c
process.c
ractor.c
ractor.rb
ractor_core.h
random.c
range.c
rational.c
re.c
README.EXT
README.EXT.ja
README.ja.md
README.md
regcomp.c
regenc.c
regenc.h
regerror.c
regexec.c
regint.h
regparse.c
regparse.h
regsyntax.c
ruby-runner.c
ruby.c
ruby_assert.h
ruby_atomic.h
rubystub.c
scheduler.c
signal.c
siphash.c
siphash.h
sparc.c
sprintf.c
st.c
strftime.c
string.c
string.rb
struct.c
symbol.c
symbol.h
thread.c
thread_none.c
thread_none.h
thread_pthread.c
thread_pthread.h
thread_sync.c
thread_sync.rb
thread_win32.c
thread_win32.h
time.c
timev.h
timev.rb
trace_point.rb
transcode.c
transcode_data.h
transient_heap.c
transient_heap.h
util.c
variable.c
variable.h
version.c
version.h
vm.c
vm_args.c
vm_backtrace.c
vm_callinfo.h
vm_core.h
vm_debug.h
vm_dump.c
vm_eval.c
vm_exec.c
vm_exec.h
vm_insnhelper.c
vm_insnhelper.h
vm_method.c
vm_opts.h
vm_sync.c
vm_sync.h
vm_trace.c
vsnprintf.c
warning.rb
yjit.c
yjit.h
yjit.rb

Actions Status: MinGW Actions Status: MJIT Actions Status: Ubuntu Actions Status: Windows AppVeyor status Travis Status Cirrus Status

What is Ruby?

Ruby is an interpreted object-oriented programming language often used for web development. It also offers many scripting features to process plain text and serialized files, or manage system tasks. It is simple, straightforward, and extensible.

Features of Ruby

  • Simple Syntax
  • Normal Object-oriented Features (e.g. class, method calls)
  • Advanced Object-oriented Features (e.g. mix-in, singleton-method)
  • Operator Overloading
  • Exception Handling
  • Iterators and Closures
  • Garbage Collection
  • Dynamic Loading of Object Files (on some architectures)
  • Highly Portable (works on many Unix-like/POSIX compatible platforms as well as Windows, macOS, etc.) cf. https://github.com/ruby/ruby/blob/master/doc/maintainers.rdoc#label-Platform+Maintainers

How to get Ruby with Git

For a complete list of ways to install Ruby, including using third-party tools like rvm, see:

https://www.ruby-lang.org/en/downloads/

The mirror of the Ruby source tree can be checked out with the following command:

$ git clone https://github.com/ruby/ruby.git

There are some other branches under development. Try the following command to see the list of branches:

$ git ls-remote https://github.com/ruby/ruby.git

You may also want to use https://git.ruby-lang.org/ruby.git (actual master of Ruby source) if you are a committer.

Ruby home page

https://www.ruby-lang.org/

Documentation

Mailing list

There is a mailing list to discuss Ruby. To subscribe to this list, please send the following phrase:

subscribe

in the mail body (not subject) to the address ruby-talk-request@ruby-lang.org.

Copying

See the file COPYING.

Feedback

Questions about the Ruby language can be asked on the Ruby-Talk mailing list or on websites like https://stackoverflow.com.

Bugs should be reported at https://bugs.ruby-lang.org. Read "Reporting Issues" for more information.

Contributing

See "Contributing to Ruby", which includes setup and build instructions.

The Author

Ruby was originally designed and developed by Yukihiro Matsumoto (Matz) in 1995.

matz@ruby-lang.org