Issue #17662 has been updated by Eregon (Benoit Daloze).


Here is a particularly weird/complex example usage of heredocs in tests:
https://github.com/ruby/ruby/blob/eef3c08edc2fc74496cdc1e4d89798d053e32561/test/ruby/test_thread.rb#L1380-L1394

It does not syntax highlight, it is very hard to read, and the `{#1` nesting seems there for no reason after 2 lines of code?
The inner script is actually just:
```ruby
code = <<~RUBY
tpid = #{Process.pid}
sig = :#{sig}
STDOUT.sync = true
while gets
  puts
  Process.kill(sig, tpid)
end
RUBY
```

I think it would be great to consolidate to a single style of heredoc in tests,
and if possible one that does not involve twice the number of heredocs than needed.

----------------------------------------
Misc #17662: The heredoc pattern used in tests does not syntax highlight correctly in many editors
https://bugs.ruby-lang.org/issues/17662#change-92615

* Author: Eregon (Benoit Daloze)
* Status: Assigned
* Priority: Normal
* Assignee: nobu (Nobuyoshi Nakada)
----------------------------------------
This heredoc pattern
```ruby
    assert_ruby_status([], "#{<<-"begin;"}\n#{<<-'end;'}", bug)
    begin;
      exit("1" == Thread.start(1, &:to_s).value)
    end;
```

completely breaks syntax highlighting in at least:
* GitHub: [there](https://github.com/ruby/ruby/blob/36dde35e029c7a6607e6c674062ce6fc7a51c0bd/test/ruby/test_string.rb#L697) [are](https://github.com/ruby/ruby/blob/36dde35e029c7a6607e6c674062ce6fc7a51c0bd/test/ruby/test_process.rb#L1545) [many](https://github.com/ruby/ruby/blob/565aeb81e0886c835888a425e5d05ed99fb03238/test/ruby/test_thread.rb#L201) [examples](https://github.com/ruby/ruby/blob/36dde35e029c7a6607e6c674062ce6fc7a51c0bd/test/ruby/test_require.rb#L21)
* Atom
* RubyMine (and IntelliJ)
* Likely many more editors based on TextMate grammars

Could another pattern be used in tests inside the ruby/ruby repository (at least for `test/ruby`)?

Due to this issue, it is very annoying and inconvenient to look at/read/investigate many tests.

I think this pattern is also very complicated to understand (and using `;` is quite weird for this).
I suggest to replace it with this obvious and simple pattern many people use:
```ruby
    assert_ruby_status([], <<~'RUBY', bug)
      exit("1" == Thread.start(1, &:to_s).value)
    RUBY
```
This syntax highlights correctly in most (all?) editors, and as an added bonus the code inside the heredoc is also highlighted in some editors (due to the label being `RUBY`).



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

Unsubscribe: <mailto:ruby-core-request / ruby-lang.org?subject=unsubscribe>
<http://lists.ruby-lang.org/cgi-bin/mailman/options/ruby-core>